documentation.d.ts 3.7 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794
  1. declare module BABYLON {
  2. /** Alias type for value that can be null */
  3. export type Nullable<T> = T | null;
  4. /**
  5. * Alias type for number that are floats
  6. * @ignorenaming
  7. */
  8. export type float = number;
  9. /**
  10. * Alias type for number that are doubles.
  11. * @ignorenaming
  12. */
  13. export type double = number;
  14. /**
  15. * Alias type for number that are integer
  16. * @ignorenaming
  17. */
  18. export type int = number;
  19. /** Alias type for number array or Float32Array */
  20. export type FloatArray = number[] | Float32Array;
  21. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  22. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  23. /**
  24. * Alias for types that can be used by a Buffer or VertexBuffer.
  25. */
  26. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  27. /**
  28. * Alias type for primitive types
  29. * @ignorenaming
  30. */
  31. type Primitive = undefined | null | boolean | string | number | Function;
  32. /**
  33. * Type modifier to make all the properties of an object Readonly
  34. */
  35. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  36. /**
  37. * Type modifier to make all the properties of an object Readonly recursively
  38. */
  39. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  40. /**
  41. * Type modifier to make object properties readonly.
  42. */
  43. export type DeepImmutableObject<T> = {
  44. readonly [K in keyof T]: DeepImmutable<T[K]>;
  45. };
  46. /** @hidden */
  47. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  48. }
  49. }
  50. declare module BABYLON {
  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. * User defined information that will be sent to observers
  95. */
  96. userInfo?: any;
  97. }
  98. /**
  99. * Represent an Observer registered to a given Observable object.
  100. */
  101. export class Observer<T> {
  102. /**
  103. * Defines the callback to call when the observer is notified
  104. */
  105. callback: (eventData: T, eventState: EventState) => void;
  106. /**
  107. * Defines the mask of the observer (used to filter notifications)
  108. */
  109. mask: number;
  110. /**
  111. * Defines the current scope used to restore the JS context
  112. */
  113. scope: any;
  114. /** @hidden */
  115. _willBeUnregistered: boolean;
  116. /**
  117. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  118. */
  119. unregisterOnNextCall: boolean;
  120. /**
  121. * Creates a new observer
  122. * @param callback defines the callback to call when the observer is notified
  123. * @param mask defines the mask of the observer (used to filter notifications)
  124. * @param scope defines the current scope used to restore the JS context
  125. */
  126. constructor(
  127. /**
  128. * Defines the callback to call when the observer is notified
  129. */
  130. callback: (eventData: T, eventState: EventState) => void,
  131. /**
  132. * Defines the mask of the observer (used to filter notifications)
  133. */
  134. mask: number,
  135. /**
  136. * Defines the current scope used to restore the JS context
  137. */
  138. scope?: any);
  139. }
  140. /**
  141. * Represent a list of observers registered to multiple Observables object.
  142. */
  143. export class MultiObserver<T> {
  144. private _observers;
  145. private _observables;
  146. /**
  147. * Release associated resources
  148. */
  149. dispose(): void;
  150. /**
  151. * Raise a callback when one of the observable will notify
  152. * @param observables defines a list of observables to watch
  153. * @param callback defines the callback to call on notification
  154. * @param mask defines the mask used to filter notifications
  155. * @param scope defines the current scope used to restore the JS context
  156. * @returns the new MultiObserver
  157. */
  158. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  159. }
  160. /**
  161. * The Observable class is a simple implementation of the Observable pattern.
  162. *
  163. * 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.
  164. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  165. * 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).
  166. * 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.
  167. */
  168. export class Observable<T> {
  169. private _observers;
  170. private _eventState;
  171. private _onObserverAdded;
  172. /**
  173. * Gets the list of observers
  174. */
  175. get observers(): Array<Observer<T>>;
  176. /**
  177. * Creates a new observable
  178. * @param onObserverAdded defines a callback to call when a new observer is added
  179. */
  180. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  181. /**
  182. * Create a new Observer with the specified callback
  183. * @param callback the callback that will be executed for that Observer
  184. * @param mask the mask used to filter observers
  185. * @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.
  186. * @param scope optional scope for the callback to be called from
  187. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  188. * @returns the new observer created for the callback
  189. */
  190. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  191. /**
  192. * Create a new Observer with the specified callback and unregisters after the next notification
  193. * @param callback the callback that will be executed for that Observer
  194. * @returns the new observer created for the callback
  195. */
  196. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  197. /**
  198. * Remove an Observer from the Observable object
  199. * @param observer the instance of the Observer to remove
  200. * @returns false if it doesn't belong to this Observable
  201. */
  202. remove(observer: Nullable<Observer<T>>): boolean;
  203. /**
  204. * Remove a callback from the Observable object
  205. * @param callback the callback to remove
  206. * @param scope optional scope. If used only the callbacks with this scope will be removed
  207. * @returns false if it doesn't belong to this Observable
  208. */
  209. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  210. private _deferUnregister;
  211. private _remove;
  212. /**
  213. * Moves the observable to the top of the observer list making it get called first when notified
  214. * @param observer the observer to move
  215. */
  216. makeObserverTopPriority(observer: Observer<T>): void;
  217. /**
  218. * Moves the observable to the bottom of the observer list making it get called last when notified
  219. * @param observer the observer to move
  220. */
  221. makeObserverBottomPriority(observer: Observer<T>): void;
  222. /**
  223. * Notify all Observers by calling their respective callback with the given data
  224. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  225. * @param eventData defines the data to send to all observers
  226. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  227. * @param target defines the original target of the state
  228. * @param currentTarget defines the current target of the state
  229. * @param userInfo defines any user info to send to observers
  230. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  231. */
  232. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any, userInfo?: any): boolean;
  233. /**
  234. * Calling this will execute each callback, expecting it to be a promise or return a value.
  235. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  236. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  237. * and it is crucial that all callbacks will be executed.
  238. * The order of the callbacks is kept, callbacks are not executed parallel.
  239. *
  240. * @param eventData The data to be sent to each callback
  241. * @param mask is used to filter observers defaults to -1
  242. * @param target defines the callback target (see EventState)
  243. * @param currentTarget defines he current object in the bubbling phase
  244. * @param userInfo defines any user info to send to observers
  245. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  246. */
  247. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any, userInfo?: any): Promise<T>;
  248. /**
  249. * Notify a specific observer
  250. * @param observer defines the observer to notify
  251. * @param eventData defines the data to be sent to each callback
  252. * @param mask is used to filter observers defaults to -1
  253. */
  254. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  255. /**
  256. * Gets a boolean indicating if the observable has at least one observer
  257. * @returns true is the Observable has at least one Observer registered
  258. */
  259. hasObservers(): boolean;
  260. /**
  261. * Clear the list of observers
  262. */
  263. clear(): void;
  264. /**
  265. * Clone the current observable
  266. * @returns a new observable
  267. */
  268. clone(): Observable<T>;
  269. /**
  270. * Does this observable handles observer registered with a given mask
  271. * @param mask defines the mask to be tested
  272. * @return whether or not one observer registered with the given mask is handeled
  273. **/
  274. hasSpecificMask(mask?: number): boolean;
  275. }
  276. }
  277. declare module BABYLON {
  278. /**
  279. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  280. * Babylon.js
  281. */
  282. export class DomManagement {
  283. /**
  284. * Checks if the window object exists
  285. * @returns true if the window object exists
  286. */
  287. static IsWindowObjectExist(): boolean;
  288. /**
  289. * Checks if the navigator object exists
  290. * @returns true if the navigator object exists
  291. */
  292. static IsNavigatorAvailable(): boolean;
  293. /**
  294. * Check if the document object exists
  295. * @returns true if the document object exists
  296. */
  297. static IsDocumentAvailable(): boolean;
  298. /**
  299. * Extracts text content from a DOM element hierarchy
  300. * @param element defines the root element
  301. * @returns a string
  302. */
  303. static GetDOMTextContent(element: HTMLElement): string;
  304. }
  305. }
  306. declare module BABYLON {
  307. /**
  308. * Logger used througouht the application to allow configuration of
  309. * the log level required for the messages.
  310. */
  311. export class Logger {
  312. /**
  313. * No log
  314. */
  315. static readonly NoneLogLevel: number;
  316. /**
  317. * Only message logs
  318. */
  319. static readonly MessageLogLevel: number;
  320. /**
  321. * Only warning logs
  322. */
  323. static readonly WarningLogLevel: number;
  324. /**
  325. * Only error logs
  326. */
  327. static readonly ErrorLogLevel: number;
  328. /**
  329. * All logs
  330. */
  331. static readonly AllLogLevel: number;
  332. private static _LogCache;
  333. /**
  334. * Gets a value indicating the number of loading errors
  335. * @ignorenaming
  336. */
  337. static errorsCount: number;
  338. /**
  339. * Callback called when a new log is added
  340. */
  341. static OnNewCacheEntry: (entry: string) => void;
  342. private static _AddLogEntry;
  343. private static _FormatMessage;
  344. private static _LogDisabled;
  345. private static _LogEnabled;
  346. private static _WarnDisabled;
  347. private static _WarnEnabled;
  348. private static _ErrorDisabled;
  349. private static _ErrorEnabled;
  350. /**
  351. * Log a message to the console
  352. */
  353. static Log: (message: string) => void;
  354. /**
  355. * Write a warning message to the console
  356. */
  357. static Warn: (message: string) => void;
  358. /**
  359. * Write an error message to the console
  360. */
  361. static Error: (message: string) => void;
  362. /**
  363. * Gets current log cache (list of logs)
  364. */
  365. static get LogCache(): string;
  366. /**
  367. * Clears the log cache
  368. */
  369. static ClearLogCache(): void;
  370. /**
  371. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  372. */
  373. static set LogLevels(level: number);
  374. }
  375. }
  376. declare module BABYLON {
  377. /** @hidden */
  378. export class _TypeStore {
  379. /** @hidden */
  380. static RegisteredTypes: {
  381. [key: string]: Object;
  382. };
  383. /** @hidden */
  384. static GetClass(fqdn: string): any;
  385. }
  386. }
  387. declare module BABYLON {
  388. /**
  389. * Helper to manipulate strings
  390. */
  391. export class StringTools {
  392. /**
  393. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  394. * @param str Source string
  395. * @param suffix Suffix to search for in the source string
  396. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  397. */
  398. static EndsWith(str: string, suffix: string): boolean;
  399. /**
  400. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  401. * @param str Source string
  402. * @param suffix Suffix to search for in the source string
  403. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  404. */
  405. static StartsWith(str: string, suffix: string): boolean;
  406. /**
  407. * Decodes a buffer into a string
  408. * @param buffer The buffer to decode
  409. * @returns The decoded string
  410. */
  411. static Decode(buffer: Uint8Array | Uint16Array): string;
  412. /**
  413. * Encode a buffer to a base64 string
  414. * @param buffer defines the buffer to encode
  415. * @returns the encoded string
  416. */
  417. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  418. /**
  419. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  420. * @param num the number to convert and pad
  421. * @param length the expected length of the string
  422. * @returns the padded string
  423. */
  424. static PadNumber(num: number, length: number): string;
  425. }
  426. }
  427. declare module BABYLON {
  428. /**
  429. * Class containing a set of static utilities functions for deep copy.
  430. */
  431. export class DeepCopier {
  432. /**
  433. * Tries to copy an object by duplicating every property
  434. * @param source defines the source object
  435. * @param destination defines the target object
  436. * @param doNotCopyList defines a list of properties to avoid
  437. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  438. */
  439. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  440. }
  441. }
  442. declare module BABYLON {
  443. /**
  444. * Class containing a set of static utilities functions for precision date
  445. */
  446. export class PrecisionDate {
  447. /**
  448. * Gets either window.performance.now() if supported or Date.now() else
  449. */
  450. static get Now(): number;
  451. }
  452. }
  453. declare module BABYLON {
  454. /** @hidden */
  455. export class _DevTools {
  456. static WarnImport(name: string): string;
  457. }
  458. }
  459. declare module BABYLON {
  460. /**
  461. * Interface used to define the mechanism to get data from the network
  462. */
  463. export interface IWebRequest {
  464. /**
  465. * Returns client's response url
  466. */
  467. responseURL: string;
  468. /**
  469. * Returns client's status
  470. */
  471. status: number;
  472. /**
  473. * Returns client's status as a text
  474. */
  475. statusText: string;
  476. }
  477. }
  478. declare module BABYLON {
  479. /**
  480. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  481. */
  482. export class WebRequest implements IWebRequest {
  483. private readonly _xhr;
  484. /**
  485. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  486. * i.e. when loading files, where the server/service expects an Authorization header
  487. */
  488. static CustomRequestHeaders: {
  489. [key: string]: string;
  490. };
  491. /**
  492. * Add callback functions in this array to update all the requests before they get sent to the network
  493. */
  494. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  495. private _injectCustomRequestHeaders;
  496. /**
  497. * Gets or sets a function to be called when loading progress changes
  498. */
  499. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  500. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  501. /**
  502. * Returns client's state
  503. */
  504. get readyState(): number;
  505. /**
  506. * Returns client's status
  507. */
  508. get status(): number;
  509. /**
  510. * Returns client's status as a text
  511. */
  512. get statusText(): string;
  513. /**
  514. * Returns client's response
  515. */
  516. get response(): any;
  517. /**
  518. * Returns client's response url
  519. */
  520. get responseURL(): string;
  521. /**
  522. * Returns client's response as text
  523. */
  524. get responseText(): string;
  525. /**
  526. * Gets or sets the expected response type
  527. */
  528. get responseType(): XMLHttpRequestResponseType;
  529. set responseType(value: XMLHttpRequestResponseType);
  530. /** @hidden */
  531. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  532. /** @hidden */
  533. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  534. /**
  535. * Cancels any network activity
  536. */
  537. abort(): void;
  538. /**
  539. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  540. * @param body defines an optional request body
  541. */
  542. send(body?: Document | BodyInit | null): void;
  543. /**
  544. * Sets the request method, request URL
  545. * @param method defines the method to use (GET, POST, etc..)
  546. * @param url defines the url to connect with
  547. */
  548. open(method: string, url: string): void;
  549. /**
  550. * Sets the value of a request header.
  551. * @param name The name of the header whose value is to be set
  552. * @param value The value to set as the body of the header
  553. */
  554. setRequestHeader(name: string, value: string): void;
  555. /**
  556. * Get the string containing the text of a particular header's value.
  557. * @param name The name of the header
  558. * @returns The string containing the text of the given header name
  559. */
  560. getResponseHeader(name: string): Nullable<string>;
  561. }
  562. }
  563. declare module BABYLON {
  564. /**
  565. * File request interface
  566. */
  567. export interface IFileRequest {
  568. /**
  569. * Raised when the request is complete (success or error).
  570. */
  571. onCompleteObservable: Observable<IFileRequest>;
  572. /**
  573. * Aborts the request for a file.
  574. */
  575. abort: () => void;
  576. }
  577. }
  578. declare module BABYLON {
  579. /**
  580. * Define options used to create a render target texture
  581. */
  582. export class RenderTargetCreationOptions {
  583. /**
  584. * Specifies is mipmaps must be generated
  585. */
  586. generateMipMaps?: boolean;
  587. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  588. generateDepthBuffer?: boolean;
  589. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  590. generateStencilBuffer?: boolean;
  591. /** Defines texture type (int by default) */
  592. type?: number;
  593. /** Defines sampling mode (trilinear by default) */
  594. samplingMode?: number;
  595. /** Defines format (RGBA by default) */
  596. format?: number;
  597. }
  598. }
  599. declare module BABYLON {
  600. /** Defines the cross module used constants to avoid circular dependncies */
  601. export class Constants {
  602. /** Defines that alpha blending is disabled */
  603. static readonly ALPHA_DISABLE: number;
  604. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  605. static readonly ALPHA_ADD: number;
  606. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  607. static readonly ALPHA_COMBINE: number;
  608. /** Defines that alpha blending is DEST - SRC * DEST */
  609. static readonly ALPHA_SUBTRACT: number;
  610. /** Defines that alpha blending is SRC * DEST */
  611. static readonly ALPHA_MULTIPLY: number;
  612. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  613. static readonly ALPHA_MAXIMIZED: number;
  614. /** Defines that alpha blending is SRC + DEST */
  615. static readonly ALPHA_ONEONE: number;
  616. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  617. static readonly ALPHA_PREMULTIPLIED: number;
  618. /**
  619. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  620. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  621. */
  622. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  623. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  624. static readonly ALPHA_INTERPOLATE: number;
  625. /**
  626. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  627. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  628. */
  629. static readonly ALPHA_SCREENMODE: number;
  630. /**
  631. * Defines that alpha blending is SRC + DST
  632. * Alpha will be set to SRC ALPHA + DST ALPHA
  633. */
  634. static readonly ALPHA_ONEONE_ONEONE: number;
  635. /**
  636. * Defines that alpha blending is SRC * DST ALPHA + DST
  637. * Alpha will be set to 0
  638. */
  639. static readonly ALPHA_ALPHATOCOLOR: number;
  640. /**
  641. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  642. */
  643. static readonly ALPHA_REVERSEONEMINUS: number;
  644. /**
  645. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  646. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  647. */
  648. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  649. /**
  650. * Defines that alpha blending is SRC + DST
  651. * Alpha will be set to SRC ALPHA
  652. */
  653. static readonly ALPHA_ONEONE_ONEZERO: number;
  654. /**
  655. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  656. * Alpha will be set to DST ALPHA
  657. */
  658. static readonly ALPHA_EXCLUSION: number;
  659. /** Defines that alpha blending equation a SUM */
  660. static readonly ALPHA_EQUATION_ADD: number;
  661. /** Defines that alpha blending equation a SUBSTRACTION */
  662. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  663. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  664. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  665. /** Defines that alpha blending equation a MAX operation */
  666. static readonly ALPHA_EQUATION_MAX: number;
  667. /** Defines that alpha blending equation a MIN operation */
  668. static readonly ALPHA_EQUATION_MIN: number;
  669. /**
  670. * Defines that alpha blending equation a DARKEN operation:
  671. * It takes the min of the src and sums the alpha channels.
  672. */
  673. static readonly ALPHA_EQUATION_DARKEN: number;
  674. /** Defines that the ressource is not delayed*/
  675. static readonly DELAYLOADSTATE_NONE: number;
  676. /** Defines that the ressource was successfully delay loaded */
  677. static readonly DELAYLOADSTATE_LOADED: number;
  678. /** Defines that the ressource is currently delay loading */
  679. static readonly DELAYLOADSTATE_LOADING: number;
  680. /** Defines that the ressource is delayed and has not started loading */
  681. static readonly DELAYLOADSTATE_NOTLOADED: number;
  682. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  683. static readonly NEVER: number;
  684. /** 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 */
  685. static readonly ALWAYS: number;
  686. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  687. static readonly LESS: number;
  688. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  689. static readonly EQUAL: number;
  690. /** 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 */
  691. static readonly LEQUAL: number;
  692. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  693. static readonly GREATER: number;
  694. /** 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 */
  695. static readonly GEQUAL: number;
  696. /** 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 */
  697. static readonly NOTEQUAL: number;
  698. /** Passed to stencilOperation to specify that stencil value must be kept */
  699. static readonly KEEP: number;
  700. /** Passed to stencilOperation to specify that stencil value must be replaced */
  701. static readonly REPLACE: number;
  702. /** Passed to stencilOperation to specify that stencil value must be incremented */
  703. static readonly INCR: number;
  704. /** Passed to stencilOperation to specify that stencil value must be decremented */
  705. static readonly DECR: number;
  706. /** Passed to stencilOperation to specify that stencil value must be inverted */
  707. static readonly INVERT: number;
  708. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  709. static readonly INCR_WRAP: number;
  710. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  711. static readonly DECR_WRAP: number;
  712. /** Texture is not repeating outside of 0..1 UVs */
  713. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  714. /** Texture is repeating outside of 0..1 UVs */
  715. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  716. /** Texture is repeating and mirrored */
  717. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  718. /** ALPHA */
  719. static readonly TEXTUREFORMAT_ALPHA: number;
  720. /** LUMINANCE */
  721. static readonly TEXTUREFORMAT_LUMINANCE: number;
  722. /** LUMINANCE_ALPHA */
  723. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  724. /** RGB */
  725. static readonly TEXTUREFORMAT_RGB: number;
  726. /** RGBA */
  727. static readonly TEXTUREFORMAT_RGBA: number;
  728. /** RED */
  729. static readonly TEXTUREFORMAT_RED: number;
  730. /** RED (2nd reference) */
  731. static readonly TEXTUREFORMAT_R: number;
  732. /** RG */
  733. static readonly TEXTUREFORMAT_RG: number;
  734. /** RED_INTEGER */
  735. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  736. /** RED_INTEGER (2nd reference) */
  737. static readonly TEXTUREFORMAT_R_INTEGER: number;
  738. /** RG_INTEGER */
  739. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  740. /** RGB_INTEGER */
  741. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  742. /** RGBA_INTEGER */
  743. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  744. /** UNSIGNED_BYTE */
  745. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  746. /** UNSIGNED_BYTE (2nd reference) */
  747. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  748. /** FLOAT */
  749. static readonly TEXTURETYPE_FLOAT: number;
  750. /** HALF_FLOAT */
  751. static readonly TEXTURETYPE_HALF_FLOAT: number;
  752. /** BYTE */
  753. static readonly TEXTURETYPE_BYTE: number;
  754. /** SHORT */
  755. static readonly TEXTURETYPE_SHORT: number;
  756. /** UNSIGNED_SHORT */
  757. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  758. /** INT */
  759. static readonly TEXTURETYPE_INT: number;
  760. /** UNSIGNED_INT */
  761. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  762. /** UNSIGNED_SHORT_4_4_4_4 */
  763. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  764. /** UNSIGNED_SHORT_5_5_5_1 */
  765. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  766. /** UNSIGNED_SHORT_5_6_5 */
  767. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  768. /** UNSIGNED_INT_2_10_10_10_REV */
  769. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  770. /** UNSIGNED_INT_24_8 */
  771. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  772. /** UNSIGNED_INT_10F_11F_11F_REV */
  773. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  774. /** UNSIGNED_INT_5_9_9_9_REV */
  775. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  776. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  777. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  778. /** nearest is mag = nearest and min = nearest and no mip */
  779. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  780. /** mag = nearest and min = nearest and mip = none */
  781. static readonly TEXTURE_NEAREST_NEAREST: number;
  782. /** Bilinear is mag = linear and min = linear and no mip */
  783. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  784. /** mag = linear and min = linear and mip = none */
  785. static readonly TEXTURE_LINEAR_LINEAR: number;
  786. /** Trilinear is mag = linear and min = linear and mip = linear */
  787. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  788. /** Trilinear is mag = linear and min = linear and mip = linear */
  789. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  790. /** mag = nearest and min = nearest and mip = nearest */
  791. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  792. /** mag = nearest and min = linear and mip = nearest */
  793. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  794. /** mag = nearest and min = linear and mip = linear */
  795. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  796. /** mag = nearest and min = linear and mip = none */
  797. static readonly TEXTURE_NEAREST_LINEAR: number;
  798. /** nearest is mag = nearest and min = nearest and mip = linear */
  799. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  800. /** mag = linear and min = nearest and mip = nearest */
  801. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  802. /** mag = linear and min = nearest and mip = linear */
  803. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  804. /** Bilinear is mag = linear and min = linear and mip = nearest */
  805. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  806. /** mag = linear and min = nearest and mip = none */
  807. static readonly TEXTURE_LINEAR_NEAREST: number;
  808. /** Explicit coordinates mode */
  809. static readonly TEXTURE_EXPLICIT_MODE: number;
  810. /** Spherical coordinates mode */
  811. static readonly TEXTURE_SPHERICAL_MODE: number;
  812. /** Planar coordinates mode */
  813. static readonly TEXTURE_PLANAR_MODE: number;
  814. /** Cubic coordinates mode */
  815. static readonly TEXTURE_CUBIC_MODE: number;
  816. /** Projection coordinates mode */
  817. static readonly TEXTURE_PROJECTION_MODE: number;
  818. /** Skybox coordinates mode */
  819. static readonly TEXTURE_SKYBOX_MODE: number;
  820. /** Inverse Cubic coordinates mode */
  821. static readonly TEXTURE_INVCUBIC_MODE: number;
  822. /** Equirectangular coordinates mode */
  823. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  824. /** Equirectangular Fixed coordinates mode */
  825. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  826. /** Equirectangular Fixed Mirrored coordinates mode */
  827. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  828. /** Offline (baking) quality for texture filtering */
  829. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  830. /** High quality for texture filtering */
  831. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  832. /** Medium quality for texture filtering */
  833. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  834. /** Low quality for texture filtering */
  835. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  836. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  837. static readonly SCALEMODE_FLOOR: number;
  838. /** Defines that texture rescaling will look for the nearest power of 2 size */
  839. static readonly SCALEMODE_NEAREST: number;
  840. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  841. static readonly SCALEMODE_CEILING: number;
  842. /**
  843. * The dirty texture flag value
  844. */
  845. static readonly MATERIAL_TextureDirtyFlag: number;
  846. /**
  847. * The dirty light flag value
  848. */
  849. static readonly MATERIAL_LightDirtyFlag: number;
  850. /**
  851. * The dirty fresnel flag value
  852. */
  853. static readonly MATERIAL_FresnelDirtyFlag: number;
  854. /**
  855. * The dirty attribute flag value
  856. */
  857. static readonly MATERIAL_AttributesDirtyFlag: number;
  858. /**
  859. * The dirty misc flag value
  860. */
  861. static readonly MATERIAL_MiscDirtyFlag: number;
  862. /**
  863. * The dirty prepass flag value
  864. */
  865. static readonly MATERIAL_PrePassDirtyFlag: number;
  866. /**
  867. * The all dirty flag value
  868. */
  869. static readonly MATERIAL_AllDirtyFlag: number;
  870. /**
  871. * Returns the triangle fill mode
  872. */
  873. static readonly MATERIAL_TriangleFillMode: number;
  874. /**
  875. * Returns the wireframe mode
  876. */
  877. static readonly MATERIAL_WireFrameFillMode: number;
  878. /**
  879. * Returns the point fill mode
  880. */
  881. static readonly MATERIAL_PointFillMode: number;
  882. /**
  883. * Returns the point list draw mode
  884. */
  885. static readonly MATERIAL_PointListDrawMode: number;
  886. /**
  887. * Returns the line list draw mode
  888. */
  889. static readonly MATERIAL_LineListDrawMode: number;
  890. /**
  891. * Returns the line loop draw mode
  892. */
  893. static readonly MATERIAL_LineLoopDrawMode: number;
  894. /**
  895. * Returns the line strip draw mode
  896. */
  897. static readonly MATERIAL_LineStripDrawMode: number;
  898. /**
  899. * Returns the triangle strip draw mode
  900. */
  901. static readonly MATERIAL_TriangleStripDrawMode: number;
  902. /**
  903. * Returns the triangle fan draw mode
  904. */
  905. static readonly MATERIAL_TriangleFanDrawMode: number;
  906. /**
  907. * Stores the clock-wise side orientation
  908. */
  909. static readonly MATERIAL_ClockWiseSideOrientation: number;
  910. /**
  911. * Stores the counter clock-wise side orientation
  912. */
  913. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  914. /**
  915. * Nothing
  916. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  917. */
  918. static readonly ACTION_NothingTrigger: number;
  919. /**
  920. * On pick
  921. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  922. */
  923. static readonly ACTION_OnPickTrigger: number;
  924. /**
  925. * On left pick
  926. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  927. */
  928. static readonly ACTION_OnLeftPickTrigger: number;
  929. /**
  930. * On right pick
  931. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  932. */
  933. static readonly ACTION_OnRightPickTrigger: number;
  934. /**
  935. * On center pick
  936. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  937. */
  938. static readonly ACTION_OnCenterPickTrigger: number;
  939. /**
  940. * On pick down
  941. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  942. */
  943. static readonly ACTION_OnPickDownTrigger: number;
  944. /**
  945. * On double pick
  946. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  947. */
  948. static readonly ACTION_OnDoublePickTrigger: number;
  949. /**
  950. * On pick up
  951. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  952. */
  953. static readonly ACTION_OnPickUpTrigger: number;
  954. /**
  955. * On pick out.
  956. * This trigger will only be raised if you also declared a OnPickDown
  957. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  958. */
  959. static readonly ACTION_OnPickOutTrigger: number;
  960. /**
  961. * On long press
  962. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  963. */
  964. static readonly ACTION_OnLongPressTrigger: number;
  965. /**
  966. * On pointer over
  967. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  968. */
  969. static readonly ACTION_OnPointerOverTrigger: number;
  970. /**
  971. * On pointer out
  972. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  973. */
  974. static readonly ACTION_OnPointerOutTrigger: number;
  975. /**
  976. * On every frame
  977. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  978. */
  979. static readonly ACTION_OnEveryFrameTrigger: number;
  980. /**
  981. * On intersection enter
  982. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  983. */
  984. static readonly ACTION_OnIntersectionEnterTrigger: number;
  985. /**
  986. * On intersection exit
  987. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  988. */
  989. static readonly ACTION_OnIntersectionExitTrigger: number;
  990. /**
  991. * On key down
  992. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  993. */
  994. static readonly ACTION_OnKeyDownTrigger: number;
  995. /**
  996. * On key up
  997. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  998. */
  999. static readonly ACTION_OnKeyUpTrigger: number;
  1000. /**
  1001. * Billboard mode will only apply to Y axis
  1002. */
  1003. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  1004. /**
  1005. * Billboard mode will apply to all axes
  1006. */
  1007. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  1008. /**
  1009. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  1010. */
  1011. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  1012. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  1013. * Test order :
  1014. * Is the bounding sphere outside the frustum ?
  1015. * If not, are the bounding box vertices outside the frustum ?
  1016. * It not, then the cullable object is in the frustum.
  1017. */
  1018. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  1019. /** Culling strategy : Bounding Sphere Only.
  1020. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1021. * It's also less accurate than the standard because some not visible objects can still be selected.
  1022. * Test : is the bounding sphere outside the frustum ?
  1023. * If not, then the cullable object is in the frustum.
  1024. */
  1025. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1026. /** Culling strategy : Optimistic Inclusion.
  1027. * This in an inclusion test first, then the standard exclusion test.
  1028. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1029. * 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.
  1030. * Anyway, it's as accurate as the standard strategy.
  1031. * Test :
  1032. * Is the cullable object bounding sphere center in the frustum ?
  1033. * If not, apply the default culling strategy.
  1034. */
  1035. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1036. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1037. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1038. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1039. * 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.
  1040. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1041. * Test :
  1042. * Is the cullable object bounding sphere center in the frustum ?
  1043. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1044. */
  1045. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1046. /**
  1047. * No logging while loading
  1048. */
  1049. static readonly SCENELOADER_NO_LOGGING: number;
  1050. /**
  1051. * Minimal logging while loading
  1052. */
  1053. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1054. /**
  1055. * Summary logging while loading
  1056. */
  1057. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1058. /**
  1059. * Detailled logging while loading
  1060. */
  1061. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1062. /**
  1063. * Constant used to retrieve the irradiance texture index in the textures array in the prepass
  1064. * using getIndex(Constants.PREPASS_IRRADIANCE_TEXTURE_TYPE)
  1065. */
  1066. static readonly PREPASS_IRRADIANCE_TEXTURE_TYPE: number;
  1067. /**
  1068. * Constant used to retrieve the position texture index in the textures array in the prepass
  1069. * using getIndex(Constants.PREPASS_POSITION_TEXTURE_INDEX)
  1070. */
  1071. static readonly PREPASS_POSITION_TEXTURE_TYPE: number;
  1072. /**
  1073. * Constant used to retrieve the velocity texture index in the textures array in the prepass
  1074. * using getIndex(Constants.PREPASS_VELOCITY_TEXTURE_INDEX)
  1075. */
  1076. static readonly PREPASS_VELOCITY_TEXTURE_TYPE: number;
  1077. /**
  1078. * Constant used to retrieve the reflectivity texture index in the textures array in the prepass
  1079. * using the getIndex(Constants.PREPASS_REFLECTIVITY_TEXTURE_TYPE)
  1080. */
  1081. static readonly PREPASS_REFLECTIVITY_TEXTURE_TYPE: number;
  1082. /**
  1083. * Constant used to retrieve the lit color texture index in the textures array in the prepass
  1084. * using the getIndex(Constants.PREPASS_COLOR_TEXTURE_TYPE)
  1085. */
  1086. static readonly PREPASS_COLOR_TEXTURE_TYPE: number;
  1087. /**
  1088. * Constant used to retrieve depth + normal index in the textures array in the prepass
  1089. * using the getIndex(Constants.PREPASS_DEPTHNORMAL_TEXTURE_TYPE)
  1090. */
  1091. static readonly PREPASS_DEPTHNORMAL_TEXTURE_TYPE: number;
  1092. /**
  1093. * Constant used to retrieve albedo index in the textures array in the prepass
  1094. * using the getIndex(Constants.PREPASS_ALBEDO_TEXTURE_TYPE)
  1095. */
  1096. static readonly PREPASS_ALBEDO_TEXTURE_TYPE: number;
  1097. }
  1098. }
  1099. declare module BABYLON {
  1100. /**
  1101. * This represents the required contract to create a new type of texture loader.
  1102. */
  1103. export interface IInternalTextureLoader {
  1104. /**
  1105. * Defines wether the loader supports cascade loading the different faces.
  1106. */
  1107. supportCascades: boolean;
  1108. /**
  1109. * This returns if the loader support the current file information.
  1110. * @param extension defines the file extension of the file being loaded
  1111. * @param mimeType defines the optional mime type of the file being loaded
  1112. * @returns true if the loader can load the specified file
  1113. */
  1114. canLoad(extension: string, mimeType?: string): boolean;
  1115. /**
  1116. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  1117. * @param data contains the texture data
  1118. * @param texture defines the BabylonJS internal texture
  1119. * @param createPolynomials will be true if polynomials have been requested
  1120. * @param onLoad defines the callback to trigger once the texture is ready
  1121. * @param onError defines the callback to trigger in case of error
  1122. * @param options options to be passed to the loader
  1123. */
  1124. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, options?: any): void;
  1125. /**
  1126. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  1127. * @param data contains the texture data
  1128. * @param texture defines the BabylonJS internal texture
  1129. * @param callback defines the method to call once ready to upload
  1130. * @param options options to be passed to the loader
  1131. */
  1132. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void, options?: any): void;
  1133. }
  1134. }
  1135. declare module BABYLON {
  1136. /**
  1137. * Class used to store and describe the pipeline context associated with an effect
  1138. */
  1139. export interface IPipelineContext {
  1140. /**
  1141. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1142. */
  1143. isAsync: boolean;
  1144. /**
  1145. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1146. */
  1147. isReady: boolean;
  1148. /** @hidden */
  1149. _getVertexShaderCode(): string | null;
  1150. /** @hidden */
  1151. _getFragmentShaderCode(): string | null;
  1152. /** @hidden */
  1153. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1154. }
  1155. }
  1156. declare module BABYLON {
  1157. /**
  1158. * Class used to store gfx data (like WebGLBuffer)
  1159. */
  1160. export class DataBuffer {
  1161. /**
  1162. * Gets or sets the number of objects referencing this buffer
  1163. */
  1164. references: number;
  1165. /** Gets or sets the size of the underlying buffer */
  1166. capacity: number;
  1167. /**
  1168. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1169. */
  1170. is32Bits: boolean;
  1171. /**
  1172. * Gets the underlying buffer
  1173. */
  1174. get underlyingResource(): any;
  1175. }
  1176. }
  1177. declare module BABYLON {
  1178. /** @hidden */
  1179. export interface IShaderProcessor {
  1180. attributeProcessor?: (attribute: string) => string;
  1181. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1182. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1183. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1184. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1185. lineProcessor?: (line: string, isFragment: boolean) => string;
  1186. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1187. postProcessor?: (code: string, defines: string[], isFragment: boolean, engine: ThinEngine) => string;
  1188. }
  1189. }
  1190. declare module BABYLON {
  1191. /** @hidden */
  1192. export interface ProcessingOptions {
  1193. defines: string[];
  1194. indexParameters: any;
  1195. isFragment: boolean;
  1196. shouldUseHighPrecisionShader: boolean;
  1197. supportsUniformBuffers: boolean;
  1198. shadersRepository: string;
  1199. includesShadersStore: {
  1200. [key: string]: string;
  1201. };
  1202. processor?: IShaderProcessor;
  1203. version: string;
  1204. platformName: string;
  1205. lookForClosingBracketForUniformBuffer?: boolean;
  1206. }
  1207. }
  1208. declare module BABYLON {
  1209. /** @hidden */
  1210. export class ShaderCodeNode {
  1211. line: string;
  1212. children: ShaderCodeNode[];
  1213. additionalDefineKey?: string;
  1214. additionalDefineValue?: string;
  1215. isValid(preprocessors: {
  1216. [key: string]: string;
  1217. }): boolean;
  1218. process(preprocessors: {
  1219. [key: string]: string;
  1220. }, options: ProcessingOptions): string;
  1221. }
  1222. }
  1223. declare module BABYLON {
  1224. /** @hidden */
  1225. export class ShaderCodeCursor {
  1226. private _lines;
  1227. lineIndex: number;
  1228. get currentLine(): string;
  1229. get canRead(): boolean;
  1230. set lines(value: string[]);
  1231. }
  1232. }
  1233. declare module BABYLON {
  1234. /** @hidden */
  1235. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1236. process(preprocessors: {
  1237. [key: string]: string;
  1238. }, options: ProcessingOptions): string;
  1239. }
  1240. }
  1241. declare module BABYLON {
  1242. /** @hidden */
  1243. export class ShaderDefineExpression {
  1244. isTrue(preprocessors: {
  1245. [key: string]: string;
  1246. }): boolean;
  1247. private static _OperatorPriority;
  1248. private static _Stack;
  1249. static postfixToInfix(postfix: string[]): string;
  1250. static infixToPostfix(infix: string): string[];
  1251. }
  1252. }
  1253. declare module BABYLON {
  1254. /** @hidden */
  1255. export class ShaderCodeTestNode extends ShaderCodeNode {
  1256. testExpression: ShaderDefineExpression;
  1257. isValid(preprocessors: {
  1258. [key: string]: string;
  1259. }): boolean;
  1260. }
  1261. }
  1262. declare module BABYLON {
  1263. /** @hidden */
  1264. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1265. define: string;
  1266. not: boolean;
  1267. constructor(define: string, not?: boolean);
  1268. isTrue(preprocessors: {
  1269. [key: string]: string;
  1270. }): boolean;
  1271. }
  1272. }
  1273. declare module BABYLON {
  1274. /** @hidden */
  1275. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1276. leftOperand: ShaderDefineExpression;
  1277. rightOperand: ShaderDefineExpression;
  1278. isTrue(preprocessors: {
  1279. [key: string]: string;
  1280. }): boolean;
  1281. }
  1282. }
  1283. declare module BABYLON {
  1284. /** @hidden */
  1285. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1286. leftOperand: ShaderDefineExpression;
  1287. rightOperand: ShaderDefineExpression;
  1288. isTrue(preprocessors: {
  1289. [key: string]: string;
  1290. }): boolean;
  1291. }
  1292. }
  1293. declare module BABYLON {
  1294. /** @hidden */
  1295. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1296. define: string;
  1297. operand: string;
  1298. testValue: string;
  1299. constructor(define: string, operand: string, testValue: string);
  1300. isTrue(preprocessors: {
  1301. [key: string]: string;
  1302. }): boolean;
  1303. }
  1304. }
  1305. declare module BABYLON {
  1306. /**
  1307. * Class used to enable access to offline support
  1308. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1309. */
  1310. export interface IOfflineProvider {
  1311. /**
  1312. * Gets a boolean indicating if scene must be saved in the database
  1313. */
  1314. enableSceneOffline: boolean;
  1315. /**
  1316. * Gets a boolean indicating if textures must be saved in the database
  1317. */
  1318. enableTexturesOffline: boolean;
  1319. /**
  1320. * Open the offline support and make it available
  1321. * @param successCallback defines the callback to call on success
  1322. * @param errorCallback defines the callback to call on error
  1323. */
  1324. open(successCallback: () => void, errorCallback: () => void): void;
  1325. /**
  1326. * Loads an image from the offline support
  1327. * @param url defines the url to load from
  1328. * @param image defines the target DOM image
  1329. */
  1330. loadImage(url: string, image: HTMLImageElement): void;
  1331. /**
  1332. * Loads a file from offline support
  1333. * @param url defines the URL to load from
  1334. * @param sceneLoaded defines a callback to call on success
  1335. * @param progressCallBack defines a callback to call when progress changed
  1336. * @param errorCallback defines a callback to call on error
  1337. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1338. */
  1339. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1340. }
  1341. }
  1342. declare module BABYLON {
  1343. /**
  1344. * Class used to help managing file picking and drag'n'drop
  1345. * File Storage
  1346. */
  1347. export class FilesInputStore {
  1348. /**
  1349. * List of files ready to be loaded
  1350. */
  1351. static FilesToLoad: {
  1352. [key: string]: File;
  1353. };
  1354. }
  1355. }
  1356. declare module BABYLON {
  1357. /**
  1358. * Class used to define a retry strategy when error happens while loading assets
  1359. */
  1360. export class RetryStrategy {
  1361. /**
  1362. * Function used to defines an exponential back off strategy
  1363. * @param maxRetries defines the maximum number of retries (3 by default)
  1364. * @param baseInterval defines the interval between retries
  1365. * @returns the strategy function to use
  1366. */
  1367. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1368. }
  1369. }
  1370. declare module BABYLON {
  1371. /**
  1372. * @ignore
  1373. * Application error to support additional information when loading a file
  1374. */
  1375. export abstract class BaseError extends Error {
  1376. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1377. }
  1378. }
  1379. declare module BABYLON {
  1380. /** @ignore */
  1381. export class LoadFileError extends BaseError {
  1382. request?: WebRequest;
  1383. file?: File;
  1384. /**
  1385. * Creates a new LoadFileError
  1386. * @param message defines the message of the error
  1387. * @param request defines the optional web request
  1388. * @param file defines the optional file
  1389. */
  1390. constructor(message: string, object?: WebRequest | File);
  1391. }
  1392. /** @ignore */
  1393. export class RequestFileError extends BaseError {
  1394. request: WebRequest;
  1395. /**
  1396. * Creates a new LoadFileError
  1397. * @param message defines the message of the error
  1398. * @param request defines the optional web request
  1399. */
  1400. constructor(message: string, request: WebRequest);
  1401. }
  1402. /** @ignore */
  1403. export class ReadFileError extends BaseError {
  1404. file: File;
  1405. /**
  1406. * Creates a new ReadFileError
  1407. * @param message defines the message of the error
  1408. * @param file defines the optional file
  1409. */
  1410. constructor(message: string, file: File);
  1411. }
  1412. /**
  1413. * @hidden
  1414. */
  1415. export class FileTools {
  1416. /**
  1417. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1418. */
  1419. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1420. /**
  1421. * Gets or sets the base URL to use to load assets
  1422. */
  1423. static BaseUrl: string;
  1424. /**
  1425. * Default behaviour for cors in the application.
  1426. * It can be a string if the expected behavior is identical in the entire app.
  1427. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1428. */
  1429. static CorsBehavior: string | ((url: string | string[]) => string);
  1430. /**
  1431. * Gets or sets a function used to pre-process url before using them to load assets
  1432. */
  1433. static PreprocessUrl: (url: string) => string;
  1434. /**
  1435. * Removes unwanted characters from an url
  1436. * @param url defines the url to clean
  1437. * @returns the cleaned url
  1438. */
  1439. private static _CleanUrl;
  1440. /**
  1441. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1442. * @param url define the url we are trying
  1443. * @param element define the dom element where to configure the cors policy
  1444. */
  1445. static SetCorsBehavior(url: string | string[], element: {
  1446. crossOrigin: string | null;
  1447. }): void;
  1448. /**
  1449. * Loads an image as an HTMLImageElement.
  1450. * @param input url string, ArrayBuffer, or Blob to load
  1451. * @param onLoad callback called when the image successfully loads
  1452. * @param onError callback called when the image fails to load
  1453. * @param offlineProvider offline provider for caching
  1454. * @param mimeType optional mime type
  1455. * @returns the HTMLImageElement of the loaded image
  1456. */
  1457. static LoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  1458. /**
  1459. * Reads a file from a File object
  1460. * @param file defines the file to load
  1461. * @param onSuccess defines the callback to call when data is loaded
  1462. * @param onProgress defines the callback to call during loading process
  1463. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1464. * @param onError defines the callback to call when an error occurs
  1465. * @returns a file request object
  1466. */
  1467. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1468. /**
  1469. * Loads a file from a url
  1470. * @param url url to load
  1471. * @param onSuccess callback called when the file successfully loads
  1472. * @param onProgress callback called while file is loading (if the server supports this mode)
  1473. * @param offlineProvider defines the offline provider for caching
  1474. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1475. * @param onError callback called when the file fails to load
  1476. * @returns a file request object
  1477. */
  1478. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1479. /**
  1480. * Loads a file
  1481. * @param url url to load
  1482. * @param onSuccess callback called when the file successfully loads
  1483. * @param onProgress callback called while file is loading (if the server supports this mode)
  1484. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1485. * @param onError callback called when the file fails to load
  1486. * @param onOpened callback called when the web request is opened
  1487. * @returns a file request object
  1488. */
  1489. static RequestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (event: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  1490. /**
  1491. * Checks if the loaded document was accessed via `file:`-Protocol.
  1492. * @returns boolean
  1493. */
  1494. static IsFileURL(): boolean;
  1495. }
  1496. }
  1497. declare module BABYLON {
  1498. /** @hidden */
  1499. export class ShaderProcessor {
  1500. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void, engine: ThinEngine): void;
  1501. private static _ProcessPrecision;
  1502. private static _ExtractOperation;
  1503. private static _BuildSubExpression;
  1504. private static _BuildExpression;
  1505. private static _MoveCursorWithinIf;
  1506. private static _MoveCursor;
  1507. private static _EvaluatePreProcessors;
  1508. private static _PreparePreProcessors;
  1509. private static _ProcessShaderConversion;
  1510. private static _ProcessIncludes;
  1511. /**
  1512. * Loads a file from a url
  1513. * @param url url to load
  1514. * @param onSuccess callback called when the file successfully loads
  1515. * @param onProgress callback called while file is loading (if the server supports this mode)
  1516. * @param offlineProvider defines the offline provider for caching
  1517. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1518. * @param onError callback called when the file fails to load
  1519. * @returns a file request object
  1520. * @hidden
  1521. */
  1522. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1523. }
  1524. }
  1525. declare module BABYLON {
  1526. /**
  1527. * @hidden
  1528. */
  1529. export interface IColor4Like {
  1530. r: float;
  1531. g: float;
  1532. b: float;
  1533. a: float;
  1534. }
  1535. /**
  1536. * @hidden
  1537. */
  1538. export interface IColor3Like {
  1539. r: float;
  1540. g: float;
  1541. b: float;
  1542. }
  1543. /**
  1544. * @hidden
  1545. */
  1546. export interface IVector4Like {
  1547. x: float;
  1548. y: float;
  1549. z: float;
  1550. w: float;
  1551. }
  1552. /**
  1553. * @hidden
  1554. */
  1555. export interface IVector3Like {
  1556. x: float;
  1557. y: float;
  1558. z: float;
  1559. }
  1560. /**
  1561. * @hidden
  1562. */
  1563. export interface IVector2Like {
  1564. x: float;
  1565. y: float;
  1566. }
  1567. /**
  1568. * @hidden
  1569. */
  1570. export interface IMatrixLike {
  1571. toArray(): DeepImmutable<Float32Array | Array<number>>;
  1572. updateFlag: int;
  1573. }
  1574. /**
  1575. * @hidden
  1576. */
  1577. export interface IViewportLike {
  1578. x: float;
  1579. y: float;
  1580. width: float;
  1581. height: float;
  1582. }
  1583. /**
  1584. * @hidden
  1585. */
  1586. export interface IPlaneLike {
  1587. normal: IVector3Like;
  1588. d: float;
  1589. normalize(): void;
  1590. }
  1591. }
  1592. declare module BABYLON {
  1593. /**
  1594. * Interface used to define common properties for effect fallbacks
  1595. */
  1596. export interface IEffectFallbacks {
  1597. /**
  1598. * Removes the defines that should be removed when falling back.
  1599. * @param currentDefines defines the current define statements for the shader.
  1600. * @param effect defines the current effect we try to compile
  1601. * @returns The resulting defines with defines of the current rank removed.
  1602. */
  1603. reduce(currentDefines: string, effect: Effect): string;
  1604. /**
  1605. * Removes the fallback from the bound mesh.
  1606. */
  1607. unBindMesh(): void;
  1608. /**
  1609. * Checks to see if more fallbacks are still availible.
  1610. */
  1611. hasMoreFallbacks: boolean;
  1612. }
  1613. }
  1614. declare module BABYLON {
  1615. /**
  1616. * Interface for the size containing width and height
  1617. */
  1618. export interface ISize {
  1619. /**
  1620. * Width
  1621. */
  1622. width: number;
  1623. /**
  1624. * Heighht
  1625. */
  1626. height: number;
  1627. }
  1628. /**
  1629. * Size containing widht and height
  1630. */
  1631. export class Size implements ISize {
  1632. /**
  1633. * Width
  1634. */
  1635. width: number;
  1636. /**
  1637. * Height
  1638. */
  1639. height: number;
  1640. /**
  1641. * Creates a Size object from the given width and height (floats).
  1642. * @param width width of the new size
  1643. * @param height height of the new size
  1644. */
  1645. constructor(width: number, height: number);
  1646. /**
  1647. * Returns a string with the Size width and height
  1648. * @returns a string with the Size width and height
  1649. */
  1650. toString(): string;
  1651. /**
  1652. * "Size"
  1653. * @returns the string "Size"
  1654. */
  1655. getClassName(): string;
  1656. /**
  1657. * Returns the Size hash code.
  1658. * @returns a hash code for a unique width and height
  1659. */
  1660. getHashCode(): number;
  1661. /**
  1662. * Updates the current size from the given one.
  1663. * @param src the given size
  1664. */
  1665. copyFrom(src: Size): void;
  1666. /**
  1667. * Updates in place the current Size from the given floats.
  1668. * @param width width of the new size
  1669. * @param height height of the new size
  1670. * @returns the updated Size.
  1671. */
  1672. copyFromFloats(width: number, height: number): Size;
  1673. /**
  1674. * Updates in place the current Size from the given floats.
  1675. * @param width width to set
  1676. * @param height height to set
  1677. * @returns the updated Size.
  1678. */
  1679. set(width: number, height: number): Size;
  1680. /**
  1681. * Multiplies the width and height by numbers
  1682. * @param w factor to multiple the width by
  1683. * @param h factor to multiple the height by
  1684. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  1685. */
  1686. multiplyByFloats(w: number, h: number): Size;
  1687. /**
  1688. * Clones the size
  1689. * @returns a new Size copied from the given one.
  1690. */
  1691. clone(): Size;
  1692. /**
  1693. * True if the current Size and the given one width and height are strictly equal.
  1694. * @param other the other size to compare against
  1695. * @returns True if the current Size and the given one width and height are strictly equal.
  1696. */
  1697. equals(other: Size): boolean;
  1698. /**
  1699. * The surface of the Size : width * height (float).
  1700. */
  1701. get surface(): number;
  1702. /**
  1703. * Create a new size of zero
  1704. * @returns a new Size set to (0.0, 0.0)
  1705. */
  1706. static Zero(): Size;
  1707. /**
  1708. * Sums the width and height of two sizes
  1709. * @param otherSize size to add to this size
  1710. * @returns a new Size set as the addition result of the current Size and the given one.
  1711. */
  1712. add(otherSize: Size): Size;
  1713. /**
  1714. * Subtracts the width and height of two
  1715. * @param otherSize size to subtract to this size
  1716. * @returns a new Size set as the subtraction result of the given one from the current Size.
  1717. */
  1718. subtract(otherSize: Size): Size;
  1719. /**
  1720. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  1721. * @param start starting size to lerp between
  1722. * @param end end size to lerp between
  1723. * @param amount amount to lerp between the start and end values
  1724. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  1725. */
  1726. static Lerp(start: Size, end: Size, amount: number): Size;
  1727. }
  1728. }
  1729. declare module BABYLON {
  1730. /**
  1731. * Base class of all the textures in babylon.
  1732. * It groups all the common properties required to work with Thin Engine.
  1733. */
  1734. export class ThinTexture {
  1735. protected _wrapU: number;
  1736. /**
  1737. * | Value | Type | Description |
  1738. * | ----- | ------------------ | ----------- |
  1739. * | 0 | CLAMP_ADDRESSMODE | |
  1740. * | 1 | WRAP_ADDRESSMODE | |
  1741. * | 2 | MIRROR_ADDRESSMODE | |
  1742. */
  1743. get wrapU(): number;
  1744. set wrapU(value: number);
  1745. protected _wrapV: number;
  1746. /**
  1747. * | Value | Type | Description |
  1748. * | ----- | ------------------ | ----------- |
  1749. * | 0 | CLAMP_ADDRESSMODE | |
  1750. * | 1 | WRAP_ADDRESSMODE | |
  1751. * | 2 | MIRROR_ADDRESSMODE | |
  1752. */
  1753. get wrapV(): number;
  1754. set wrapV(value: number);
  1755. /**
  1756. * | Value | Type | Description |
  1757. * | ----- | ------------------ | ----------- |
  1758. * | 0 | CLAMP_ADDRESSMODE | |
  1759. * | 1 | WRAP_ADDRESSMODE | |
  1760. * | 2 | MIRROR_ADDRESSMODE | |
  1761. */
  1762. wrapR: number;
  1763. /**
  1764. * With compliant hardware and browser (supporting anisotropic filtering)
  1765. * this defines the level of anisotropic filtering in the texture.
  1766. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  1767. */
  1768. anisotropicFilteringLevel: number;
  1769. /**
  1770. * Define the current state of the loading sequence when in delayed load mode.
  1771. */
  1772. delayLoadState: number;
  1773. /**
  1774. * How a texture is mapped.
  1775. * Unused in thin texture mode.
  1776. */
  1777. get coordinatesMode(): number;
  1778. /**
  1779. * Define if the texture is a cube texture or if false a 2d texture.
  1780. */
  1781. get isCube(): boolean;
  1782. set isCube(value: boolean);
  1783. /**
  1784. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  1785. */
  1786. get is3D(): boolean;
  1787. set is3D(value: boolean);
  1788. /**
  1789. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  1790. */
  1791. get is2DArray(): boolean;
  1792. set is2DArray(value: boolean);
  1793. /**
  1794. * Get the class name of the texture.
  1795. * @returns "ThinTexture"
  1796. */
  1797. getClassName(): string;
  1798. /** @hidden */
  1799. _texture: Nullable<InternalTexture>;
  1800. protected _engine: Nullable<ThinEngine>;
  1801. private _cachedSize;
  1802. private _cachedBaseSize;
  1803. /**
  1804. * Instantiates a new ThinTexture.
  1805. * Base class of all the textures in babylon.
  1806. * This can be used as an internal texture wrapper in ThinEngine to benefit from the cache
  1807. * @param internalTexture Define the internalTexture to wrap
  1808. */
  1809. constructor(internalTexture: Nullable<InternalTexture>);
  1810. /**
  1811. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  1812. * @returns true if fully ready
  1813. */
  1814. isReady(): boolean;
  1815. /**
  1816. * Triggers the load sequence in delayed load mode.
  1817. */
  1818. delayLoad(): void;
  1819. /**
  1820. * Get the underlying lower level texture from Babylon.
  1821. * @returns the insternal texture
  1822. */
  1823. getInternalTexture(): Nullable<InternalTexture>;
  1824. /**
  1825. * Get the size of the texture.
  1826. * @returns the texture size.
  1827. */
  1828. getSize(): ISize;
  1829. /**
  1830. * Get the base size of the texture.
  1831. * It can be different from the size if the texture has been resized for POT for instance
  1832. * @returns the base size
  1833. */
  1834. getBaseSize(): ISize;
  1835. /**
  1836. * Update the sampling mode of the texture.
  1837. * Default is Trilinear mode.
  1838. *
  1839. * | Value | Type | Description |
  1840. * | ----- | ------------------ | ----------- |
  1841. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  1842. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  1843. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  1844. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  1845. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  1846. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  1847. * | 7 | NEAREST_LINEAR | |
  1848. * | 8 | NEAREST_NEAREST | |
  1849. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  1850. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  1851. * | 11 | LINEAR_LINEAR | |
  1852. * | 12 | LINEAR_NEAREST | |
  1853. *
  1854. * > _mag_: magnification filter (close to the viewer)
  1855. * > _min_: minification filter (far from the viewer)
  1856. * > _mip_: filter used between mip map levels
  1857. *@param samplingMode Define the new sampling mode of the texture
  1858. */
  1859. updateSamplingMode(samplingMode: number): void;
  1860. /**
  1861. * Release and destroy the underlying lower level texture aka internalTexture.
  1862. */
  1863. releaseInternalTexture(): void;
  1864. /**
  1865. * Dispose the texture and release its associated resources.
  1866. */
  1867. dispose(): void;
  1868. }
  1869. }
  1870. declare module BABYLON {
  1871. /**
  1872. * Defines an array and its length.
  1873. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  1874. */
  1875. export interface ISmartArrayLike<T> {
  1876. /**
  1877. * The data of the array.
  1878. */
  1879. data: Array<T>;
  1880. /**
  1881. * The active length of the array.
  1882. */
  1883. length: number;
  1884. }
  1885. /**
  1886. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  1887. */
  1888. export class SmartArray<T> implements ISmartArrayLike<T> {
  1889. /**
  1890. * The full set of data from the array.
  1891. */
  1892. data: Array<T>;
  1893. /**
  1894. * The active length of the array.
  1895. */
  1896. length: number;
  1897. protected _id: number;
  1898. /**
  1899. * Instantiates a Smart Array.
  1900. * @param capacity defines the default capacity of the array.
  1901. */
  1902. constructor(capacity: number);
  1903. /**
  1904. * Pushes a value at the end of the active data.
  1905. * @param value defines the object to push in the array.
  1906. */
  1907. push(value: T): void;
  1908. /**
  1909. * Iterates over the active data and apply the lambda to them.
  1910. * @param func defines the action to apply on each value.
  1911. */
  1912. forEach(func: (content: T) => void): void;
  1913. /**
  1914. * Sorts the full sets of data.
  1915. * @param compareFn defines the comparison function to apply.
  1916. */
  1917. sort(compareFn: (a: T, b: T) => number): void;
  1918. /**
  1919. * Resets the active data to an empty array.
  1920. */
  1921. reset(): void;
  1922. /**
  1923. * Releases all the data from the array as well as the array.
  1924. */
  1925. dispose(): void;
  1926. /**
  1927. * Concats the active data with a given array.
  1928. * @param array defines the data to concatenate with.
  1929. */
  1930. concat(array: any): void;
  1931. /**
  1932. * Returns the position of a value in the active data.
  1933. * @param value defines the value to find the index for
  1934. * @returns the index if found in the active data otherwise -1
  1935. */
  1936. indexOf(value: T): number;
  1937. /**
  1938. * Returns whether an element is part of the active data.
  1939. * @param value defines the value to look for
  1940. * @returns true if found in the active data otherwise false
  1941. */
  1942. contains(value: T): boolean;
  1943. private static _GlobalId;
  1944. }
  1945. /**
  1946. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  1947. * The data in this array can only be present once
  1948. */
  1949. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  1950. private _duplicateId;
  1951. /**
  1952. * Pushes a value at the end of the active data.
  1953. * THIS DOES NOT PREVENT DUPPLICATE DATA
  1954. * @param value defines the object to push in the array.
  1955. */
  1956. push(value: T): void;
  1957. /**
  1958. * Pushes a value at the end of the active data.
  1959. * If the data is already present, it won t be added again
  1960. * @param value defines the object to push in the array.
  1961. * @returns true if added false if it was already present
  1962. */
  1963. pushNoDuplicate(value: T): boolean;
  1964. /**
  1965. * Resets the active data to an empty array.
  1966. */
  1967. reset(): void;
  1968. /**
  1969. * Concats the active data with a given array.
  1970. * This ensures no dupplicate will be present in the result.
  1971. * @param array defines the data to concatenate with.
  1972. */
  1973. concatWithNoDuplicate(array: any): void;
  1974. }
  1975. }
  1976. declare module BABYLON {
  1977. /**
  1978. * Class used to evalaute queries containing `and` and `or` operators
  1979. */
  1980. export class AndOrNotEvaluator {
  1981. /**
  1982. * Evaluate a query
  1983. * @param query defines the query to evaluate
  1984. * @param evaluateCallback defines the callback used to filter result
  1985. * @returns true if the query matches
  1986. */
  1987. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1988. private static _HandleParenthesisContent;
  1989. private static _SimplifyNegation;
  1990. }
  1991. }
  1992. declare module BABYLON {
  1993. /**
  1994. * Class used to store custom tags
  1995. */
  1996. export class Tags {
  1997. /**
  1998. * Adds support for tags on the given object
  1999. * @param obj defines the object to use
  2000. */
  2001. static EnableFor(obj: any): void;
  2002. /**
  2003. * Removes tags support
  2004. * @param obj defines the object to use
  2005. */
  2006. static DisableFor(obj: any): void;
  2007. /**
  2008. * Gets a boolean indicating if the given object has tags
  2009. * @param obj defines the object to use
  2010. * @returns a boolean
  2011. */
  2012. static HasTags(obj: any): boolean;
  2013. /**
  2014. * Gets the tags available on a given object
  2015. * @param obj defines the object to use
  2016. * @param asString defines if the tags must be returned as a string instead of an array of strings
  2017. * @returns the tags
  2018. */
  2019. static GetTags(obj: any, asString?: boolean): any;
  2020. /**
  2021. * Adds tags to an object
  2022. * @param obj defines the object to use
  2023. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  2024. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  2025. */
  2026. static AddTagsTo(obj: any, tagsString: string): void;
  2027. /**
  2028. * @hidden
  2029. */
  2030. static _AddTagTo(obj: any, tag: string): void;
  2031. /**
  2032. * Removes specific tags from a specific object
  2033. * @param obj defines the object to use
  2034. * @param tagsString defines the tags to remove
  2035. */
  2036. static RemoveTagsFrom(obj: any, tagsString: string): void;
  2037. /**
  2038. * @hidden
  2039. */
  2040. static _RemoveTagFrom(obj: any, tag: string): void;
  2041. /**
  2042. * Defines if tags hosted on an object match a given query
  2043. * @param obj defines the object to use
  2044. * @param tagsQuery defines the tag query
  2045. * @returns a boolean
  2046. */
  2047. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  2048. }
  2049. }
  2050. declare module BABYLON {
  2051. /**
  2052. * Scalar computation library
  2053. */
  2054. export class Scalar {
  2055. /**
  2056. * Two pi constants convenient for computation.
  2057. */
  2058. static TwoPi: number;
  2059. /**
  2060. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  2061. * @param a number
  2062. * @param b number
  2063. * @param epsilon (default = 1.401298E-45)
  2064. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  2065. */
  2066. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  2067. /**
  2068. * Returns a string : the upper case translation of the number i to hexadecimal.
  2069. * @param i number
  2070. * @returns the upper case translation of the number i to hexadecimal.
  2071. */
  2072. static ToHex(i: number): string;
  2073. /**
  2074. * Returns -1 if value is negative and +1 is value is positive.
  2075. * @param value the value
  2076. * @returns the value itself if it's equal to zero.
  2077. */
  2078. static Sign(value: number): number;
  2079. /**
  2080. * Returns the value itself if it's between min and max.
  2081. * Returns min if the value is lower than min.
  2082. * Returns max if the value is greater than max.
  2083. * @param value the value to clmap
  2084. * @param min the min value to clamp to (default: 0)
  2085. * @param max the max value to clamp to (default: 1)
  2086. * @returns the clamped value
  2087. */
  2088. static Clamp(value: number, min?: number, max?: number): number;
  2089. /**
  2090. * the log2 of value.
  2091. * @param value the value to compute log2 of
  2092. * @returns the log2 of value.
  2093. */
  2094. static Log2(value: number): number;
  2095. /**
  2096. * Loops the value, so that it is never larger than length and never smaller than 0.
  2097. *
  2098. * This is similar to the modulo operator but it works with floating point numbers.
  2099. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  2100. * With t = 5 and length = 2.5, the result would be 0.0.
  2101. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  2102. * @param value the value
  2103. * @param length the length
  2104. * @returns the looped value
  2105. */
  2106. static Repeat(value: number, length: number): number;
  2107. /**
  2108. * Normalize the value between 0.0 and 1.0 using min and max values
  2109. * @param value value to normalize
  2110. * @param min max to normalize between
  2111. * @param max min to normalize between
  2112. * @returns the normalized value
  2113. */
  2114. static Normalize(value: number, min: number, max: number): number;
  2115. /**
  2116. * Denormalize the value from 0.0 and 1.0 using min and max values
  2117. * @param normalized value to denormalize
  2118. * @param min max to denormalize between
  2119. * @param max min to denormalize between
  2120. * @returns the denormalized value
  2121. */
  2122. static Denormalize(normalized: number, min: number, max: number): number;
  2123. /**
  2124. * Calculates the shortest difference between two given angles given in degrees.
  2125. * @param current current angle in degrees
  2126. * @param target target angle in degrees
  2127. * @returns the delta
  2128. */
  2129. static DeltaAngle(current: number, target: number): number;
  2130. /**
  2131. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  2132. * @param tx value
  2133. * @param length length
  2134. * @returns The returned value will move back and forth between 0 and length
  2135. */
  2136. static PingPong(tx: number, length: number): number;
  2137. /**
  2138. * Interpolates between min and max with smoothing at the limits.
  2139. *
  2140. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  2141. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  2142. * @param from from
  2143. * @param to to
  2144. * @param tx value
  2145. * @returns the smooth stepped value
  2146. */
  2147. static SmoothStep(from: number, to: number, tx: number): number;
  2148. /**
  2149. * Moves a value current towards target.
  2150. *
  2151. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  2152. * Negative values of maxDelta pushes the value away from target.
  2153. * @param current current value
  2154. * @param target target value
  2155. * @param maxDelta max distance to move
  2156. * @returns resulting value
  2157. */
  2158. static MoveTowards(current: number, target: number, maxDelta: number): number;
  2159. /**
  2160. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  2161. *
  2162. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  2163. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  2164. * @param current current value
  2165. * @param target target value
  2166. * @param maxDelta max distance to move
  2167. * @returns resulting angle
  2168. */
  2169. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  2170. /**
  2171. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  2172. * @param start start value
  2173. * @param end target value
  2174. * @param amount amount to lerp between
  2175. * @returns the lerped value
  2176. */
  2177. static Lerp(start: number, end: number, amount: number): number;
  2178. /**
  2179. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  2180. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  2181. * @param start start value
  2182. * @param end target value
  2183. * @param amount amount to lerp between
  2184. * @returns the lerped value
  2185. */
  2186. static LerpAngle(start: number, end: number, amount: number): number;
  2187. /**
  2188. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  2189. * @param a start value
  2190. * @param b target value
  2191. * @param value value between a and b
  2192. * @returns the inverseLerp value
  2193. */
  2194. static InverseLerp(a: number, b: number, value: number): number;
  2195. /**
  2196. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  2197. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  2198. * @param value1 spline value
  2199. * @param tangent1 spline value
  2200. * @param value2 spline value
  2201. * @param tangent2 spline value
  2202. * @param amount input value
  2203. * @returns hermite result
  2204. */
  2205. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  2206. /**
  2207. * Returns a random float number between and min and max values
  2208. * @param min min value of random
  2209. * @param max max value of random
  2210. * @returns random value
  2211. */
  2212. static RandomRange(min: number, max: number): number;
  2213. /**
  2214. * This function returns percentage of a number in a given range.
  2215. *
  2216. * RangeToPercent(40,20,60) will return 0.5 (50%)
  2217. * RangeToPercent(34,0,100) will return 0.34 (34%)
  2218. * @param number to convert to percentage
  2219. * @param min min range
  2220. * @param max max range
  2221. * @returns the percentage
  2222. */
  2223. static RangeToPercent(number: number, min: number, max: number): number;
  2224. /**
  2225. * This function returns number that corresponds to the percentage in a given range.
  2226. *
  2227. * PercentToRange(0.34,0,100) will return 34.
  2228. * @param percent to convert to number
  2229. * @param min min range
  2230. * @param max max range
  2231. * @returns the number
  2232. */
  2233. static PercentToRange(percent: number, min: number, max: number): number;
  2234. /**
  2235. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  2236. * @param angle The angle to normalize in radian.
  2237. * @return The converted angle.
  2238. */
  2239. static NormalizeRadians(angle: number): number;
  2240. }
  2241. }
  2242. declare module BABYLON {
  2243. /**
  2244. * Constant used to convert a value to gamma space
  2245. * @ignorenaming
  2246. */
  2247. export const ToGammaSpace: number;
  2248. /**
  2249. * Constant used to convert a value to linear space
  2250. * @ignorenaming
  2251. */
  2252. export const ToLinearSpace = 2.2;
  2253. /**
  2254. * Constant used to define the minimal number value in Babylon.js
  2255. * @ignorenaming
  2256. */
  2257. let Epsilon: number;
  2258. }
  2259. declare module BABYLON {
  2260. /**
  2261. * Class used to represent a viewport on screen
  2262. */
  2263. export class Viewport {
  2264. /** viewport left coordinate */
  2265. x: number;
  2266. /** viewport top coordinate */
  2267. y: number;
  2268. /**viewport width */
  2269. width: number;
  2270. /** viewport height */
  2271. height: number;
  2272. /**
  2273. * Creates a Viewport object located at (x, y) and sized (width, height)
  2274. * @param x defines viewport left coordinate
  2275. * @param y defines viewport top coordinate
  2276. * @param width defines the viewport width
  2277. * @param height defines the viewport height
  2278. */
  2279. constructor(
  2280. /** viewport left coordinate */
  2281. x: number,
  2282. /** viewport top coordinate */
  2283. y: number,
  2284. /**viewport width */
  2285. width: number,
  2286. /** viewport height */
  2287. height: number);
  2288. /**
  2289. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  2290. * @param renderWidth defines the rendering width
  2291. * @param renderHeight defines the rendering height
  2292. * @returns a new Viewport
  2293. */
  2294. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  2295. /**
  2296. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  2297. * @param renderWidth defines the rendering width
  2298. * @param renderHeight defines the rendering height
  2299. * @param ref defines the target viewport
  2300. * @returns the current viewport
  2301. */
  2302. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  2303. /**
  2304. * Returns a new Viewport copied from the current one
  2305. * @returns a new Viewport
  2306. */
  2307. clone(): Viewport;
  2308. }
  2309. }
  2310. declare module BABYLON {
  2311. /**
  2312. * Class containing a set of static utilities functions for arrays.
  2313. */
  2314. export class ArrayTools {
  2315. /**
  2316. * Returns an array of the given size filled with element built from the given constructor and the paramters
  2317. * @param size the number of element to construct and put in the array
  2318. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  2319. * @returns a new array filled with new objects
  2320. */
  2321. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  2322. }
  2323. }
  2324. declare module BABYLON {
  2325. /**
  2326. * Represents a plane by the equation ax + by + cz + d = 0
  2327. */
  2328. export class Plane {
  2329. private static _TmpMatrix;
  2330. /**
  2331. * Normal of the plane (a,b,c)
  2332. */
  2333. normal: Vector3;
  2334. /**
  2335. * d component of the plane
  2336. */
  2337. d: number;
  2338. /**
  2339. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  2340. * @param a a component of the plane
  2341. * @param b b component of the plane
  2342. * @param c c component of the plane
  2343. * @param d d component of the plane
  2344. */
  2345. constructor(a: number, b: number, c: number, d: number);
  2346. /**
  2347. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  2348. */
  2349. asArray(): number[];
  2350. /**
  2351. * @returns a new plane copied from the current Plane.
  2352. */
  2353. clone(): Plane;
  2354. /**
  2355. * @returns the string "Plane".
  2356. */
  2357. getClassName(): string;
  2358. /**
  2359. * @returns the Plane hash code.
  2360. */
  2361. getHashCode(): number;
  2362. /**
  2363. * Normalize the current Plane in place.
  2364. * @returns the updated Plane.
  2365. */
  2366. normalize(): Plane;
  2367. /**
  2368. * Applies a transformation the plane and returns the result
  2369. * @param transformation the transformation matrix to be applied to the plane
  2370. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  2371. */
  2372. transform(transformation: DeepImmutable<Matrix>): Plane;
  2373. /**
  2374. * Compute the dot product between the point and the plane normal
  2375. * @param point point to calculate the dot product with
  2376. * @returns the dot product (float) of the point coordinates and the plane normal.
  2377. */
  2378. dotCoordinate(point: DeepImmutable<Vector3>): number;
  2379. /**
  2380. * Updates the current Plane from the plane defined by the three given points.
  2381. * @param point1 one of the points used to contruct the plane
  2382. * @param point2 one of the points used to contruct the plane
  2383. * @param point3 one of the points used to contruct the plane
  2384. * @returns the updated Plane.
  2385. */
  2386. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2387. /**
  2388. * Checks if the plane is facing a given direction
  2389. * @param direction the direction to check if the plane is facing
  2390. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  2391. * @returns True is the vector "direction" is the same side than the plane normal.
  2392. */
  2393. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  2394. /**
  2395. * Calculates the distance to a point
  2396. * @param point point to calculate distance to
  2397. * @returns the signed distance (float) from the given point to the Plane.
  2398. */
  2399. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  2400. /**
  2401. * Creates a plane from an array
  2402. * @param array the array to create a plane from
  2403. * @returns a new Plane from the given array.
  2404. */
  2405. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  2406. /**
  2407. * Creates a plane from three points
  2408. * @param point1 point used to create the plane
  2409. * @param point2 point used to create the plane
  2410. * @param point3 point used to create the plane
  2411. * @returns a new Plane defined by the three given points.
  2412. */
  2413. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2414. /**
  2415. * Creates a plane from an origin point and a normal
  2416. * @param origin origin of the plane to be constructed
  2417. * @param normal normal of the plane to be constructed
  2418. * @returns a new Plane the normal vector to this plane at the given origin point.
  2419. * Note : the vector "normal" is updated because normalized.
  2420. */
  2421. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  2422. /**
  2423. * Calculates the distance from a plane and a point
  2424. * @param origin origin of the plane to be constructed
  2425. * @param normal normal of the plane to be constructed
  2426. * @param point point to calculate distance to
  2427. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  2428. */
  2429. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  2430. }
  2431. }
  2432. declare module BABYLON {
  2433. /** @hidden */
  2434. export class PerformanceConfigurator {
  2435. /** @hidden */
  2436. static MatrixUse64Bits: boolean;
  2437. /** @hidden */
  2438. static MatrixTrackPrecisionChange: boolean;
  2439. /** @hidden */
  2440. static MatrixCurrentType: any;
  2441. /** @hidden */
  2442. static MatrixTrackedMatrices: Array<any> | null;
  2443. /** @hidden */
  2444. static SetMatrixPrecision(use64bits: boolean): void;
  2445. }
  2446. }
  2447. declare module BABYLON {
  2448. /**
  2449. * Class representing a vector containing 2 coordinates
  2450. */
  2451. export class Vector2 {
  2452. /** defines the first coordinate */
  2453. x: number;
  2454. /** defines the second coordinate */
  2455. y: number;
  2456. /**
  2457. * Creates a new Vector2 from the given x and y coordinates
  2458. * @param x defines the first coordinate
  2459. * @param y defines the second coordinate
  2460. */
  2461. constructor(
  2462. /** defines the first coordinate */
  2463. x?: number,
  2464. /** defines the second coordinate */
  2465. y?: number);
  2466. /**
  2467. * Gets a string with the Vector2 coordinates
  2468. * @returns a string with the Vector2 coordinates
  2469. */
  2470. toString(): string;
  2471. /**
  2472. * Gets class name
  2473. * @returns the string "Vector2"
  2474. */
  2475. getClassName(): string;
  2476. /**
  2477. * Gets current vector hash code
  2478. * @returns the Vector2 hash code as a number
  2479. */
  2480. getHashCode(): number;
  2481. /**
  2482. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  2483. * @param array defines the source array
  2484. * @param index defines the offset in source array
  2485. * @returns the current Vector2
  2486. */
  2487. toArray(array: FloatArray, index?: number): Vector2;
  2488. /**
  2489. * Update the current vector from an array
  2490. * @param array defines the destination array
  2491. * @param index defines the offset in the destination array
  2492. * @returns the current Vector3
  2493. */
  2494. fromArray(array: FloatArray, index?: number): Vector2;
  2495. /**
  2496. * Copy the current vector to an array
  2497. * @returns a new array with 2 elements: the Vector2 coordinates.
  2498. */
  2499. asArray(): number[];
  2500. /**
  2501. * Sets the Vector2 coordinates with the given Vector2 coordinates
  2502. * @param source defines the source Vector2
  2503. * @returns the current updated Vector2
  2504. */
  2505. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  2506. /**
  2507. * Sets the Vector2 coordinates with the given floats
  2508. * @param x defines the first coordinate
  2509. * @param y defines the second coordinate
  2510. * @returns the current updated Vector2
  2511. */
  2512. copyFromFloats(x: number, y: number): Vector2;
  2513. /**
  2514. * Sets the Vector2 coordinates with the given floats
  2515. * @param x defines the first coordinate
  2516. * @param y defines the second coordinate
  2517. * @returns the current updated Vector2
  2518. */
  2519. set(x: number, y: number): Vector2;
  2520. /**
  2521. * Add another vector with the current one
  2522. * @param otherVector defines the other vector
  2523. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  2524. */
  2525. add(otherVector: DeepImmutable<Vector2>): Vector2;
  2526. /**
  2527. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2528. * @param otherVector defines the other vector
  2529. * @param result defines the target vector
  2530. * @returns the unmodified current Vector2
  2531. */
  2532. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2533. /**
  2534. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2535. * @param otherVector defines the other vector
  2536. * @returns the current updated Vector2
  2537. */
  2538. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2539. /**
  2540. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2541. * @param otherVector defines the other vector
  2542. * @returns a new Vector2
  2543. */
  2544. addVector3(otherVector: Vector3): Vector2;
  2545. /**
  2546. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2547. * @param otherVector defines the other vector
  2548. * @returns a new Vector2
  2549. */
  2550. subtract(otherVector: Vector2): Vector2;
  2551. /**
  2552. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2553. * @param otherVector defines the other vector
  2554. * @param result defines the target vector
  2555. * @returns the unmodified current Vector2
  2556. */
  2557. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2558. /**
  2559. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2560. * @param otherVector defines the other vector
  2561. * @returns the current updated Vector2
  2562. */
  2563. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2564. /**
  2565. * Multiplies in place the current Vector2 coordinates by the given ones
  2566. * @param otherVector defines the other vector
  2567. * @returns the current updated Vector2
  2568. */
  2569. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2570. /**
  2571. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2572. * @param otherVector defines the other vector
  2573. * @returns a new Vector2
  2574. */
  2575. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2576. /**
  2577. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2578. * @param otherVector defines the other vector
  2579. * @param result defines the target vector
  2580. * @returns the unmodified current Vector2
  2581. */
  2582. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2583. /**
  2584. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2585. * @param x defines the first coordinate
  2586. * @param y defines the second coordinate
  2587. * @returns a new Vector2
  2588. */
  2589. multiplyByFloats(x: number, y: number): Vector2;
  2590. /**
  2591. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2592. * @param otherVector defines the other vector
  2593. * @returns a new Vector2
  2594. */
  2595. divide(otherVector: Vector2): Vector2;
  2596. /**
  2597. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2598. * @param otherVector defines the other vector
  2599. * @param result defines the target vector
  2600. * @returns the unmodified current Vector2
  2601. */
  2602. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2603. /**
  2604. * Divides the current Vector2 coordinates by the given ones
  2605. * @param otherVector defines the other vector
  2606. * @returns the current updated Vector2
  2607. */
  2608. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2609. /**
  2610. * Gets a new Vector2 with current Vector2 negated coordinates
  2611. * @returns a new Vector2
  2612. */
  2613. negate(): Vector2;
  2614. /**
  2615. * Negate this vector in place
  2616. * @returns this
  2617. */
  2618. negateInPlace(): Vector2;
  2619. /**
  2620. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  2621. * @param result defines the Vector3 object where to store the result
  2622. * @returns the current Vector2
  2623. */
  2624. negateToRef(result: Vector2): Vector2;
  2625. /**
  2626. * Multiply the Vector2 coordinates by scale
  2627. * @param scale defines the scaling factor
  2628. * @returns the current updated Vector2
  2629. */
  2630. scaleInPlace(scale: number): Vector2;
  2631. /**
  2632. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2633. * @param scale defines the scaling factor
  2634. * @returns a new Vector2
  2635. */
  2636. scale(scale: number): Vector2;
  2637. /**
  2638. * Scale the current Vector2 values by a factor to a given Vector2
  2639. * @param scale defines the scale factor
  2640. * @param result defines the Vector2 object where to store the result
  2641. * @returns the unmodified current Vector2
  2642. */
  2643. scaleToRef(scale: number, result: Vector2): Vector2;
  2644. /**
  2645. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2646. * @param scale defines the scale factor
  2647. * @param result defines the Vector2 object where to store the result
  2648. * @returns the unmodified current Vector2
  2649. */
  2650. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2651. /**
  2652. * Gets a boolean if two vectors are equals
  2653. * @param otherVector defines the other vector
  2654. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2655. */
  2656. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2657. /**
  2658. * Gets a boolean if two vectors are equals (using an epsilon value)
  2659. * @param otherVector defines the other vector
  2660. * @param epsilon defines the minimal distance to consider equality
  2661. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2662. */
  2663. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2664. /**
  2665. * Gets a new Vector2 from current Vector2 floored values
  2666. * @returns a new Vector2
  2667. */
  2668. floor(): Vector2;
  2669. /**
  2670. * Gets a new Vector2 from current Vector2 floored values
  2671. * @returns a new Vector2
  2672. */
  2673. fract(): Vector2;
  2674. /**
  2675. * Gets the length of the vector
  2676. * @returns the vector length (float)
  2677. */
  2678. length(): number;
  2679. /**
  2680. * Gets the vector squared length
  2681. * @returns the vector squared length (float)
  2682. */
  2683. lengthSquared(): number;
  2684. /**
  2685. * Normalize the vector
  2686. * @returns the current updated Vector2
  2687. */
  2688. normalize(): Vector2;
  2689. /**
  2690. * Gets a new Vector2 copied from the Vector2
  2691. * @returns a new Vector2
  2692. */
  2693. clone(): Vector2;
  2694. /**
  2695. * Gets a new Vector2(0, 0)
  2696. * @returns a new Vector2
  2697. */
  2698. static Zero(): Vector2;
  2699. /**
  2700. * Gets a new Vector2(1, 1)
  2701. * @returns a new Vector2
  2702. */
  2703. static One(): Vector2;
  2704. /**
  2705. * Gets a new Vector2 set from the given index element of the given array
  2706. * @param array defines the data source
  2707. * @param offset defines the offset in the data source
  2708. * @returns a new Vector2
  2709. */
  2710. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2711. /**
  2712. * Sets "result" from the given index element of the given array
  2713. * @param array defines the data source
  2714. * @param offset defines the offset in the data source
  2715. * @param result defines the target vector
  2716. */
  2717. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2718. /**
  2719. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2720. * @param value1 defines 1st point of control
  2721. * @param value2 defines 2nd point of control
  2722. * @param value3 defines 3rd point of control
  2723. * @param value4 defines 4th point of control
  2724. * @param amount defines the interpolation factor
  2725. * @returns a new Vector2
  2726. */
  2727. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2728. /**
  2729. * 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".
  2730. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2731. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2732. * @param value defines the value to clamp
  2733. * @param min defines the lower limit
  2734. * @param max defines the upper limit
  2735. * @returns a new Vector2
  2736. */
  2737. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2738. /**
  2739. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2740. * @param value1 defines the 1st control point
  2741. * @param tangent1 defines the outgoing tangent
  2742. * @param value2 defines the 2nd control point
  2743. * @param tangent2 defines the incoming tangent
  2744. * @param amount defines the interpolation factor
  2745. * @returns a new Vector2
  2746. */
  2747. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2748. /**
  2749. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2750. * @param start defines the start vector
  2751. * @param end defines the end vector
  2752. * @param amount defines the interpolation factor
  2753. * @returns a new Vector2
  2754. */
  2755. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2756. /**
  2757. * Gets the dot product of the vector "left" and the vector "right"
  2758. * @param left defines first vector
  2759. * @param right defines second vector
  2760. * @returns the dot product (float)
  2761. */
  2762. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2763. /**
  2764. * Returns a new Vector2 equal to the normalized given vector
  2765. * @param vector defines the vector to normalize
  2766. * @returns a new Vector2
  2767. */
  2768. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2769. /**
  2770. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2771. * @param left defines 1st vector
  2772. * @param right defines 2nd vector
  2773. * @returns a new Vector2
  2774. */
  2775. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2776. /**
  2777. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2778. * @param left defines 1st vector
  2779. * @param right defines 2nd vector
  2780. * @returns a new Vector2
  2781. */
  2782. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2783. /**
  2784. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2785. * @param vector defines the vector to transform
  2786. * @param transformation defines the matrix to apply
  2787. * @returns a new Vector2
  2788. */
  2789. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2790. /**
  2791. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2792. * @param vector defines the vector to transform
  2793. * @param transformation defines the matrix to apply
  2794. * @param result defines the target vector
  2795. */
  2796. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2797. /**
  2798. * Determines if a given vector is included in a triangle
  2799. * @param p defines the vector to test
  2800. * @param p0 defines 1st triangle point
  2801. * @param p1 defines 2nd triangle point
  2802. * @param p2 defines 3rd triangle point
  2803. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2804. */
  2805. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2806. /**
  2807. * Gets the distance between the vectors "value1" and "value2"
  2808. * @param value1 defines first vector
  2809. * @param value2 defines second vector
  2810. * @returns the distance between vectors
  2811. */
  2812. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2813. /**
  2814. * Returns the squared distance between the vectors "value1" and "value2"
  2815. * @param value1 defines first vector
  2816. * @param value2 defines second vector
  2817. * @returns the squared distance between vectors
  2818. */
  2819. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2820. /**
  2821. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2822. * @param value1 defines first vector
  2823. * @param value2 defines second vector
  2824. * @returns a new Vector2
  2825. */
  2826. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2827. /**
  2828. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2829. * @param p defines the middle point
  2830. * @param segA defines one point of the segment
  2831. * @param segB defines the other point of the segment
  2832. * @returns the shortest distance
  2833. */
  2834. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2835. }
  2836. /**
  2837. * Class used to store (x,y,z) vector representation
  2838. * A Vector3 is the main object used in 3D geometry
  2839. * It can represent etiher the coordinates of a point the space, either a direction
  2840. * Reminder: js uses a left handed forward facing system
  2841. */
  2842. export class Vector3 {
  2843. private static _UpReadOnly;
  2844. private static _ZeroReadOnly;
  2845. /** @hidden */
  2846. _x: number;
  2847. /** @hidden */
  2848. _y: number;
  2849. /** @hidden */
  2850. _z: number;
  2851. /** @hidden */
  2852. _isDirty: boolean;
  2853. /** Gets or sets the x coordinate */
  2854. get x(): number;
  2855. set x(value: number);
  2856. /** Gets or sets the y coordinate */
  2857. get y(): number;
  2858. set y(value: number);
  2859. /** Gets or sets the z coordinate */
  2860. get z(): number;
  2861. set z(value: number);
  2862. /**
  2863. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2864. * @param x defines the first coordinates (on X axis)
  2865. * @param y defines the second coordinates (on Y axis)
  2866. * @param z defines the third coordinates (on Z axis)
  2867. */
  2868. constructor(x?: number, y?: number, z?: number);
  2869. /**
  2870. * Creates a string representation of the Vector3
  2871. * @returns a string with the Vector3 coordinates.
  2872. */
  2873. toString(): string;
  2874. /**
  2875. * Gets the class name
  2876. * @returns the string "Vector3"
  2877. */
  2878. getClassName(): string;
  2879. /**
  2880. * Creates the Vector3 hash code
  2881. * @returns a number which tends to be unique between Vector3 instances
  2882. */
  2883. getHashCode(): number;
  2884. /**
  2885. * Creates an array containing three elements : the coordinates of the Vector3
  2886. * @returns a new array of numbers
  2887. */
  2888. asArray(): number[];
  2889. /**
  2890. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2891. * @param array defines the destination array
  2892. * @param index defines the offset in the destination array
  2893. * @returns the current Vector3
  2894. */
  2895. toArray(array: FloatArray, index?: number): Vector3;
  2896. /**
  2897. * Update the current vector from an array
  2898. * @param array defines the destination array
  2899. * @param index defines the offset in the destination array
  2900. * @returns the current Vector3
  2901. */
  2902. fromArray(array: FloatArray, index?: number): Vector3;
  2903. /**
  2904. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2905. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2906. */
  2907. toQuaternion(): Quaternion;
  2908. /**
  2909. * Adds the given vector to the current Vector3
  2910. * @param otherVector defines the second operand
  2911. * @returns the current updated Vector3
  2912. */
  2913. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2914. /**
  2915. * Adds the given coordinates to the current Vector3
  2916. * @param x defines the x coordinate of the operand
  2917. * @param y defines the y coordinate of the operand
  2918. * @param z defines the z coordinate of the operand
  2919. * @returns the current updated Vector3
  2920. */
  2921. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2922. /**
  2923. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2924. * @param otherVector defines the second operand
  2925. * @returns the resulting Vector3
  2926. */
  2927. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2928. /**
  2929. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2930. * @param otherVector defines the second operand
  2931. * @param result defines the Vector3 object where to store the result
  2932. * @returns the current Vector3
  2933. */
  2934. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2935. /**
  2936. * Subtract the given vector from the current Vector3
  2937. * @param otherVector defines the second operand
  2938. * @returns the current updated Vector3
  2939. */
  2940. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2941. /**
  2942. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2943. * @param otherVector defines the second operand
  2944. * @returns the resulting Vector3
  2945. */
  2946. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2947. /**
  2948. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2949. * @param otherVector defines the second operand
  2950. * @param result defines the Vector3 object where to store the result
  2951. * @returns the current Vector3
  2952. */
  2953. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2954. /**
  2955. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2956. * @param x defines the x coordinate of the operand
  2957. * @param y defines the y coordinate of the operand
  2958. * @param z defines the z coordinate of the operand
  2959. * @returns the resulting Vector3
  2960. */
  2961. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2962. /**
  2963. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2964. * @param x defines the x coordinate of the operand
  2965. * @param y defines the y coordinate of the operand
  2966. * @param z defines the z coordinate of the operand
  2967. * @param result defines the Vector3 object where to store the result
  2968. * @returns the current Vector3
  2969. */
  2970. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2971. /**
  2972. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2973. * @returns a new Vector3
  2974. */
  2975. negate(): Vector3;
  2976. /**
  2977. * Negate this vector in place
  2978. * @returns this
  2979. */
  2980. negateInPlace(): Vector3;
  2981. /**
  2982. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  2983. * @param result defines the Vector3 object where to store the result
  2984. * @returns the current Vector3
  2985. */
  2986. negateToRef(result: Vector3): Vector3;
  2987. /**
  2988. * Multiplies the Vector3 coordinates by the float "scale"
  2989. * @param scale defines the multiplier factor
  2990. * @returns the current updated Vector3
  2991. */
  2992. scaleInPlace(scale: number): Vector3;
  2993. /**
  2994. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2995. * @param scale defines the multiplier factor
  2996. * @returns a new Vector3
  2997. */
  2998. scale(scale: number): Vector3;
  2999. /**
  3000. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  3001. * @param scale defines the multiplier factor
  3002. * @param result defines the Vector3 object where to store the result
  3003. * @returns the current Vector3
  3004. */
  3005. scaleToRef(scale: number, result: Vector3): Vector3;
  3006. /**
  3007. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  3008. * @param scale defines the scale factor
  3009. * @param result defines the Vector3 object where to store the result
  3010. * @returns the unmodified current Vector3
  3011. */
  3012. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  3013. /**
  3014. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  3015. * @param origin defines the origin of the projection ray
  3016. * @param plane defines the plane to project to
  3017. * @returns the projected vector3
  3018. */
  3019. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  3020. /**
  3021. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  3022. * @param origin defines the origin of the projection ray
  3023. * @param plane defines the plane to project to
  3024. * @param result defines the Vector3 where to store the result
  3025. */
  3026. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  3027. /**
  3028. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  3029. * @param otherVector defines the second operand
  3030. * @returns true if both vectors are equals
  3031. */
  3032. equals(otherVector: DeepImmutable<Vector3>): boolean;
  3033. /**
  3034. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  3035. * @param otherVector defines the second operand
  3036. * @param epsilon defines the minimal distance to define values as equals
  3037. * @returns true if both vectors are distant less than epsilon
  3038. */
  3039. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  3040. /**
  3041. * Returns true if the current Vector3 coordinates equals the given floats
  3042. * @param x defines the x coordinate of the operand
  3043. * @param y defines the y coordinate of the operand
  3044. * @param z defines the z coordinate of the operand
  3045. * @returns true if both vectors are equals
  3046. */
  3047. equalsToFloats(x: number, y: number, z: number): boolean;
  3048. /**
  3049. * Multiplies the current Vector3 coordinates by the given ones
  3050. * @param otherVector defines the second operand
  3051. * @returns the current updated Vector3
  3052. */
  3053. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  3054. /**
  3055. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  3056. * @param otherVector defines the second operand
  3057. * @returns the new Vector3
  3058. */
  3059. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  3060. /**
  3061. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  3062. * @param otherVector defines the second operand
  3063. * @param result defines the Vector3 object where to store the result
  3064. * @returns the current Vector3
  3065. */
  3066. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  3067. /**
  3068. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  3069. * @param x defines the x coordinate of the operand
  3070. * @param y defines the y coordinate of the operand
  3071. * @param z defines the z coordinate of the operand
  3072. * @returns the new Vector3
  3073. */
  3074. multiplyByFloats(x: number, y: number, z: number): Vector3;
  3075. /**
  3076. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  3077. * @param otherVector defines the second operand
  3078. * @returns the new Vector3
  3079. */
  3080. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  3081. /**
  3082. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  3083. * @param otherVector defines the second operand
  3084. * @param result defines the Vector3 object where to store the result
  3085. * @returns the current Vector3
  3086. */
  3087. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  3088. /**
  3089. * Divides the current Vector3 coordinates by the given ones.
  3090. * @param otherVector defines the second operand
  3091. * @returns the current updated Vector3
  3092. */
  3093. divideInPlace(otherVector: Vector3): Vector3;
  3094. /**
  3095. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  3096. * @param other defines the second operand
  3097. * @returns the current updated Vector3
  3098. */
  3099. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  3100. /**
  3101. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  3102. * @param other defines the second operand
  3103. * @returns the current updated Vector3
  3104. */
  3105. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  3106. /**
  3107. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  3108. * @param x defines the x coordinate of the operand
  3109. * @param y defines the y coordinate of the operand
  3110. * @param z defines the z coordinate of the operand
  3111. * @returns the current updated Vector3
  3112. */
  3113. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  3114. /**
  3115. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  3116. * @param x defines the x coordinate of the operand
  3117. * @param y defines the y coordinate of the operand
  3118. * @param z defines the z coordinate of the operand
  3119. * @returns the current updated Vector3
  3120. */
  3121. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  3122. /**
  3123. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  3124. * Check if is non uniform within a certain amount of decimal places to account for this
  3125. * @param epsilon the amount the values can differ
  3126. * @returns if the the vector is non uniform to a certain number of decimal places
  3127. */
  3128. isNonUniformWithinEpsilon(epsilon: number): boolean;
  3129. /**
  3130. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  3131. */
  3132. get isNonUniform(): boolean;
  3133. /**
  3134. * Gets a new Vector3 from current Vector3 floored values
  3135. * @returns a new Vector3
  3136. */
  3137. floor(): Vector3;
  3138. /**
  3139. * Gets a new Vector3 from current Vector3 floored values
  3140. * @returns a new Vector3
  3141. */
  3142. fract(): Vector3;
  3143. /**
  3144. * Gets the length of the Vector3
  3145. * @returns the length of the Vector3
  3146. */
  3147. length(): number;
  3148. /**
  3149. * Gets the squared length of the Vector3
  3150. * @returns squared length of the Vector3
  3151. */
  3152. lengthSquared(): number;
  3153. /**
  3154. * Normalize the current Vector3.
  3155. * Please note that this is an in place operation.
  3156. * @returns the current updated Vector3
  3157. */
  3158. normalize(): Vector3;
  3159. /**
  3160. * Reorders the x y z properties of the vector in place
  3161. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  3162. * @returns the current updated vector
  3163. */
  3164. reorderInPlace(order: string): this;
  3165. /**
  3166. * Rotates the vector around 0,0,0 by a quaternion
  3167. * @param quaternion the rotation quaternion
  3168. * @param result vector to store the result
  3169. * @returns the resulting vector
  3170. */
  3171. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  3172. /**
  3173. * Rotates a vector around a given point
  3174. * @param quaternion the rotation quaternion
  3175. * @param point the point to rotate around
  3176. * @param result vector to store the result
  3177. * @returns the resulting vector
  3178. */
  3179. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  3180. /**
  3181. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  3182. * The cross product is then orthogonal to both current and "other"
  3183. * @param other defines the right operand
  3184. * @returns the cross product
  3185. */
  3186. cross(other: Vector3): Vector3;
  3187. /**
  3188. * Normalize the current Vector3 with the given input length.
  3189. * Please note that this is an in place operation.
  3190. * @param len the length of the vector
  3191. * @returns the current updated Vector3
  3192. */
  3193. normalizeFromLength(len: number): Vector3;
  3194. /**
  3195. * Normalize the current Vector3 to a new vector
  3196. * @returns the new Vector3
  3197. */
  3198. normalizeToNew(): Vector3;
  3199. /**
  3200. * Normalize the current Vector3 to the reference
  3201. * @param reference define the Vector3 to update
  3202. * @returns the updated Vector3
  3203. */
  3204. normalizeToRef(reference: Vector3): Vector3;
  3205. /**
  3206. * Creates a new Vector3 copied from the current Vector3
  3207. * @returns the new Vector3
  3208. */
  3209. clone(): Vector3;
  3210. /**
  3211. * Copies the given vector coordinates to the current Vector3 ones
  3212. * @param source defines the source Vector3
  3213. * @returns the current updated Vector3
  3214. */
  3215. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  3216. /**
  3217. * Copies the given floats to the current Vector3 coordinates
  3218. * @param x defines the x coordinate of the operand
  3219. * @param y defines the y coordinate of the operand
  3220. * @param z defines the z coordinate of the operand
  3221. * @returns the current updated Vector3
  3222. */
  3223. copyFromFloats(x: number, y: number, z: number): Vector3;
  3224. /**
  3225. * Copies the given floats to the current Vector3 coordinates
  3226. * @param x defines the x coordinate of the operand
  3227. * @param y defines the y coordinate of the operand
  3228. * @param z defines the z coordinate of the operand
  3229. * @returns the current updated Vector3
  3230. */
  3231. set(x: number, y: number, z: number): Vector3;
  3232. /**
  3233. * Copies the given float to the current Vector3 coordinates
  3234. * @param v defines the x, y and z coordinates of the operand
  3235. * @returns the current updated Vector3
  3236. */
  3237. setAll(v: number): Vector3;
  3238. /**
  3239. * Get the clip factor between two vectors
  3240. * @param vector0 defines the first operand
  3241. * @param vector1 defines the second operand
  3242. * @param axis defines the axis to use
  3243. * @param size defines the size along the axis
  3244. * @returns the clip factor
  3245. */
  3246. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  3247. /**
  3248. * Get angle between two vectors
  3249. * @param vector0 angle between vector0 and vector1
  3250. * @param vector1 angle between vector0 and vector1
  3251. * @param normal direction of the normal
  3252. * @return the angle between vector0 and vector1
  3253. */
  3254. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  3255. /**
  3256. * Returns a new Vector3 set from the index "offset" of the given array
  3257. * @param array defines the source array
  3258. * @param offset defines the offset in the source array
  3259. * @returns the new Vector3
  3260. */
  3261. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  3262. /**
  3263. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  3264. * @param array defines the source array
  3265. * @param offset defines the offset in the source array
  3266. * @returns the new Vector3
  3267. * @deprecated Please use FromArray instead.
  3268. */
  3269. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  3270. /**
  3271. * Sets the given vector "result" with the element values from the index "offset" of the given array
  3272. * @param array defines the source array
  3273. * @param offset defines the offset in the source array
  3274. * @param result defines the Vector3 where to store the result
  3275. */
  3276. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  3277. /**
  3278. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  3279. * @param array defines the source array
  3280. * @param offset defines the offset in the source array
  3281. * @param result defines the Vector3 where to store the result
  3282. * @deprecated Please use FromArrayToRef instead.
  3283. */
  3284. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  3285. /**
  3286. * Sets the given vector "result" with the given floats.
  3287. * @param x defines the x coordinate of the source
  3288. * @param y defines the y coordinate of the source
  3289. * @param z defines the z coordinate of the source
  3290. * @param result defines the Vector3 where to store the result
  3291. */
  3292. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  3293. /**
  3294. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  3295. * @returns a new empty Vector3
  3296. */
  3297. static Zero(): Vector3;
  3298. /**
  3299. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  3300. * @returns a new unit Vector3
  3301. */
  3302. static One(): Vector3;
  3303. /**
  3304. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  3305. * @returns a new up Vector3
  3306. */
  3307. static Up(): Vector3;
  3308. /**
  3309. * Gets a up Vector3 that must not be updated
  3310. */
  3311. static get UpReadOnly(): DeepImmutable<Vector3>;
  3312. /**
  3313. * Gets a zero Vector3 that must not be updated
  3314. */
  3315. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  3316. /**
  3317. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  3318. * @returns a new down Vector3
  3319. */
  3320. static Down(): Vector3;
  3321. /**
  3322. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  3323. * @param rightHandedSystem is the scene right-handed (negative z)
  3324. * @returns a new forward Vector3
  3325. */
  3326. static Forward(rightHandedSystem?: boolean): Vector3;
  3327. /**
  3328. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  3329. * @param rightHandedSystem is the scene right-handed (negative-z)
  3330. * @returns a new forward Vector3
  3331. */
  3332. static Backward(rightHandedSystem?: boolean): Vector3;
  3333. /**
  3334. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  3335. * @returns a new right Vector3
  3336. */
  3337. static Right(): Vector3;
  3338. /**
  3339. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  3340. * @returns a new left Vector3
  3341. */
  3342. static Left(): Vector3;
  3343. /**
  3344. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  3345. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  3346. * @param vector defines the Vector3 to transform
  3347. * @param transformation defines the transformation matrix
  3348. * @returns the transformed Vector3
  3349. */
  3350. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3351. /**
  3352. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  3353. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  3354. * @param vector defines the Vector3 to transform
  3355. * @param transformation defines the transformation matrix
  3356. * @param result defines the Vector3 where to store the result
  3357. */
  3358. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3359. /**
  3360. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  3361. * This method computes tranformed coordinates only, not transformed direction vectors
  3362. * @param x define the x coordinate of the source vector
  3363. * @param y define the y coordinate of the source vector
  3364. * @param z define the z coordinate of the source vector
  3365. * @param transformation defines the transformation matrix
  3366. * @param result defines the Vector3 where to store the result
  3367. */
  3368. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3369. /**
  3370. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  3371. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3372. * @param vector defines the Vector3 to transform
  3373. * @param transformation defines the transformation matrix
  3374. * @returns the new Vector3
  3375. */
  3376. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3377. /**
  3378. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  3379. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3380. * @param vector defines the Vector3 to transform
  3381. * @param transformation defines the transformation matrix
  3382. * @param result defines the Vector3 where to store the result
  3383. */
  3384. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3385. /**
  3386. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  3387. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3388. * @param x define the x coordinate of the source vector
  3389. * @param y define the y coordinate of the source vector
  3390. * @param z define the z coordinate of the source vector
  3391. * @param transformation defines the transformation matrix
  3392. * @param result defines the Vector3 where to store the result
  3393. */
  3394. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3395. /**
  3396. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  3397. * @param value1 defines the first control point
  3398. * @param value2 defines the second control point
  3399. * @param value3 defines the third control point
  3400. * @param value4 defines the fourth control point
  3401. * @param amount defines the amount on the spline to use
  3402. * @returns the new Vector3
  3403. */
  3404. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  3405. /**
  3406. * 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"
  3407. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3408. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3409. * @param value defines the current value
  3410. * @param min defines the lower range value
  3411. * @param max defines the upper range value
  3412. * @returns the new Vector3
  3413. */
  3414. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  3415. /**
  3416. * 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"
  3417. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3418. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3419. * @param value defines the current value
  3420. * @param min defines the lower range value
  3421. * @param max defines the upper range value
  3422. * @param result defines the Vector3 where to store the result
  3423. */
  3424. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  3425. /**
  3426. * Checks if a given vector is inside a specific range
  3427. * @param v defines the vector to test
  3428. * @param min defines the minimum range
  3429. * @param max defines the maximum range
  3430. */
  3431. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  3432. /**
  3433. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  3434. * @param value1 defines the first control point
  3435. * @param tangent1 defines the first tangent vector
  3436. * @param value2 defines the second control point
  3437. * @param tangent2 defines the second tangent vector
  3438. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  3439. * @returns the new Vector3
  3440. */
  3441. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  3442. /**
  3443. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  3444. * @param start defines the start value
  3445. * @param end defines the end value
  3446. * @param amount max defines amount between both (between 0 and 1)
  3447. * @returns the new Vector3
  3448. */
  3449. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  3450. /**
  3451. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  3452. * @param start defines the start value
  3453. * @param end defines the end value
  3454. * @param amount max defines amount between both (between 0 and 1)
  3455. * @param result defines the Vector3 where to store the result
  3456. */
  3457. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  3458. /**
  3459. * Returns the dot product (float) between the vectors "left" and "right"
  3460. * @param left defines the left operand
  3461. * @param right defines the right operand
  3462. * @returns the dot product
  3463. */
  3464. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  3465. /**
  3466. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  3467. * The cross product is then orthogonal to both "left" and "right"
  3468. * @param left defines the left operand
  3469. * @param right defines the right operand
  3470. * @returns the cross product
  3471. */
  3472. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3473. /**
  3474. * Sets the given vector "result" with the cross product of "left" and "right"
  3475. * The cross product is then orthogonal to both "left" and "right"
  3476. * @param left defines the left operand
  3477. * @param right defines the right operand
  3478. * @param result defines the Vector3 where to store the result
  3479. */
  3480. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  3481. /**
  3482. * Returns a new Vector3 as the normalization of the given vector
  3483. * @param vector defines the Vector3 to normalize
  3484. * @returns the new Vector3
  3485. */
  3486. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  3487. /**
  3488. * Sets the given vector "result" with the normalization of the given first vector
  3489. * @param vector defines the Vector3 to normalize
  3490. * @param result defines the Vector3 where to store the result
  3491. */
  3492. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  3493. /**
  3494. * Project a Vector3 onto screen space
  3495. * @param vector defines the Vector3 to project
  3496. * @param world defines the world matrix to use
  3497. * @param transform defines the transform (view x projection) matrix to use
  3498. * @param viewport defines the screen viewport to use
  3499. * @returns the new Vector3
  3500. */
  3501. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  3502. /**
  3503. * Project a Vector3 onto screen space to reference
  3504. * @param vector defines the Vector3 to project
  3505. * @param world defines the world matrix to use
  3506. * @param transform defines the transform (view x projection) matrix to use
  3507. * @param viewport defines the screen viewport to use
  3508. * @param result the vector in which the screen space will be stored
  3509. * @returns the new Vector3
  3510. */
  3511. static ProjectToRef(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>, result: DeepImmutable<Vector3>): Vector3;
  3512. /** @hidden */
  3513. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  3514. /**
  3515. * Unproject from screen space to object space
  3516. * @param source defines the screen space Vector3 to use
  3517. * @param viewportWidth defines the current width of the viewport
  3518. * @param viewportHeight defines the current height of the viewport
  3519. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3520. * @param transform defines the transform (view x projection) matrix to use
  3521. * @returns the new Vector3
  3522. */
  3523. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  3524. /**
  3525. * Unproject from screen space to object space
  3526. * @param source defines the screen space Vector3 to use
  3527. * @param viewportWidth defines the current width of the viewport
  3528. * @param viewportHeight defines the current height of the viewport
  3529. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3530. * @param view defines the view matrix to use
  3531. * @param projection defines the projection matrix to use
  3532. * @returns the new Vector3
  3533. */
  3534. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  3535. /**
  3536. * Unproject from screen space to object space
  3537. * @param source defines the screen space Vector3 to use
  3538. * @param viewportWidth defines the current width of the viewport
  3539. * @param viewportHeight defines the current height of the viewport
  3540. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3541. * @param view defines the view matrix to use
  3542. * @param projection defines the projection matrix to use
  3543. * @param result defines the Vector3 where to store the result
  3544. */
  3545. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3546. /**
  3547. * Unproject from screen space to object space
  3548. * @param sourceX defines the screen space x coordinate to use
  3549. * @param sourceY defines the screen space y coordinate to use
  3550. * @param sourceZ defines the screen space z coordinate to use
  3551. * @param viewportWidth defines the current width of the viewport
  3552. * @param viewportHeight defines the current height of the viewport
  3553. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3554. * @param view defines the view matrix to use
  3555. * @param projection defines the projection matrix to use
  3556. * @param result defines the Vector3 where to store the result
  3557. */
  3558. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3559. /**
  3560. * Gets the minimal coordinate values between two Vector3
  3561. * @param left defines the first operand
  3562. * @param right defines the second operand
  3563. * @returns the new Vector3
  3564. */
  3565. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3566. /**
  3567. * Gets the maximal coordinate values between two Vector3
  3568. * @param left defines the first operand
  3569. * @param right defines the second operand
  3570. * @returns the new Vector3
  3571. */
  3572. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3573. /**
  3574. * Returns the distance between the vectors "value1" and "value2"
  3575. * @param value1 defines the first operand
  3576. * @param value2 defines the second operand
  3577. * @returns the distance
  3578. */
  3579. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3580. /**
  3581. * Returns the squared distance between the vectors "value1" and "value2"
  3582. * @param value1 defines the first operand
  3583. * @param value2 defines the second operand
  3584. * @returns the squared distance
  3585. */
  3586. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3587. /**
  3588. * Returns a new Vector3 located at the center between "value1" and "value2"
  3589. * @param value1 defines the first operand
  3590. * @param value2 defines the second operand
  3591. * @returns the new Vector3
  3592. */
  3593. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3594. /**
  3595. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3596. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3597. * to something in order to rotate it from its local system to the given target system
  3598. * Note: axis1, axis2 and axis3 are normalized during this operation
  3599. * @param axis1 defines the first axis
  3600. * @param axis2 defines the second axis
  3601. * @param axis3 defines the third axis
  3602. * @returns a new Vector3
  3603. */
  3604. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3605. /**
  3606. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3607. * @param axis1 defines the first axis
  3608. * @param axis2 defines the second axis
  3609. * @param axis3 defines the third axis
  3610. * @param ref defines the Vector3 where to store the result
  3611. */
  3612. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3613. }
  3614. /**
  3615. * Vector4 class created for EulerAngle class conversion to Quaternion
  3616. */
  3617. export class Vector4 {
  3618. /** x value of the vector */
  3619. x: number;
  3620. /** y value of the vector */
  3621. y: number;
  3622. /** z value of the vector */
  3623. z: number;
  3624. /** w value of the vector */
  3625. w: number;
  3626. /**
  3627. * Creates a Vector4 object from the given floats.
  3628. * @param x x value of the vector
  3629. * @param y y value of the vector
  3630. * @param z z value of the vector
  3631. * @param w w value of the vector
  3632. */
  3633. constructor(
  3634. /** x value of the vector */
  3635. x: number,
  3636. /** y value of the vector */
  3637. y: number,
  3638. /** z value of the vector */
  3639. z: number,
  3640. /** w value of the vector */
  3641. w: number);
  3642. /**
  3643. * Returns the string with the Vector4 coordinates.
  3644. * @returns a string containing all the vector values
  3645. */
  3646. toString(): string;
  3647. /**
  3648. * Returns the string "Vector4".
  3649. * @returns "Vector4"
  3650. */
  3651. getClassName(): string;
  3652. /**
  3653. * Returns the Vector4 hash code.
  3654. * @returns a unique hash code
  3655. */
  3656. getHashCode(): number;
  3657. /**
  3658. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3659. * @returns the resulting array
  3660. */
  3661. asArray(): number[];
  3662. /**
  3663. * Populates the given array from the given index with the Vector4 coordinates.
  3664. * @param array array to populate
  3665. * @param index index of the array to start at (default: 0)
  3666. * @returns the Vector4.
  3667. */
  3668. toArray(array: FloatArray, index?: number): Vector4;
  3669. /**
  3670. * Update the current vector from an array
  3671. * @param array defines the destination array
  3672. * @param index defines the offset in the destination array
  3673. * @returns the current Vector3
  3674. */
  3675. fromArray(array: FloatArray, index?: number): Vector4;
  3676. /**
  3677. * Adds the given vector to the current Vector4.
  3678. * @param otherVector the vector to add
  3679. * @returns the updated Vector4.
  3680. */
  3681. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3682. /**
  3683. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3684. * @param otherVector the vector to add
  3685. * @returns the resulting vector
  3686. */
  3687. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3688. /**
  3689. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3690. * @param otherVector the vector to add
  3691. * @param result the vector to store the result
  3692. * @returns the current Vector4.
  3693. */
  3694. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3695. /**
  3696. * Subtract in place the given vector from the current Vector4.
  3697. * @param otherVector the vector to subtract
  3698. * @returns the updated Vector4.
  3699. */
  3700. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3701. /**
  3702. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3703. * @param otherVector the vector to add
  3704. * @returns the new vector with the result
  3705. */
  3706. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3707. /**
  3708. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3709. * @param otherVector the vector to subtract
  3710. * @param result the vector to store the result
  3711. * @returns the current Vector4.
  3712. */
  3713. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3714. /**
  3715. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3716. */
  3717. /**
  3718. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3719. * @param x value to subtract
  3720. * @param y value to subtract
  3721. * @param z value to subtract
  3722. * @param w value to subtract
  3723. * @returns new vector containing the result
  3724. */
  3725. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3726. /**
  3727. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3728. * @param x value to subtract
  3729. * @param y value to subtract
  3730. * @param z value to subtract
  3731. * @param w value to subtract
  3732. * @param result the vector to store the result in
  3733. * @returns the current Vector4.
  3734. */
  3735. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3736. /**
  3737. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3738. * @returns a new vector with the negated values
  3739. */
  3740. negate(): Vector4;
  3741. /**
  3742. * Negate this vector in place
  3743. * @returns this
  3744. */
  3745. negateInPlace(): Vector4;
  3746. /**
  3747. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  3748. * @param result defines the Vector3 object where to store the result
  3749. * @returns the current Vector4
  3750. */
  3751. negateToRef(result: Vector4): Vector4;
  3752. /**
  3753. * Multiplies the current Vector4 coordinates by scale (float).
  3754. * @param scale the number to scale with
  3755. * @returns the updated Vector4.
  3756. */
  3757. scaleInPlace(scale: number): Vector4;
  3758. /**
  3759. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3760. * @param scale the number to scale with
  3761. * @returns a new vector with the result
  3762. */
  3763. scale(scale: number): Vector4;
  3764. /**
  3765. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3766. * @param scale the number to scale with
  3767. * @param result a vector to store the result in
  3768. * @returns the current Vector4.
  3769. */
  3770. scaleToRef(scale: number, result: Vector4): Vector4;
  3771. /**
  3772. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3773. * @param scale defines the scale factor
  3774. * @param result defines the Vector4 object where to store the result
  3775. * @returns the unmodified current Vector4
  3776. */
  3777. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3778. /**
  3779. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3780. * @param otherVector the vector to compare against
  3781. * @returns true if they are equal
  3782. */
  3783. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3784. /**
  3785. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3786. * @param otherVector vector to compare against
  3787. * @param epsilon (Default: very small number)
  3788. * @returns true if they are equal
  3789. */
  3790. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3791. /**
  3792. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3793. * @param x x value to compare against
  3794. * @param y y value to compare against
  3795. * @param z z value to compare against
  3796. * @param w w value to compare against
  3797. * @returns true if equal
  3798. */
  3799. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3800. /**
  3801. * Multiplies in place the current Vector4 by the given one.
  3802. * @param otherVector vector to multiple with
  3803. * @returns the updated Vector4.
  3804. */
  3805. multiplyInPlace(otherVector: Vector4): Vector4;
  3806. /**
  3807. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3808. * @param otherVector vector to multiple with
  3809. * @returns resulting new vector
  3810. */
  3811. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3812. /**
  3813. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3814. * @param otherVector vector to multiple with
  3815. * @param result vector to store the result
  3816. * @returns the current Vector4.
  3817. */
  3818. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3819. /**
  3820. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3821. * @param x x value multiply with
  3822. * @param y y value multiply with
  3823. * @param z z value multiply with
  3824. * @param w w value multiply with
  3825. * @returns resulting new vector
  3826. */
  3827. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3828. /**
  3829. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3830. * @param otherVector vector to devide with
  3831. * @returns resulting new vector
  3832. */
  3833. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3834. /**
  3835. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3836. * @param otherVector vector to devide with
  3837. * @param result vector to store the result
  3838. * @returns the current Vector4.
  3839. */
  3840. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3841. /**
  3842. * Divides the current Vector3 coordinates by the given ones.
  3843. * @param otherVector vector to devide with
  3844. * @returns the updated Vector3.
  3845. */
  3846. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3847. /**
  3848. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3849. * @param other defines the second operand
  3850. * @returns the current updated Vector4
  3851. */
  3852. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3853. /**
  3854. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3855. * @param other defines the second operand
  3856. * @returns the current updated Vector4
  3857. */
  3858. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3859. /**
  3860. * Gets a new Vector4 from current Vector4 floored values
  3861. * @returns a new Vector4
  3862. */
  3863. floor(): Vector4;
  3864. /**
  3865. * Gets a new Vector4 from current Vector3 floored values
  3866. * @returns a new Vector4
  3867. */
  3868. fract(): Vector4;
  3869. /**
  3870. * Returns the Vector4 length (float).
  3871. * @returns the length
  3872. */
  3873. length(): number;
  3874. /**
  3875. * Returns the Vector4 squared length (float).
  3876. * @returns the length squared
  3877. */
  3878. lengthSquared(): number;
  3879. /**
  3880. * Normalizes in place the Vector4.
  3881. * @returns the updated Vector4.
  3882. */
  3883. normalize(): Vector4;
  3884. /**
  3885. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3886. * @returns this converted to a new vector3
  3887. */
  3888. toVector3(): Vector3;
  3889. /**
  3890. * Returns a new Vector4 copied from the current one.
  3891. * @returns the new cloned vector
  3892. */
  3893. clone(): Vector4;
  3894. /**
  3895. * Updates the current Vector4 with the given one coordinates.
  3896. * @param source the source vector to copy from
  3897. * @returns the updated Vector4.
  3898. */
  3899. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3900. /**
  3901. * Updates the current Vector4 coordinates with the given floats.
  3902. * @param x float to copy from
  3903. * @param y float to copy from
  3904. * @param z float to copy from
  3905. * @param w float to copy from
  3906. * @returns the updated Vector4.
  3907. */
  3908. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3909. /**
  3910. * Updates the current Vector4 coordinates with the given floats.
  3911. * @param x float to set from
  3912. * @param y float to set from
  3913. * @param z float to set from
  3914. * @param w float to set from
  3915. * @returns the updated Vector4.
  3916. */
  3917. set(x: number, y: number, z: number, w: number): Vector4;
  3918. /**
  3919. * Copies the given float to the current Vector3 coordinates
  3920. * @param v defines the x, y, z and w coordinates of the operand
  3921. * @returns the current updated Vector3
  3922. */
  3923. setAll(v: number): Vector4;
  3924. /**
  3925. * Returns a new Vector4 set from the starting index of the given array.
  3926. * @param array the array to pull values from
  3927. * @param offset the offset into the array to start at
  3928. * @returns the new vector
  3929. */
  3930. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3931. /**
  3932. * Updates the given vector "result" from the starting index of the given array.
  3933. * @param array the array to pull values from
  3934. * @param offset the offset into the array to start at
  3935. * @param result the vector to store the result in
  3936. */
  3937. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3938. /**
  3939. * Updates the given vector "result" from the starting index of the given Float32Array.
  3940. * @param array the array to pull values from
  3941. * @param offset the offset into the array to start at
  3942. * @param result the vector to store the result in
  3943. */
  3944. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3945. /**
  3946. * Updates the given vector "result" coordinates from the given floats.
  3947. * @param x float to set from
  3948. * @param y float to set from
  3949. * @param z float to set from
  3950. * @param w float to set from
  3951. * @param result the vector to the floats in
  3952. */
  3953. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3954. /**
  3955. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3956. * @returns the new vector
  3957. */
  3958. static Zero(): Vector4;
  3959. /**
  3960. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3961. * @returns the new vector
  3962. */
  3963. static One(): Vector4;
  3964. /**
  3965. * Returns a new normalized Vector4 from the given one.
  3966. * @param vector the vector to normalize
  3967. * @returns the vector
  3968. */
  3969. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3970. /**
  3971. * Updates the given vector "result" from the normalization of the given one.
  3972. * @param vector the vector to normalize
  3973. * @param result the vector to store the result in
  3974. */
  3975. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3976. /**
  3977. * Returns a vector with the minimum values from the left and right vectors
  3978. * @param left left vector to minimize
  3979. * @param right right vector to minimize
  3980. * @returns a new vector with the minimum of the left and right vector values
  3981. */
  3982. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3983. /**
  3984. * Returns a vector with the maximum values from the left and right vectors
  3985. * @param left left vector to maximize
  3986. * @param right right vector to maximize
  3987. * @returns a new vector with the maximum of the left and right vector values
  3988. */
  3989. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3990. /**
  3991. * Returns the distance (float) between the vectors "value1" and "value2".
  3992. * @param value1 value to calulate the distance between
  3993. * @param value2 value to calulate the distance between
  3994. * @return the distance between the two vectors
  3995. */
  3996. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3997. /**
  3998. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3999. * @param value1 value to calulate the distance between
  4000. * @param value2 value to calulate the distance between
  4001. * @return the distance between the two vectors squared
  4002. */
  4003. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  4004. /**
  4005. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  4006. * @param value1 value to calulate the center between
  4007. * @param value2 value to calulate the center between
  4008. * @return the center between the two vectors
  4009. */
  4010. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  4011. /**
  4012. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  4013. * This methods computes transformed normalized direction vectors only.
  4014. * @param vector the vector to transform
  4015. * @param transformation the transformation matrix to apply
  4016. * @returns the new vector
  4017. */
  4018. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  4019. /**
  4020. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  4021. * This methods computes transformed normalized direction vectors only.
  4022. * @param vector the vector to transform
  4023. * @param transformation the transformation matrix to apply
  4024. * @param result the vector to store the result in
  4025. */
  4026. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  4027. /**
  4028. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  4029. * This methods computes transformed normalized direction vectors only.
  4030. * @param x value to transform
  4031. * @param y value to transform
  4032. * @param z value to transform
  4033. * @param w value to transform
  4034. * @param transformation the transformation matrix to apply
  4035. * @param result the vector to store the results in
  4036. */
  4037. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  4038. /**
  4039. * Creates a new Vector4 from a Vector3
  4040. * @param source defines the source data
  4041. * @param w defines the 4th component (default is 0)
  4042. * @returns a new Vector4
  4043. */
  4044. static FromVector3(source: Vector3, w?: number): Vector4;
  4045. }
  4046. /**
  4047. * Class used to store quaternion data
  4048. * @see https://en.wikipedia.org/wiki/Quaternion
  4049. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  4050. */
  4051. export class Quaternion {
  4052. /** @hidden */
  4053. _x: number;
  4054. /** @hidden */
  4055. _y: number;
  4056. /** @hidden */
  4057. _z: number;
  4058. /** @hidden */
  4059. _w: number;
  4060. /** @hidden */
  4061. _isDirty: boolean;
  4062. /** Gets or sets the x coordinate */
  4063. get x(): number;
  4064. set x(value: number);
  4065. /** Gets or sets the y coordinate */
  4066. get y(): number;
  4067. set y(value: number);
  4068. /** Gets or sets the z coordinate */
  4069. get z(): number;
  4070. set z(value: number);
  4071. /** Gets or sets the w coordinate */
  4072. get w(): number;
  4073. set w(value: number);
  4074. /**
  4075. * Creates a new Quaternion from the given floats
  4076. * @param x defines the first component (0 by default)
  4077. * @param y defines the second component (0 by default)
  4078. * @param z defines the third component (0 by default)
  4079. * @param w defines the fourth component (1.0 by default)
  4080. */
  4081. constructor(x?: number, y?: number, z?: number, w?: number);
  4082. /**
  4083. * Gets a string representation for the current quaternion
  4084. * @returns a string with the Quaternion coordinates
  4085. */
  4086. toString(): string;
  4087. /**
  4088. * Gets the class name of the quaternion
  4089. * @returns the string "Quaternion"
  4090. */
  4091. getClassName(): string;
  4092. /**
  4093. * Gets a hash code for this quaternion
  4094. * @returns the quaternion hash code
  4095. */
  4096. getHashCode(): number;
  4097. /**
  4098. * Copy the quaternion to an array
  4099. * @returns a new array populated with 4 elements from the quaternion coordinates
  4100. */
  4101. asArray(): number[];
  4102. /**
  4103. * Check if two quaternions are equals
  4104. * @param otherQuaternion defines the second operand
  4105. * @return true if the current quaternion and the given one coordinates are strictly equals
  4106. */
  4107. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  4108. /**
  4109. * Gets a boolean if two quaternions are equals (using an epsilon value)
  4110. * @param otherQuaternion defines the other quaternion
  4111. * @param epsilon defines the minimal distance to consider equality
  4112. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  4113. */
  4114. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  4115. /**
  4116. * Clone the current quaternion
  4117. * @returns a new quaternion copied from the current one
  4118. */
  4119. clone(): Quaternion;
  4120. /**
  4121. * Copy a quaternion to the current one
  4122. * @param other defines the other quaternion
  4123. * @returns the updated current quaternion
  4124. */
  4125. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  4126. /**
  4127. * Updates the current quaternion with the given float coordinates
  4128. * @param x defines the x coordinate
  4129. * @param y defines the y coordinate
  4130. * @param z defines the z coordinate
  4131. * @param w defines the w coordinate
  4132. * @returns the updated current quaternion
  4133. */
  4134. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  4135. /**
  4136. * Updates the current quaternion from the given float coordinates
  4137. * @param x defines the x coordinate
  4138. * @param y defines the y coordinate
  4139. * @param z defines the z coordinate
  4140. * @param w defines the w coordinate
  4141. * @returns the updated current quaternion
  4142. */
  4143. set(x: number, y: number, z: number, w: number): Quaternion;
  4144. /**
  4145. * Adds two quaternions
  4146. * @param other defines the second operand
  4147. * @returns a new quaternion as the addition result of the given one and the current quaternion
  4148. */
  4149. add(other: DeepImmutable<Quaternion>): Quaternion;
  4150. /**
  4151. * Add a quaternion to the current one
  4152. * @param other defines the quaternion to add
  4153. * @returns the current quaternion
  4154. */
  4155. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  4156. /**
  4157. * Subtract two quaternions
  4158. * @param other defines the second operand
  4159. * @returns a new quaternion as the subtraction result of the given one from the current one
  4160. */
  4161. subtract(other: Quaternion): Quaternion;
  4162. /**
  4163. * Multiplies the current quaternion by a scale factor
  4164. * @param value defines the scale factor
  4165. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  4166. */
  4167. scale(value: number): Quaternion;
  4168. /**
  4169. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  4170. * @param scale defines the scale factor
  4171. * @param result defines the Quaternion object where to store the result
  4172. * @returns the unmodified current quaternion
  4173. */
  4174. scaleToRef(scale: number, result: Quaternion): Quaternion;
  4175. /**
  4176. * Multiplies in place the current quaternion by a scale factor
  4177. * @param value defines the scale factor
  4178. * @returns the current modified quaternion
  4179. */
  4180. scaleInPlace(value: number): Quaternion;
  4181. /**
  4182. * Scale the current quaternion values by a factor and add the result to a given quaternion
  4183. * @param scale defines the scale factor
  4184. * @param result defines the Quaternion object where to store the result
  4185. * @returns the unmodified current quaternion
  4186. */
  4187. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  4188. /**
  4189. * Multiplies two quaternions
  4190. * @param q1 defines the second operand
  4191. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  4192. */
  4193. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  4194. /**
  4195. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  4196. * @param q1 defines the second operand
  4197. * @param result defines the target quaternion
  4198. * @returns the current quaternion
  4199. */
  4200. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  4201. /**
  4202. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  4203. * @param q1 defines the second operand
  4204. * @returns the currentupdated quaternion
  4205. */
  4206. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  4207. /**
  4208. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  4209. * @param ref defines the target quaternion
  4210. * @returns the current quaternion
  4211. */
  4212. conjugateToRef(ref: Quaternion): Quaternion;
  4213. /**
  4214. * Conjugates in place (1-q) the current quaternion
  4215. * @returns the current updated quaternion
  4216. */
  4217. conjugateInPlace(): Quaternion;
  4218. /**
  4219. * Conjugates in place (1-q) the current quaternion
  4220. * @returns a new quaternion
  4221. */
  4222. conjugate(): Quaternion;
  4223. /**
  4224. * Gets length of current quaternion
  4225. * @returns the quaternion length (float)
  4226. */
  4227. length(): number;
  4228. /**
  4229. * Normalize in place the current quaternion
  4230. * @returns the current updated quaternion
  4231. */
  4232. normalize(): Quaternion;
  4233. /**
  4234. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  4235. * @param order is a reserved parameter and is ignored for now
  4236. * @returns a new Vector3 containing the Euler angles
  4237. */
  4238. toEulerAngles(order?: string): Vector3;
  4239. /**
  4240. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  4241. * @param result defines the vector which will be filled with the Euler angles
  4242. * @returns the current unchanged quaternion
  4243. */
  4244. toEulerAnglesToRef(result: Vector3): Quaternion;
  4245. /**
  4246. * Updates the given rotation matrix with the current quaternion values
  4247. * @param result defines the target matrix
  4248. * @returns the current unchanged quaternion
  4249. */
  4250. toRotationMatrix(result: Matrix): Quaternion;
  4251. /**
  4252. * Updates the current quaternion from the given rotation matrix values
  4253. * @param matrix defines the source matrix
  4254. * @returns the current updated quaternion
  4255. */
  4256. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  4257. /**
  4258. * Creates a new quaternion from a rotation matrix
  4259. * @param matrix defines the source matrix
  4260. * @returns a new quaternion created from the given rotation matrix values
  4261. */
  4262. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  4263. /**
  4264. * Updates the given quaternion with the given rotation matrix values
  4265. * @param matrix defines the source matrix
  4266. * @param result defines the target quaternion
  4267. */
  4268. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  4269. /**
  4270. * Returns the dot product (float) between the quaternions "left" and "right"
  4271. * @param left defines the left operand
  4272. * @param right defines the right operand
  4273. * @returns the dot product
  4274. */
  4275. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  4276. /**
  4277. * Checks if the two quaternions are close to each other
  4278. * @param quat0 defines the first quaternion to check
  4279. * @param quat1 defines the second quaternion to check
  4280. * @returns true if the two quaternions are close to each other
  4281. */
  4282. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  4283. /**
  4284. * Creates an empty quaternion
  4285. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  4286. */
  4287. static Zero(): Quaternion;
  4288. /**
  4289. * Inverse a given quaternion
  4290. * @param q defines the source quaternion
  4291. * @returns a new quaternion as the inverted current quaternion
  4292. */
  4293. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  4294. /**
  4295. * Inverse a given quaternion
  4296. * @param q defines the source quaternion
  4297. * @param result the quaternion the result will be stored in
  4298. * @returns the result quaternion
  4299. */
  4300. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  4301. /**
  4302. * Creates an identity quaternion
  4303. * @returns the identity quaternion
  4304. */
  4305. static Identity(): Quaternion;
  4306. /**
  4307. * Gets a boolean indicating if the given quaternion is identity
  4308. * @param quaternion defines the quaternion to check
  4309. * @returns true if the quaternion is identity
  4310. */
  4311. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  4312. /**
  4313. * Creates a quaternion from a rotation around an axis
  4314. * @param axis defines the axis to use
  4315. * @param angle defines the angle to use
  4316. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  4317. */
  4318. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  4319. /**
  4320. * Creates a rotation around an axis and stores it into the given quaternion
  4321. * @param axis defines the axis to use
  4322. * @param angle defines the angle to use
  4323. * @param result defines the target quaternion
  4324. * @returns the target quaternion
  4325. */
  4326. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  4327. /**
  4328. * Creates a new quaternion from data stored into an array
  4329. * @param array defines the data source
  4330. * @param offset defines the offset in the source array where the data starts
  4331. * @returns a new quaternion
  4332. */
  4333. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  4334. /**
  4335. * Updates the given quaternion "result" from the starting index of the given array.
  4336. * @param array the array to pull values from
  4337. * @param offset the offset into the array to start at
  4338. * @param result the quaternion to store the result in
  4339. */
  4340. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  4341. /**
  4342. * Create a quaternion from Euler rotation angles
  4343. * @param x Pitch
  4344. * @param y Yaw
  4345. * @param z Roll
  4346. * @returns the new Quaternion
  4347. */
  4348. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  4349. /**
  4350. * Updates a quaternion from Euler rotation angles
  4351. * @param x Pitch
  4352. * @param y Yaw
  4353. * @param z Roll
  4354. * @param result the quaternion to store the result
  4355. * @returns the updated quaternion
  4356. */
  4357. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  4358. /**
  4359. * Create a quaternion from Euler rotation vector
  4360. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  4361. * @returns the new Quaternion
  4362. */
  4363. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  4364. /**
  4365. * Updates a quaternion from Euler rotation vector
  4366. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  4367. * @param result the quaternion to store the result
  4368. * @returns the updated quaternion
  4369. */
  4370. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  4371. /**
  4372. * Creates a new quaternion from the given Euler float angles (y, x, z)
  4373. * @param yaw defines the rotation around Y axis
  4374. * @param pitch defines the rotation around X axis
  4375. * @param roll defines the rotation around Z axis
  4376. * @returns the new quaternion
  4377. */
  4378. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  4379. /**
  4380. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  4381. * @param yaw defines the rotation around Y axis
  4382. * @param pitch defines the rotation around X axis
  4383. * @param roll defines the rotation around Z axis
  4384. * @param result defines the target quaternion
  4385. */
  4386. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  4387. /**
  4388. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  4389. * @param alpha defines the rotation around first axis
  4390. * @param beta defines the rotation around second axis
  4391. * @param gamma defines the rotation around third axis
  4392. * @returns the new quaternion
  4393. */
  4394. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  4395. /**
  4396. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  4397. * @param alpha defines the rotation around first axis
  4398. * @param beta defines the rotation around second axis
  4399. * @param gamma defines the rotation around third axis
  4400. * @param result defines the target quaternion
  4401. */
  4402. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  4403. /**
  4404. * 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)
  4405. * @param axis1 defines the first axis
  4406. * @param axis2 defines the second axis
  4407. * @param axis3 defines the third axis
  4408. * @returns the new quaternion
  4409. */
  4410. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  4411. /**
  4412. * 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
  4413. * @param axis1 defines the first axis
  4414. * @param axis2 defines the second axis
  4415. * @param axis3 defines the third axis
  4416. * @param ref defines the target quaternion
  4417. */
  4418. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  4419. /**
  4420. * Interpolates between two quaternions
  4421. * @param left defines first quaternion
  4422. * @param right defines second quaternion
  4423. * @param amount defines the gradient to use
  4424. * @returns the new interpolated quaternion
  4425. */
  4426. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4427. /**
  4428. * Interpolates between two quaternions and stores it into a target quaternion
  4429. * @param left defines first quaternion
  4430. * @param right defines second quaternion
  4431. * @param amount defines the gradient to use
  4432. * @param result defines the target quaternion
  4433. */
  4434. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  4435. /**
  4436. * Interpolate between two quaternions using Hermite interpolation
  4437. * @param value1 defines first quaternion
  4438. * @param tangent1 defines the incoming tangent
  4439. * @param value2 defines second quaternion
  4440. * @param tangent2 defines the outgoing tangent
  4441. * @param amount defines the target quaternion
  4442. * @returns the new interpolated quaternion
  4443. */
  4444. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4445. }
  4446. /**
  4447. * Class used to store matrix data (4x4)
  4448. */
  4449. export class Matrix {
  4450. /**
  4451. * Gets the precision of matrix computations
  4452. */
  4453. static get Use64Bits(): boolean;
  4454. private static _updateFlagSeed;
  4455. private static _identityReadOnly;
  4456. private _isIdentity;
  4457. private _isIdentityDirty;
  4458. private _isIdentity3x2;
  4459. private _isIdentity3x2Dirty;
  4460. /**
  4461. * Gets the update flag of the matrix which is an unique number for the matrix.
  4462. * It will be incremented every time the matrix data change.
  4463. * You can use it to speed the comparison between two versions of the same matrix.
  4464. */
  4465. updateFlag: number;
  4466. private readonly _m;
  4467. /**
  4468. * Gets the internal data of the matrix
  4469. */
  4470. get m(): DeepImmutable<Float32Array | Array<number>>;
  4471. /** @hidden */
  4472. _markAsUpdated(): void;
  4473. /** @hidden */
  4474. private _updateIdentityStatus;
  4475. /**
  4476. * Creates an empty matrix (filled with zeros)
  4477. */
  4478. constructor();
  4479. /**
  4480. * Check if the current matrix is identity
  4481. * @returns true is the matrix is the identity matrix
  4482. */
  4483. isIdentity(): boolean;
  4484. /**
  4485. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  4486. * @returns true is the matrix is the identity matrix
  4487. */
  4488. isIdentityAs3x2(): boolean;
  4489. /**
  4490. * Gets the determinant of the matrix
  4491. * @returns the matrix determinant
  4492. */
  4493. determinant(): number;
  4494. /**
  4495. * Returns the matrix as a Float32Array or Array<number>
  4496. * @returns the matrix underlying array
  4497. */
  4498. toArray(): DeepImmutable<Float32Array | Array<number>>;
  4499. /**
  4500. * Returns the matrix as a Float32Array or Array<number>
  4501. * @returns the matrix underlying array.
  4502. */
  4503. asArray(): DeepImmutable<Float32Array | Array<number>>;
  4504. /**
  4505. * Inverts the current matrix in place
  4506. * @returns the current inverted matrix
  4507. */
  4508. invert(): Matrix;
  4509. /**
  4510. * Sets all the matrix elements to zero
  4511. * @returns the current matrix
  4512. */
  4513. reset(): Matrix;
  4514. /**
  4515. * Adds the current matrix with a second one
  4516. * @param other defines the matrix to add
  4517. * @returns a new matrix as the addition of the current matrix and the given one
  4518. */
  4519. add(other: DeepImmutable<Matrix>): Matrix;
  4520. /**
  4521. * Sets the given matrix "result" to the addition of the current matrix and the given one
  4522. * @param other defines the matrix to add
  4523. * @param result defines the target matrix
  4524. * @returns the current matrix
  4525. */
  4526. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4527. /**
  4528. * Adds in place the given matrix to the current matrix
  4529. * @param other defines the second operand
  4530. * @returns the current updated matrix
  4531. */
  4532. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  4533. /**
  4534. * Sets the given matrix to the current inverted Matrix
  4535. * @param other defines the target matrix
  4536. * @returns the unmodified current matrix
  4537. */
  4538. invertToRef(other: Matrix): Matrix;
  4539. /**
  4540. * add a value at the specified position in the current Matrix
  4541. * @param index the index of the value within the matrix. between 0 and 15.
  4542. * @param value the value to be added
  4543. * @returns the current updated matrix
  4544. */
  4545. addAtIndex(index: number, value: number): Matrix;
  4546. /**
  4547. * mutiply the specified position in the current Matrix by a value
  4548. * @param index the index of the value within the matrix. between 0 and 15.
  4549. * @param value the value to be added
  4550. * @returns the current updated matrix
  4551. */
  4552. multiplyAtIndex(index: number, value: number): Matrix;
  4553. /**
  4554. * Inserts the translation vector (using 3 floats) in the current matrix
  4555. * @param x defines the 1st component of the translation
  4556. * @param y defines the 2nd component of the translation
  4557. * @param z defines the 3rd component of the translation
  4558. * @returns the current updated matrix
  4559. */
  4560. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4561. /**
  4562. * Adds the translation vector (using 3 floats) in the current matrix
  4563. * @param x defines the 1st component of the translation
  4564. * @param y defines the 2nd component of the translation
  4565. * @param z defines the 3rd component of the translation
  4566. * @returns the current updated matrix
  4567. */
  4568. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4569. /**
  4570. * Inserts the translation vector in the current matrix
  4571. * @param vector3 defines the translation to insert
  4572. * @returns the current updated matrix
  4573. */
  4574. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  4575. /**
  4576. * Gets the translation value of the current matrix
  4577. * @returns a new Vector3 as the extracted translation from the matrix
  4578. */
  4579. getTranslation(): Vector3;
  4580. /**
  4581. * Fill a Vector3 with the extracted translation from the matrix
  4582. * @param result defines the Vector3 where to store the translation
  4583. * @returns the current matrix
  4584. */
  4585. getTranslationToRef(result: Vector3): Matrix;
  4586. /**
  4587. * Remove rotation and scaling part from the matrix
  4588. * @returns the updated matrix
  4589. */
  4590. removeRotationAndScaling(): Matrix;
  4591. /**
  4592. * Multiply two matrices
  4593. * @param other defines the second operand
  4594. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  4595. */
  4596. multiply(other: DeepImmutable<Matrix>): Matrix;
  4597. /**
  4598. * Copy the current matrix from the given one
  4599. * @param other defines the source matrix
  4600. * @returns the current updated matrix
  4601. */
  4602. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  4603. /**
  4604. * Populates the given array from the starting index with the current matrix values
  4605. * @param array defines the target array
  4606. * @param offset defines the offset in the target array where to start storing values
  4607. * @returns the current matrix
  4608. */
  4609. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  4610. /**
  4611. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  4612. * @param other defines the second operand
  4613. * @param result defines the matrix where to store the multiplication
  4614. * @returns the current matrix
  4615. */
  4616. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4617. /**
  4618. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4619. * @param other defines the second operand
  4620. * @param result defines the array where to store the multiplication
  4621. * @param offset defines the offset in the target array where to start storing values
  4622. * @returns the current matrix
  4623. */
  4624. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  4625. /**
  4626. * Check equality between this matrix and a second one
  4627. * @param value defines the second matrix to compare
  4628. * @returns true is the current matrix and the given one values are strictly equal
  4629. */
  4630. equals(value: DeepImmutable<Matrix>): boolean;
  4631. /**
  4632. * Clone the current matrix
  4633. * @returns a new matrix from the current matrix
  4634. */
  4635. clone(): Matrix;
  4636. /**
  4637. * Returns the name of the current matrix class
  4638. * @returns the string "Matrix"
  4639. */
  4640. getClassName(): string;
  4641. /**
  4642. * Gets the hash code of the current matrix
  4643. * @returns the hash code
  4644. */
  4645. getHashCode(): number;
  4646. /**
  4647. * Decomposes the current Matrix into a translation, rotation and scaling components
  4648. * @param scale defines the scale vector3 given as a reference to update
  4649. * @param rotation defines the rotation quaternion given as a reference to update
  4650. * @param translation defines the translation vector3 given as a reference to update
  4651. * @returns true if operation was successful
  4652. */
  4653. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4654. /**
  4655. * Gets specific row of the matrix
  4656. * @param index defines the number of the row to get
  4657. * @returns the index-th row of the current matrix as a new Vector4
  4658. */
  4659. getRow(index: number): Nullable<Vector4>;
  4660. /**
  4661. * Sets the index-th row of the current matrix to the vector4 values
  4662. * @param index defines the number of the row to set
  4663. * @param row defines the target vector4
  4664. * @returns the updated current matrix
  4665. */
  4666. setRow(index: number, row: Vector4): Matrix;
  4667. /**
  4668. * Compute the transpose of the matrix
  4669. * @returns the new transposed matrix
  4670. */
  4671. transpose(): Matrix;
  4672. /**
  4673. * Compute the transpose of the matrix and store it in a given matrix
  4674. * @param result defines the target matrix
  4675. * @returns the current matrix
  4676. */
  4677. transposeToRef(result: Matrix): Matrix;
  4678. /**
  4679. * Sets the index-th row of the current matrix with the given 4 x float values
  4680. * @param index defines the row index
  4681. * @param x defines the x component to set
  4682. * @param y defines the y component to set
  4683. * @param z defines the z component to set
  4684. * @param w defines the w component to set
  4685. * @returns the updated current matrix
  4686. */
  4687. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4688. /**
  4689. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4690. * @param scale defines the scale factor
  4691. * @returns a new matrix
  4692. */
  4693. scale(scale: number): Matrix;
  4694. /**
  4695. * Scale the current matrix values by a factor to a given result matrix
  4696. * @param scale defines the scale factor
  4697. * @param result defines the matrix to store the result
  4698. * @returns the current matrix
  4699. */
  4700. scaleToRef(scale: number, result: Matrix): Matrix;
  4701. /**
  4702. * Scale the current matrix values by a factor and add the result to a given matrix
  4703. * @param scale defines the scale factor
  4704. * @param result defines the Matrix to store the result
  4705. * @returns the current matrix
  4706. */
  4707. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4708. /**
  4709. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4710. * @param ref matrix to store the result
  4711. */
  4712. toNormalMatrix(ref: Matrix): void;
  4713. /**
  4714. * Gets only rotation part of the current matrix
  4715. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4716. */
  4717. getRotationMatrix(): Matrix;
  4718. /**
  4719. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4720. * @param result defines the target matrix to store data to
  4721. * @returns the current matrix
  4722. */
  4723. getRotationMatrixToRef(result: Matrix): Matrix;
  4724. /**
  4725. * Toggles model matrix from being right handed to left handed in place and vice versa
  4726. */
  4727. toggleModelMatrixHandInPlace(): void;
  4728. /**
  4729. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4730. */
  4731. toggleProjectionMatrixHandInPlace(): void;
  4732. /**
  4733. * Creates a matrix from an array
  4734. * @param array defines the source array
  4735. * @param offset defines an offset in the source array
  4736. * @returns a new Matrix set from the starting index of the given array
  4737. */
  4738. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4739. /**
  4740. * Copy the content of an array into a given matrix
  4741. * @param array defines the source array
  4742. * @param offset defines an offset in the source array
  4743. * @param result defines the target matrix
  4744. */
  4745. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4746. /**
  4747. * Stores an array into a matrix after having multiplied each component by a given factor
  4748. * @param array defines the source array
  4749. * @param offset defines the offset in the source array
  4750. * @param scale defines the scaling factor
  4751. * @param result defines the target matrix
  4752. */
  4753. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  4754. /**
  4755. * Gets an identity matrix that must not be updated
  4756. */
  4757. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  4758. /**
  4759. * Stores a list of values (16) inside a given matrix
  4760. * @param initialM11 defines 1st value of 1st row
  4761. * @param initialM12 defines 2nd value of 1st row
  4762. * @param initialM13 defines 3rd value of 1st row
  4763. * @param initialM14 defines 4th value of 1st row
  4764. * @param initialM21 defines 1st value of 2nd row
  4765. * @param initialM22 defines 2nd value of 2nd row
  4766. * @param initialM23 defines 3rd value of 2nd row
  4767. * @param initialM24 defines 4th value of 2nd row
  4768. * @param initialM31 defines 1st value of 3rd row
  4769. * @param initialM32 defines 2nd value of 3rd row
  4770. * @param initialM33 defines 3rd value of 3rd row
  4771. * @param initialM34 defines 4th value of 3rd row
  4772. * @param initialM41 defines 1st value of 4th row
  4773. * @param initialM42 defines 2nd value of 4th row
  4774. * @param initialM43 defines 3rd value of 4th row
  4775. * @param initialM44 defines 4th value of 4th row
  4776. * @param result defines the target matrix
  4777. */
  4778. 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;
  4779. /**
  4780. * Creates new matrix from a list of values (16)
  4781. * @param initialM11 defines 1st value of 1st row
  4782. * @param initialM12 defines 2nd value of 1st row
  4783. * @param initialM13 defines 3rd value of 1st row
  4784. * @param initialM14 defines 4th value of 1st row
  4785. * @param initialM21 defines 1st value of 2nd row
  4786. * @param initialM22 defines 2nd value of 2nd row
  4787. * @param initialM23 defines 3rd value of 2nd row
  4788. * @param initialM24 defines 4th value of 2nd row
  4789. * @param initialM31 defines 1st value of 3rd row
  4790. * @param initialM32 defines 2nd value of 3rd row
  4791. * @param initialM33 defines 3rd value of 3rd row
  4792. * @param initialM34 defines 4th value of 3rd row
  4793. * @param initialM41 defines 1st value of 4th row
  4794. * @param initialM42 defines 2nd value of 4th row
  4795. * @param initialM43 defines 3rd value of 4th row
  4796. * @param initialM44 defines 4th value of 4th row
  4797. * @returns the new matrix
  4798. */
  4799. 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;
  4800. /**
  4801. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4802. * @param scale defines the scale vector3
  4803. * @param rotation defines the rotation quaternion
  4804. * @param translation defines the translation vector3
  4805. * @returns a new matrix
  4806. */
  4807. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4808. /**
  4809. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4810. * @param scale defines the scale vector3
  4811. * @param rotation defines the rotation quaternion
  4812. * @param translation defines the translation vector3
  4813. * @param result defines the target matrix
  4814. */
  4815. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4816. /**
  4817. * Creates a new identity matrix
  4818. * @returns a new identity matrix
  4819. */
  4820. static Identity(): Matrix;
  4821. /**
  4822. * Creates a new identity matrix and stores the result in a given matrix
  4823. * @param result defines the target matrix
  4824. */
  4825. static IdentityToRef(result: Matrix): void;
  4826. /**
  4827. * Creates a new zero matrix
  4828. * @returns a new zero matrix
  4829. */
  4830. static Zero(): Matrix;
  4831. /**
  4832. * Creates a new rotation matrix for "angle" radians around the X axis
  4833. * @param angle defines the angle (in radians) to use
  4834. * @return the new matrix
  4835. */
  4836. static RotationX(angle: number): Matrix;
  4837. /**
  4838. * Creates a new matrix as the invert of a given matrix
  4839. * @param source defines the source matrix
  4840. * @returns the new matrix
  4841. */
  4842. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4843. /**
  4844. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4845. * @param angle defines the angle (in radians) to use
  4846. * @param result defines the target matrix
  4847. */
  4848. static RotationXToRef(angle: number, result: Matrix): void;
  4849. /**
  4850. * Creates a new rotation matrix for "angle" radians around the Y axis
  4851. * @param angle defines the angle (in radians) to use
  4852. * @return the new matrix
  4853. */
  4854. static RotationY(angle: number): Matrix;
  4855. /**
  4856. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4857. * @param angle defines the angle (in radians) to use
  4858. * @param result defines the target matrix
  4859. */
  4860. static RotationYToRef(angle: number, result: Matrix): void;
  4861. /**
  4862. * Creates a new rotation matrix for "angle" radians around the Z axis
  4863. * @param angle defines the angle (in radians) to use
  4864. * @return the new matrix
  4865. */
  4866. static RotationZ(angle: number): Matrix;
  4867. /**
  4868. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4869. * @param angle defines the angle (in radians) to use
  4870. * @param result defines the target matrix
  4871. */
  4872. static RotationZToRef(angle: number, result: Matrix): void;
  4873. /**
  4874. * Creates a new rotation matrix for "angle" radians around the given axis
  4875. * @param axis defines the axis to use
  4876. * @param angle defines the angle (in radians) to use
  4877. * @return the new matrix
  4878. */
  4879. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4880. /**
  4881. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4882. * @param axis defines the axis to use
  4883. * @param angle defines the angle (in radians) to use
  4884. * @param result defines the target matrix
  4885. */
  4886. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4887. /**
  4888. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4889. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4890. * @param from defines the vector to align
  4891. * @param to defines the vector to align to
  4892. * @param result defines the target matrix
  4893. */
  4894. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4895. /**
  4896. * Creates a rotation matrix
  4897. * @param yaw defines the yaw angle in radians (Y axis)
  4898. * @param pitch defines the pitch angle in radians (X axis)
  4899. * @param roll defines the roll angle in radians (Z axis)
  4900. * @returns the new rotation matrix
  4901. */
  4902. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4903. /**
  4904. * Creates a rotation matrix and stores it in a given matrix
  4905. * @param yaw defines the yaw angle in radians (Y axis)
  4906. * @param pitch defines the pitch angle in radians (X axis)
  4907. * @param roll defines the roll angle in radians (Z axis)
  4908. * @param result defines the target matrix
  4909. */
  4910. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4911. /**
  4912. * Creates a scaling matrix
  4913. * @param x defines the scale factor on X axis
  4914. * @param y defines the scale factor on Y axis
  4915. * @param z defines the scale factor on Z axis
  4916. * @returns the new matrix
  4917. */
  4918. static Scaling(x: number, y: number, z: number): Matrix;
  4919. /**
  4920. * Creates a scaling matrix and stores it in a given matrix
  4921. * @param x defines the scale factor on X axis
  4922. * @param y defines the scale factor on Y axis
  4923. * @param z defines the scale factor on Z axis
  4924. * @param result defines the target matrix
  4925. */
  4926. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4927. /**
  4928. * Creates a translation matrix
  4929. * @param x defines the translation on X axis
  4930. * @param y defines the translation on Y axis
  4931. * @param z defines the translationon Z axis
  4932. * @returns the new matrix
  4933. */
  4934. static Translation(x: number, y: number, z: number): Matrix;
  4935. /**
  4936. * Creates a translation matrix and stores it in a given matrix
  4937. * @param x defines the translation on X axis
  4938. * @param y defines the translation on Y axis
  4939. * @param z defines the translationon Z axis
  4940. * @param result defines the target matrix
  4941. */
  4942. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4943. /**
  4944. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4945. * @param startValue defines the start value
  4946. * @param endValue defines the end value
  4947. * @param gradient defines the gradient factor
  4948. * @returns the new matrix
  4949. */
  4950. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4951. /**
  4952. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4953. * @param startValue defines the start value
  4954. * @param endValue defines the end value
  4955. * @param gradient defines the gradient factor
  4956. * @param result defines the Matrix object where to store data
  4957. */
  4958. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4959. /**
  4960. * Builds a new matrix whose values are computed by:
  4961. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4962. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4963. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4964. * @param startValue defines the first matrix
  4965. * @param endValue defines the second matrix
  4966. * @param gradient defines the gradient between the two matrices
  4967. * @returns the new matrix
  4968. */
  4969. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4970. /**
  4971. * Update a matrix to values which are computed by:
  4972. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4973. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4974. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4975. * @param startValue defines the first matrix
  4976. * @param endValue defines the second matrix
  4977. * @param gradient defines the gradient between the two matrices
  4978. * @param result defines the target matrix
  4979. */
  4980. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4981. /**
  4982. * 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"
  4983. * This function works in left handed mode
  4984. * @param eye defines the final position of the entity
  4985. * @param target defines where the entity should look at
  4986. * @param up defines the up vector for the entity
  4987. * @returns the new matrix
  4988. */
  4989. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4990. /**
  4991. * 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".
  4992. * This function works in left handed mode
  4993. * @param eye defines the final position of the entity
  4994. * @param target defines where the entity should look at
  4995. * @param up defines the up vector for the entity
  4996. * @param result defines the target matrix
  4997. */
  4998. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4999. /**
  5000. * 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"
  5001. * This function works in right handed mode
  5002. * @param eye defines the final position of the entity
  5003. * @param target defines where the entity should look at
  5004. * @param up defines the up vector for the entity
  5005. * @returns the new matrix
  5006. */
  5007. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  5008. /**
  5009. * 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".
  5010. * This function works in right handed mode
  5011. * @param eye defines the final position of the entity
  5012. * @param target defines where the entity should look at
  5013. * @param up defines the up vector for the entity
  5014. * @param result defines the target matrix
  5015. */
  5016. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  5017. /**
  5018. * Create a left-handed orthographic projection matrix
  5019. * @param width defines the viewport width
  5020. * @param height defines the viewport height
  5021. * @param znear defines the near clip plane
  5022. * @param zfar defines the far clip plane
  5023. * @returns a new matrix as a left-handed orthographic projection matrix
  5024. */
  5025. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  5026. /**
  5027. * Store a left-handed orthographic projection to a given matrix
  5028. * @param width defines the viewport width
  5029. * @param height defines the viewport height
  5030. * @param znear defines the near clip plane
  5031. * @param zfar defines the far clip plane
  5032. * @param result defines the target matrix
  5033. */
  5034. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  5035. /**
  5036. * Create a left-handed orthographic projection matrix
  5037. * @param left defines the viewport left coordinate
  5038. * @param right defines the viewport right coordinate
  5039. * @param bottom defines the viewport bottom coordinate
  5040. * @param top defines the viewport top coordinate
  5041. * @param znear defines the near clip plane
  5042. * @param zfar defines the far clip plane
  5043. * @returns a new matrix as a left-handed orthographic projection matrix
  5044. */
  5045. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  5046. /**
  5047. * Stores a left-handed orthographic projection into a given matrix
  5048. * @param left defines the viewport left coordinate
  5049. * @param right defines the viewport right coordinate
  5050. * @param bottom defines the viewport bottom coordinate
  5051. * @param top defines the viewport top coordinate
  5052. * @param znear defines the near clip plane
  5053. * @param zfar defines the far clip plane
  5054. * @param result defines the target matrix
  5055. */
  5056. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  5057. /**
  5058. * Creates a right-handed orthographic projection matrix
  5059. * @param left defines the viewport left coordinate
  5060. * @param right defines the viewport right coordinate
  5061. * @param bottom defines the viewport bottom coordinate
  5062. * @param top defines the viewport top coordinate
  5063. * @param znear defines the near clip plane
  5064. * @param zfar defines the far clip plane
  5065. * @returns a new matrix as a right-handed orthographic projection matrix
  5066. */
  5067. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  5068. /**
  5069. * Stores a right-handed orthographic projection into a given matrix
  5070. * @param left defines the viewport left coordinate
  5071. * @param right defines the viewport right coordinate
  5072. * @param bottom defines the viewport bottom coordinate
  5073. * @param top defines the viewport top coordinate
  5074. * @param znear defines the near clip plane
  5075. * @param zfar defines the far clip plane
  5076. * @param result defines the target matrix
  5077. */
  5078. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  5079. /**
  5080. * Creates a left-handed perspective projection matrix
  5081. * @param width defines the viewport width
  5082. * @param height defines the viewport height
  5083. * @param znear defines the near clip plane
  5084. * @param zfar defines the far clip plane
  5085. * @returns a new matrix as a left-handed perspective projection matrix
  5086. */
  5087. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  5088. /**
  5089. * Creates a left-handed perspective projection matrix
  5090. * @param fov defines the horizontal field of view
  5091. * @param aspect defines the aspect ratio
  5092. * @param znear defines the near clip plane
  5093. * @param zfar defines the far clip plane
  5094. * @returns a new matrix as a left-handed perspective projection matrix
  5095. */
  5096. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  5097. /**
  5098. * Stores a left-handed perspective projection into a given matrix
  5099. * @param fov defines the horizontal field of view
  5100. * @param aspect defines the aspect ratio
  5101. * @param znear defines the near clip plane
  5102. * @param zfar defines the far clip plane
  5103. * @param result defines the target matrix
  5104. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  5105. */
  5106. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  5107. /**
  5108. * Stores a left-handed perspective projection into a given matrix with depth reversed
  5109. * @param fov defines the horizontal field of view
  5110. * @param aspect defines the aspect ratio
  5111. * @param znear defines the near clip plane
  5112. * @param zfar not used as infinity is used as far clip
  5113. * @param result defines the target matrix
  5114. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  5115. */
  5116. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  5117. /**
  5118. * Creates a right-handed perspective projection matrix
  5119. * @param fov defines the horizontal field of view
  5120. * @param aspect defines the aspect ratio
  5121. * @param znear defines the near clip plane
  5122. * @param zfar defines the far clip plane
  5123. * @returns a new matrix as a right-handed perspective projection matrix
  5124. */
  5125. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  5126. /**
  5127. * Stores a right-handed perspective projection into a given matrix
  5128. * @param fov defines the horizontal field of view
  5129. * @param aspect defines the aspect ratio
  5130. * @param znear defines the near clip plane
  5131. * @param zfar defines the far clip plane
  5132. * @param result defines the target matrix
  5133. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  5134. */
  5135. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  5136. /**
  5137. * Stores a right-handed perspective projection into a given matrix
  5138. * @param fov defines the horizontal field of view
  5139. * @param aspect defines the aspect ratio
  5140. * @param znear defines the near clip plane
  5141. * @param zfar not used as infinity is used as far clip
  5142. * @param result defines the target matrix
  5143. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  5144. */
  5145. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  5146. /**
  5147. * Stores a perspective projection for WebVR info a given matrix
  5148. * @param fov defines the field of view
  5149. * @param znear defines the near clip plane
  5150. * @param zfar defines the far clip plane
  5151. * @param result defines the target matrix
  5152. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  5153. */
  5154. static PerspectiveFovWebVRToRef(fov: {
  5155. upDegrees: number;
  5156. downDegrees: number;
  5157. leftDegrees: number;
  5158. rightDegrees: number;
  5159. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  5160. /**
  5161. * Computes a complete transformation matrix
  5162. * @param viewport defines the viewport to use
  5163. * @param world defines the world matrix
  5164. * @param view defines the view matrix
  5165. * @param projection defines the projection matrix
  5166. * @param zmin defines the near clip plane
  5167. * @param zmax defines the far clip plane
  5168. * @returns the transformation matrix
  5169. */
  5170. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  5171. /**
  5172. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  5173. * @param matrix defines the matrix to use
  5174. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  5175. */
  5176. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  5177. /**
  5178. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  5179. * @param matrix defines the matrix to use
  5180. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  5181. */
  5182. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  5183. /**
  5184. * Compute the transpose of a given matrix
  5185. * @param matrix defines the matrix to transpose
  5186. * @returns the new matrix
  5187. */
  5188. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  5189. /**
  5190. * Compute the transpose of a matrix and store it in a target matrix
  5191. * @param matrix defines the matrix to transpose
  5192. * @param result defines the target matrix
  5193. */
  5194. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  5195. /**
  5196. * Computes a reflection matrix from a plane
  5197. * @param plane defines the reflection plane
  5198. * @returns a new matrix
  5199. */
  5200. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  5201. /**
  5202. * Computes a reflection matrix from a plane
  5203. * @param plane defines the reflection plane
  5204. * @param result defines the target matrix
  5205. */
  5206. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  5207. /**
  5208. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  5209. * @param xaxis defines the value of the 1st axis
  5210. * @param yaxis defines the value of the 2nd axis
  5211. * @param zaxis defines the value of the 3rd axis
  5212. * @param result defines the target matrix
  5213. */
  5214. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  5215. /**
  5216. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  5217. * @param quat defines the quaternion to use
  5218. * @param result defines the target matrix
  5219. */
  5220. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  5221. }
  5222. /**
  5223. * @hidden
  5224. */
  5225. export class TmpVectors {
  5226. static Vector2: Vector2[];
  5227. static Vector3: Vector3[];
  5228. static Vector4: Vector4[];
  5229. static Quaternion: Quaternion[];
  5230. static Matrix: Matrix[];
  5231. }
  5232. }
  5233. declare module BABYLON {
  5234. /**
  5235. * Defines potential orientation for back face culling
  5236. */
  5237. export enum Orientation {
  5238. /**
  5239. * Clockwise
  5240. */
  5241. CW = 0,
  5242. /** Counter clockwise */
  5243. CCW = 1
  5244. }
  5245. /** Class used to represent a Bezier curve */
  5246. export class BezierCurve {
  5247. /**
  5248. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  5249. * @param t defines the time
  5250. * @param x1 defines the left coordinate on X axis
  5251. * @param y1 defines the left coordinate on Y axis
  5252. * @param x2 defines the right coordinate on X axis
  5253. * @param y2 defines the right coordinate on Y axis
  5254. * @returns the interpolated value
  5255. */
  5256. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  5257. }
  5258. /**
  5259. * Defines angle representation
  5260. */
  5261. export class Angle {
  5262. private _radians;
  5263. /**
  5264. * Creates an Angle object of "radians" radians (float).
  5265. * @param radians the angle in radians
  5266. */
  5267. constructor(radians: number);
  5268. /**
  5269. * Get value in degrees
  5270. * @returns the Angle value in degrees (float)
  5271. */
  5272. degrees(): number;
  5273. /**
  5274. * Get value in radians
  5275. * @returns the Angle value in radians (float)
  5276. */
  5277. radians(): number;
  5278. /**
  5279. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  5280. * @param a defines first point as the origin
  5281. * @param b defines point
  5282. * @returns a new Angle
  5283. */
  5284. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  5285. /**
  5286. * Gets a new Angle object from the given float in radians
  5287. * @param radians defines the angle value in radians
  5288. * @returns a new Angle
  5289. */
  5290. static FromRadians(radians: number): Angle;
  5291. /**
  5292. * Gets a new Angle object from the given float in degrees
  5293. * @param degrees defines the angle value in degrees
  5294. * @returns a new Angle
  5295. */
  5296. static FromDegrees(degrees: number): Angle;
  5297. }
  5298. /**
  5299. * This represents an arc in a 2d space.
  5300. */
  5301. export class Arc2 {
  5302. /** Defines the start point of the arc */
  5303. startPoint: Vector2;
  5304. /** Defines the mid point of the arc */
  5305. midPoint: Vector2;
  5306. /** Defines the end point of the arc */
  5307. endPoint: Vector2;
  5308. /**
  5309. * Defines the center point of the arc.
  5310. */
  5311. centerPoint: Vector2;
  5312. /**
  5313. * Defines the radius of the arc.
  5314. */
  5315. radius: number;
  5316. /**
  5317. * Defines the angle of the arc (from mid point to end point).
  5318. */
  5319. angle: Angle;
  5320. /**
  5321. * Defines the start angle of the arc (from start point to middle point).
  5322. */
  5323. startAngle: Angle;
  5324. /**
  5325. * Defines the orientation of the arc (clock wise/counter clock wise).
  5326. */
  5327. orientation: Orientation;
  5328. /**
  5329. * Creates an Arc object from the three given points : start, middle and end.
  5330. * @param startPoint Defines the start point of the arc
  5331. * @param midPoint Defines the midlle point of the arc
  5332. * @param endPoint Defines the end point of the arc
  5333. */
  5334. constructor(
  5335. /** Defines the start point of the arc */
  5336. startPoint: Vector2,
  5337. /** Defines the mid point of the arc */
  5338. midPoint: Vector2,
  5339. /** Defines the end point of the arc */
  5340. endPoint: Vector2);
  5341. }
  5342. /**
  5343. * Represents a 2D path made up of multiple 2D points
  5344. */
  5345. export class Path2 {
  5346. private _points;
  5347. private _length;
  5348. /**
  5349. * If the path start and end point are the same
  5350. */
  5351. closed: boolean;
  5352. /**
  5353. * Creates a Path2 object from the starting 2D coordinates x and y.
  5354. * @param x the starting points x value
  5355. * @param y the starting points y value
  5356. */
  5357. constructor(x: number, y: number);
  5358. /**
  5359. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  5360. * @param x the added points x value
  5361. * @param y the added points y value
  5362. * @returns the updated Path2.
  5363. */
  5364. addLineTo(x: number, y: number): Path2;
  5365. /**
  5366. * 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.
  5367. * @param midX middle point x value
  5368. * @param midY middle point y value
  5369. * @param endX end point x value
  5370. * @param endY end point y value
  5371. * @param numberOfSegments (default: 36)
  5372. * @returns the updated Path2.
  5373. */
  5374. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  5375. /**
  5376. * Closes the Path2.
  5377. * @returns the Path2.
  5378. */
  5379. close(): Path2;
  5380. /**
  5381. * Gets the sum of the distance between each sequential point in the path
  5382. * @returns the Path2 total length (float).
  5383. */
  5384. length(): number;
  5385. /**
  5386. * Gets the points which construct the path
  5387. * @returns the Path2 internal array of points.
  5388. */
  5389. getPoints(): Vector2[];
  5390. /**
  5391. * Retreives the point at the distance aways from the starting point
  5392. * @param normalizedLengthPosition the length along the path to retreive the point from
  5393. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  5394. */
  5395. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  5396. /**
  5397. * Creates a new path starting from an x and y position
  5398. * @param x starting x value
  5399. * @param y starting y value
  5400. * @returns a new Path2 starting at the coordinates (x, y).
  5401. */
  5402. static StartingAt(x: number, y: number): Path2;
  5403. }
  5404. /**
  5405. * Represents a 3D path made up of multiple 3D points
  5406. */
  5407. export class Path3D {
  5408. /**
  5409. * an array of Vector3, the curve axis of the Path3D
  5410. */
  5411. path: Vector3[];
  5412. private _curve;
  5413. private _distances;
  5414. private _tangents;
  5415. private _normals;
  5416. private _binormals;
  5417. private _raw;
  5418. private _alignTangentsWithPath;
  5419. private readonly _pointAtData;
  5420. /**
  5421. * new Path3D(path, normal, raw)
  5422. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  5423. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  5424. * @param path an array of Vector3, the curve axis of the Path3D
  5425. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  5426. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  5427. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  5428. */
  5429. constructor(
  5430. /**
  5431. * an array of Vector3, the curve axis of the Path3D
  5432. */
  5433. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  5434. /**
  5435. * Returns the Path3D array of successive Vector3 designing its curve.
  5436. * @returns the Path3D array of successive Vector3 designing its curve.
  5437. */
  5438. getCurve(): Vector3[];
  5439. /**
  5440. * Returns the Path3D array of successive Vector3 designing its curve.
  5441. * @returns the Path3D array of successive Vector3 designing its curve.
  5442. */
  5443. getPoints(): Vector3[];
  5444. /**
  5445. * @returns the computed length (float) of the path.
  5446. */
  5447. length(): number;
  5448. /**
  5449. * Returns an array populated with tangent vectors on each Path3D curve point.
  5450. * @returns an array populated with tangent vectors on each Path3D curve point.
  5451. */
  5452. getTangents(): Vector3[];
  5453. /**
  5454. * Returns an array populated with normal vectors on each Path3D curve point.
  5455. * @returns an array populated with normal vectors on each Path3D curve point.
  5456. */
  5457. getNormals(): Vector3[];
  5458. /**
  5459. * Returns an array populated with binormal vectors on each Path3D curve point.
  5460. * @returns an array populated with binormal vectors on each Path3D curve point.
  5461. */
  5462. getBinormals(): Vector3[];
  5463. /**
  5464. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  5465. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  5466. */
  5467. getDistances(): number[];
  5468. /**
  5469. * Returns an interpolated point along this path
  5470. * @param position the position of the point along this path, from 0.0 to 1.0
  5471. * @returns a new Vector3 as the point
  5472. */
  5473. getPointAt(position: number): Vector3;
  5474. /**
  5475. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5476. * @param position the position of the point along this path, from 0.0 to 1.0
  5477. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  5478. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  5479. */
  5480. getTangentAt(position: number, interpolated?: boolean): Vector3;
  5481. /**
  5482. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5483. * @param position the position of the point along this path, from 0.0 to 1.0
  5484. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  5485. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  5486. */
  5487. getNormalAt(position: number, interpolated?: boolean): Vector3;
  5488. /**
  5489. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  5490. * @param position the position of the point along this path, from 0.0 to 1.0
  5491. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  5492. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  5493. */
  5494. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  5495. /**
  5496. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  5497. * @param position the position of the point along this path, from 0.0 to 1.0
  5498. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  5499. */
  5500. getDistanceAt(position: number): number;
  5501. /**
  5502. * Returns the array index of the previous point of an interpolated point along this path
  5503. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5504. * @returns the array index
  5505. */
  5506. getPreviousPointIndexAt(position: number): number;
  5507. /**
  5508. * Returns the position of an interpolated point relative to the two path points it lies between, from 0.0 (point A) to 1.0 (point B)
  5509. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5510. * @returns the sub position
  5511. */
  5512. getSubPositionAt(position: number): number;
  5513. /**
  5514. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  5515. * @param target the vector of which to get the closest position to
  5516. * @returns the position of the closest virtual point on this path to the target vector
  5517. */
  5518. getClosestPositionTo(target: Vector3): number;
  5519. /**
  5520. * Returns a sub path (slice) of this path
  5521. * @param start the position of the fist path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5522. * @param end the position of the last path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5523. * @returns a sub path (slice) of this path
  5524. */
  5525. slice(start?: number, end?: number): Path3D;
  5526. /**
  5527. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  5528. * @param path path which all values are copied into the curves points
  5529. * @param firstNormal which should be projected onto the curve
  5530. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  5531. * @returns the same object updated.
  5532. */
  5533. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  5534. private _compute;
  5535. private _getFirstNonNullVector;
  5536. private _getLastNonNullVector;
  5537. private _normalVector;
  5538. /**
  5539. * Updates the point at data for an interpolated point along this curve
  5540. * @param position the position of the point along this curve, from 0.0 to 1.0
  5541. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  5542. * @returns the (updated) point at data
  5543. */
  5544. private _updatePointAtData;
  5545. /**
  5546. * Updates the point at data from the specified parameters
  5547. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  5548. * @param point the interpolated point
  5549. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  5550. */
  5551. private _setPointAtData;
  5552. /**
  5553. * Updates the point at interpolation matrix for the tangents, normals and binormals
  5554. */
  5555. private _updateInterpolationMatrix;
  5556. }
  5557. /**
  5558. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5559. * A Curve3 is designed from a series of successive Vector3.
  5560. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  5561. */
  5562. export class Curve3 {
  5563. private _points;
  5564. private _length;
  5565. /**
  5566. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  5567. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  5568. * @param v1 (Vector3) the control point
  5569. * @param v2 (Vector3) the end point of the Quadratic Bezier
  5570. * @param nbPoints (integer) the wanted number of points in the curve
  5571. * @returns the created Curve3
  5572. */
  5573. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5574. /**
  5575. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  5576. * @param v0 (Vector3) the origin point of the Cubic Bezier
  5577. * @param v1 (Vector3) the first control point
  5578. * @param v2 (Vector3) the second control point
  5579. * @param v3 (Vector3) the end point of the Cubic Bezier
  5580. * @param nbPoints (integer) the wanted number of points in the curve
  5581. * @returns the created Curve3
  5582. */
  5583. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5584. /**
  5585. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  5586. * @param p1 (Vector3) the origin point of the Hermite Spline
  5587. * @param t1 (Vector3) the tangent vector at the origin point
  5588. * @param p2 (Vector3) the end point of the Hermite Spline
  5589. * @param t2 (Vector3) the tangent vector at the end point
  5590. * @param nbPoints (integer) the wanted number of points in the curve
  5591. * @returns the created Curve3
  5592. */
  5593. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5594. /**
  5595. * Returns a Curve3 object along a CatmullRom Spline curve :
  5596. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  5597. * @param nbPoints (integer) the wanted number of points between each curve control points
  5598. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  5599. * @returns the created Curve3
  5600. */
  5601. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  5602. /**
  5603. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5604. * A Curve3 is designed from a series of successive Vector3.
  5605. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  5606. * @param points points which make up the curve
  5607. */
  5608. constructor(points: Vector3[]);
  5609. /**
  5610. * @returns the Curve3 stored array of successive Vector3
  5611. */
  5612. getPoints(): Vector3[];
  5613. /**
  5614. * @returns the computed length (float) of the curve.
  5615. */
  5616. length(): number;
  5617. /**
  5618. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  5619. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  5620. * curveA and curveB keep unchanged.
  5621. * @param curve the curve to continue from this curve
  5622. * @returns the newly constructed curve
  5623. */
  5624. continue(curve: DeepImmutable<Curve3>): Curve3;
  5625. private _computeLength;
  5626. }
  5627. }
  5628. declare module BABYLON {
  5629. /**
  5630. * This represents the main contract an easing function should follow.
  5631. * Easing functions are used throughout the animation system.
  5632. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5633. */
  5634. export interface IEasingFunction {
  5635. /**
  5636. * Given an input gradient between 0 and 1, this returns the corrseponding value
  5637. * of the easing function.
  5638. * The link below provides some of the most common examples of easing functions.
  5639. * @see https://easings.net/
  5640. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5641. * @returns the corresponding value on the curve defined by the easing function
  5642. */
  5643. ease(gradient: number): number;
  5644. }
  5645. /**
  5646. * Base class used for every default easing function.
  5647. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5648. */
  5649. export class EasingFunction implements IEasingFunction {
  5650. /**
  5651. * Interpolation follows the mathematical formula associated with the easing function.
  5652. */
  5653. static readonly EASINGMODE_EASEIN: number;
  5654. /**
  5655. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  5656. */
  5657. static readonly EASINGMODE_EASEOUT: number;
  5658. /**
  5659. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  5660. */
  5661. static readonly EASINGMODE_EASEINOUT: number;
  5662. private _easingMode;
  5663. /**
  5664. * Sets the easing mode of the current function.
  5665. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  5666. */
  5667. setEasingMode(easingMode: number): void;
  5668. /**
  5669. * Gets the current easing mode.
  5670. * @returns the easing mode
  5671. */
  5672. getEasingMode(): number;
  5673. /**
  5674. * @hidden
  5675. */
  5676. easeInCore(gradient: number): number;
  5677. /**
  5678. * Given an input gradient between 0 and 1, this returns the corresponding value
  5679. * of the easing function.
  5680. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5681. * @returns the corresponding value on the curve defined by the easing function
  5682. */
  5683. ease(gradient: number): number;
  5684. }
  5685. /**
  5686. * Easing function with a circle shape (see link below).
  5687. * @see https://easings.net/#easeInCirc
  5688. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5689. */
  5690. export class CircleEase extends EasingFunction implements IEasingFunction {
  5691. /** @hidden */
  5692. easeInCore(gradient: number): number;
  5693. }
  5694. /**
  5695. * Easing function with a ease back shape (see link below).
  5696. * @see https://easings.net/#easeInBack
  5697. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5698. */
  5699. export class BackEase extends EasingFunction implements IEasingFunction {
  5700. /** Defines the amplitude of the function */
  5701. amplitude: number;
  5702. /**
  5703. * Instantiates a back ease easing
  5704. * @see https://easings.net/#easeInBack
  5705. * @param amplitude Defines the amplitude of the function
  5706. */
  5707. constructor(
  5708. /** Defines the amplitude of the function */
  5709. amplitude?: number);
  5710. /** @hidden */
  5711. easeInCore(gradient: number): number;
  5712. }
  5713. /**
  5714. * Easing function with a bouncing shape (see link below).
  5715. * @see https://easings.net/#easeInBounce
  5716. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5717. */
  5718. export class BounceEase extends EasingFunction implements IEasingFunction {
  5719. /** Defines the number of bounces */
  5720. bounces: number;
  5721. /** Defines the amplitude of the bounce */
  5722. bounciness: number;
  5723. /**
  5724. * Instantiates a bounce easing
  5725. * @see https://easings.net/#easeInBounce
  5726. * @param bounces Defines the number of bounces
  5727. * @param bounciness Defines the amplitude of the bounce
  5728. */
  5729. constructor(
  5730. /** Defines the number of bounces */
  5731. bounces?: number,
  5732. /** Defines the amplitude of the bounce */
  5733. bounciness?: number);
  5734. /** @hidden */
  5735. easeInCore(gradient: number): number;
  5736. }
  5737. /**
  5738. * Easing function with a power of 3 shape (see link below).
  5739. * @see https://easings.net/#easeInCubic
  5740. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5741. */
  5742. export class CubicEase extends EasingFunction implements IEasingFunction {
  5743. /** @hidden */
  5744. easeInCore(gradient: number): number;
  5745. }
  5746. /**
  5747. * Easing function with an elastic shape (see link below).
  5748. * @see https://easings.net/#easeInElastic
  5749. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5750. */
  5751. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5752. /** Defines the number of oscillations*/
  5753. oscillations: number;
  5754. /** Defines the amplitude of the oscillations*/
  5755. springiness: number;
  5756. /**
  5757. * Instantiates an elastic easing function
  5758. * @see https://easings.net/#easeInElastic
  5759. * @param oscillations Defines the number of oscillations
  5760. * @param springiness Defines the amplitude of the oscillations
  5761. */
  5762. constructor(
  5763. /** Defines the number of oscillations*/
  5764. oscillations?: number,
  5765. /** Defines the amplitude of the oscillations*/
  5766. springiness?: number);
  5767. /** @hidden */
  5768. easeInCore(gradient: number): number;
  5769. }
  5770. /**
  5771. * Easing function with an exponential shape (see link below).
  5772. * @see https://easings.net/#easeInExpo
  5773. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5774. */
  5775. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5776. /** Defines the exponent of the function */
  5777. exponent: number;
  5778. /**
  5779. * Instantiates an exponential easing function
  5780. * @see https://easings.net/#easeInExpo
  5781. * @param exponent Defines the exponent of the function
  5782. */
  5783. constructor(
  5784. /** Defines the exponent of the function */
  5785. exponent?: number);
  5786. /** @hidden */
  5787. easeInCore(gradient: number): number;
  5788. }
  5789. /**
  5790. * Easing function with a power shape (see link below).
  5791. * @see https://easings.net/#easeInQuad
  5792. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5793. */
  5794. export class PowerEase extends EasingFunction implements IEasingFunction {
  5795. /** Defines the power of the function */
  5796. power: number;
  5797. /**
  5798. * Instantiates an power base easing function
  5799. * @see https://easings.net/#easeInQuad
  5800. * @param power Defines the power of the function
  5801. */
  5802. constructor(
  5803. /** Defines the power of the function */
  5804. power?: number);
  5805. /** @hidden */
  5806. easeInCore(gradient: number): number;
  5807. }
  5808. /**
  5809. * Easing function with a power of 2 shape (see link below).
  5810. * @see https://easings.net/#easeInQuad
  5811. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5812. */
  5813. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5814. /** @hidden */
  5815. easeInCore(gradient: number): number;
  5816. }
  5817. /**
  5818. * Easing function with a power of 4 shape (see link below).
  5819. * @see https://easings.net/#easeInQuart
  5820. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5821. */
  5822. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5823. /** @hidden */
  5824. easeInCore(gradient: number): number;
  5825. }
  5826. /**
  5827. * Easing function with a power of 5 shape (see link below).
  5828. * @see https://easings.net/#easeInQuint
  5829. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5830. */
  5831. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5832. /** @hidden */
  5833. easeInCore(gradient: number): number;
  5834. }
  5835. /**
  5836. * Easing function with a sin shape (see link below).
  5837. * @see https://easings.net/#easeInSine
  5838. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5839. */
  5840. export class SineEase extends EasingFunction implements IEasingFunction {
  5841. /** @hidden */
  5842. easeInCore(gradient: number): number;
  5843. }
  5844. /**
  5845. * Easing function with a bezier shape (see link below).
  5846. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5847. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5848. */
  5849. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5850. /** Defines the x component of the start tangent in the bezier curve */
  5851. x1: number;
  5852. /** Defines the y component of the start tangent in the bezier curve */
  5853. y1: number;
  5854. /** Defines the x component of the end tangent in the bezier curve */
  5855. x2: number;
  5856. /** Defines the y component of the end tangent in the bezier curve */
  5857. y2: number;
  5858. /**
  5859. * Instantiates a bezier function
  5860. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5861. * @param x1 Defines the x component of the start tangent in the bezier curve
  5862. * @param y1 Defines the y component of the start tangent in the bezier curve
  5863. * @param x2 Defines the x component of the end tangent in the bezier curve
  5864. * @param y2 Defines the y component of the end tangent in the bezier curve
  5865. */
  5866. constructor(
  5867. /** Defines the x component of the start tangent in the bezier curve */
  5868. x1?: number,
  5869. /** Defines the y component of the start tangent in the bezier curve */
  5870. y1?: number,
  5871. /** Defines the x component of the end tangent in the bezier curve */
  5872. x2?: number,
  5873. /** Defines the y component of the end tangent in the bezier curve */
  5874. y2?: number);
  5875. /** @hidden */
  5876. easeInCore(gradient: number): number;
  5877. }
  5878. }
  5879. declare module BABYLON {
  5880. /**
  5881. * Class used to hold a RBG color
  5882. */
  5883. export class Color3 {
  5884. /**
  5885. * Defines the red component (between 0 and 1, default is 0)
  5886. */
  5887. r: number;
  5888. /**
  5889. * Defines the green component (between 0 and 1, default is 0)
  5890. */
  5891. g: number;
  5892. /**
  5893. * Defines the blue component (between 0 and 1, default is 0)
  5894. */
  5895. b: number;
  5896. /**
  5897. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5898. * @param r defines the red component (between 0 and 1, default is 0)
  5899. * @param g defines the green component (between 0 and 1, default is 0)
  5900. * @param b defines the blue component (between 0 and 1, default is 0)
  5901. */
  5902. constructor(
  5903. /**
  5904. * Defines the red component (between 0 and 1, default is 0)
  5905. */
  5906. r?: number,
  5907. /**
  5908. * Defines the green component (between 0 and 1, default is 0)
  5909. */
  5910. g?: number,
  5911. /**
  5912. * Defines the blue component (between 0 and 1, default is 0)
  5913. */
  5914. b?: number);
  5915. /**
  5916. * Creates a string with the Color3 current values
  5917. * @returns the string representation of the Color3 object
  5918. */
  5919. toString(): string;
  5920. /**
  5921. * Returns the string "Color3"
  5922. * @returns "Color3"
  5923. */
  5924. getClassName(): string;
  5925. /**
  5926. * Compute the Color3 hash code
  5927. * @returns an unique number that can be used to hash Color3 objects
  5928. */
  5929. getHashCode(): number;
  5930. /**
  5931. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5932. * @param array defines the array where to store the r,g,b components
  5933. * @param index defines an optional index in the target array to define where to start storing values
  5934. * @returns the current Color3 object
  5935. */
  5936. toArray(array: FloatArray, index?: number): Color3;
  5937. /**
  5938. * Update the current color with values stored in an array from the starting index of the given array
  5939. * @param array defines the source array
  5940. * @param offset defines an offset in the source array
  5941. * @returns the current Color3 object
  5942. */
  5943. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5944. /**
  5945. * Returns a new Color4 object from the current Color3 and the given alpha
  5946. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5947. * @returns a new Color4 object
  5948. */
  5949. toColor4(alpha?: number): Color4;
  5950. /**
  5951. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5952. * @returns the new array
  5953. */
  5954. asArray(): number[];
  5955. /**
  5956. * Returns the luminance value
  5957. * @returns a float value
  5958. */
  5959. toLuminance(): number;
  5960. /**
  5961. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5962. * @param otherColor defines the second operand
  5963. * @returns the new Color3 object
  5964. */
  5965. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5966. /**
  5967. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5968. * @param otherColor defines the second operand
  5969. * @param result defines the Color3 object where to store the result
  5970. * @returns the current Color3
  5971. */
  5972. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5973. /**
  5974. * Determines equality between Color3 objects
  5975. * @param otherColor defines the second operand
  5976. * @returns true if the rgb values are equal to the given ones
  5977. */
  5978. equals(otherColor: DeepImmutable<Color3>): boolean;
  5979. /**
  5980. * Determines equality between the current Color3 object and a set of r,b,g values
  5981. * @param r defines the red component to check
  5982. * @param g defines the green component to check
  5983. * @param b defines the blue component to check
  5984. * @returns true if the rgb values are equal to the given ones
  5985. */
  5986. equalsFloats(r: number, g: number, b: number): boolean;
  5987. /**
  5988. * Multiplies in place each rgb value by scale
  5989. * @param scale defines the scaling factor
  5990. * @returns the updated Color3
  5991. */
  5992. scale(scale: number): Color3;
  5993. /**
  5994. * Multiplies the rgb values by scale and stores the result into "result"
  5995. * @param scale defines the scaling factor
  5996. * @param result defines the Color3 object where to store the result
  5997. * @returns the unmodified current Color3
  5998. */
  5999. scaleToRef(scale: number, result: Color3): Color3;
  6000. /**
  6001. * Scale the current Color3 values by a factor and add the result to a given Color3
  6002. * @param scale defines the scale factor
  6003. * @param result defines color to store the result into
  6004. * @returns the unmodified current Color3
  6005. */
  6006. scaleAndAddToRef(scale: number, result: Color3): Color3;
  6007. /**
  6008. * Clamps the rgb values by the min and max values and stores the result into "result"
  6009. * @param min defines minimum clamping value (default is 0)
  6010. * @param max defines maximum clamping value (default is 1)
  6011. * @param result defines color to store the result into
  6012. * @returns the original Color3
  6013. */
  6014. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  6015. /**
  6016. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  6017. * @param otherColor defines the second operand
  6018. * @returns the new Color3
  6019. */
  6020. add(otherColor: DeepImmutable<Color3>): Color3;
  6021. /**
  6022. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  6023. * @param otherColor defines the second operand
  6024. * @param result defines Color3 object to store the result into
  6025. * @returns the unmodified current Color3
  6026. */
  6027. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  6028. /**
  6029. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  6030. * @param otherColor defines the second operand
  6031. * @returns the new Color3
  6032. */
  6033. subtract(otherColor: DeepImmutable<Color3>): Color3;
  6034. /**
  6035. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  6036. * @param otherColor defines the second operand
  6037. * @param result defines Color3 object to store the result into
  6038. * @returns the unmodified current Color3
  6039. */
  6040. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  6041. /**
  6042. * Copy the current object
  6043. * @returns a new Color3 copied the current one
  6044. */
  6045. clone(): Color3;
  6046. /**
  6047. * Copies the rgb values from the source in the current Color3
  6048. * @param source defines the source Color3 object
  6049. * @returns the updated Color3 object
  6050. */
  6051. copyFrom(source: DeepImmutable<Color3>): Color3;
  6052. /**
  6053. * Updates the Color3 rgb values from the given floats
  6054. * @param r defines the red component to read from
  6055. * @param g defines the green component to read from
  6056. * @param b defines the blue component to read from
  6057. * @returns the current Color3 object
  6058. */
  6059. copyFromFloats(r: number, g: number, b: number): Color3;
  6060. /**
  6061. * Updates the Color3 rgb values from the given floats
  6062. * @param r defines the red component to read from
  6063. * @param g defines the green component to read from
  6064. * @param b defines the blue component to read from
  6065. * @returns the current Color3 object
  6066. */
  6067. set(r: number, g: number, b: number): Color3;
  6068. /**
  6069. * Compute the Color3 hexadecimal code as a string
  6070. * @returns a string containing the hexadecimal representation of the Color3 object
  6071. */
  6072. toHexString(): string;
  6073. /**
  6074. * Computes a new Color3 converted from the current one to linear space
  6075. * @returns a new Color3 object
  6076. */
  6077. toLinearSpace(): Color3;
  6078. /**
  6079. * Converts current color in rgb space to HSV values
  6080. * @returns a new color3 representing the HSV values
  6081. */
  6082. toHSV(): Color3;
  6083. /**
  6084. * Converts current color in rgb space to HSV values
  6085. * @param result defines the Color3 where to store the HSV values
  6086. */
  6087. toHSVToRef(result: Color3): void;
  6088. /**
  6089. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  6090. * @param convertedColor defines the Color3 object where to store the linear space version
  6091. * @returns the unmodified Color3
  6092. */
  6093. toLinearSpaceToRef(convertedColor: Color3): Color3;
  6094. /**
  6095. * Computes a new Color3 converted from the current one to gamma space
  6096. * @returns a new Color3 object
  6097. */
  6098. toGammaSpace(): Color3;
  6099. /**
  6100. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  6101. * @param convertedColor defines the Color3 object where to store the gamma space version
  6102. * @returns the unmodified Color3
  6103. */
  6104. toGammaSpaceToRef(convertedColor: Color3): Color3;
  6105. private static _BlackReadOnly;
  6106. /**
  6107. * Convert Hue, saturation and value to a Color3 (RGB)
  6108. * @param hue defines the hue
  6109. * @param saturation defines the saturation
  6110. * @param value defines the value
  6111. * @param result defines the Color3 where to store the RGB values
  6112. */
  6113. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  6114. /**
  6115. * Creates a new Color3 from the string containing valid hexadecimal values
  6116. * @param hex defines a string containing valid hexadecimal values
  6117. * @returns a new Color3 object
  6118. */
  6119. static FromHexString(hex: string): Color3;
  6120. /**
  6121. * Creates a new Color3 from the starting index of the given array
  6122. * @param array defines the source array
  6123. * @param offset defines an offset in the source array
  6124. * @returns a new Color3 object
  6125. */
  6126. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  6127. /**
  6128. * Creates a new Color3 from the starting index element of the given array
  6129. * @param array defines the source array to read from
  6130. * @param offset defines the offset in the source array
  6131. * @param result defines the target Color3 object
  6132. */
  6133. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  6134. /**
  6135. * Creates a new Color3 from integer values (< 256)
  6136. * @param r defines the red component to read from (value between 0 and 255)
  6137. * @param g defines the green component to read from (value between 0 and 255)
  6138. * @param b defines the blue component to read from (value between 0 and 255)
  6139. * @returns a new Color3 object
  6140. */
  6141. static FromInts(r: number, g: number, b: number): Color3;
  6142. /**
  6143. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  6144. * @param start defines the start Color3 value
  6145. * @param end defines the end Color3 value
  6146. * @param amount defines the gradient value between start and end
  6147. * @returns a new Color3 object
  6148. */
  6149. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  6150. /**
  6151. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  6152. * @param left defines the start value
  6153. * @param right defines the end value
  6154. * @param amount defines the gradient factor
  6155. * @param result defines the Color3 object where to store the result
  6156. */
  6157. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  6158. /**
  6159. * Returns a Color3 value containing a red color
  6160. * @returns a new Color3 object
  6161. */
  6162. static Red(): Color3;
  6163. /**
  6164. * Returns a Color3 value containing a green color
  6165. * @returns a new Color3 object
  6166. */
  6167. static Green(): Color3;
  6168. /**
  6169. * Returns a Color3 value containing a blue color
  6170. * @returns a new Color3 object
  6171. */
  6172. static Blue(): Color3;
  6173. /**
  6174. * Returns a Color3 value containing a black color
  6175. * @returns a new Color3 object
  6176. */
  6177. static Black(): Color3;
  6178. /**
  6179. * Gets a Color3 value containing a black color that must not be updated
  6180. */
  6181. static get BlackReadOnly(): DeepImmutable<Color3>;
  6182. /**
  6183. * Returns a Color3 value containing a white color
  6184. * @returns a new Color3 object
  6185. */
  6186. static White(): Color3;
  6187. /**
  6188. * Returns a Color3 value containing a purple color
  6189. * @returns a new Color3 object
  6190. */
  6191. static Purple(): Color3;
  6192. /**
  6193. * Returns a Color3 value containing a magenta color
  6194. * @returns a new Color3 object
  6195. */
  6196. static Magenta(): Color3;
  6197. /**
  6198. * Returns a Color3 value containing a yellow color
  6199. * @returns a new Color3 object
  6200. */
  6201. static Yellow(): Color3;
  6202. /**
  6203. * Returns a Color3 value containing a gray color
  6204. * @returns a new Color3 object
  6205. */
  6206. static Gray(): Color3;
  6207. /**
  6208. * Returns a Color3 value containing a teal color
  6209. * @returns a new Color3 object
  6210. */
  6211. static Teal(): Color3;
  6212. /**
  6213. * Returns a Color3 value containing a random color
  6214. * @returns a new Color3 object
  6215. */
  6216. static Random(): Color3;
  6217. }
  6218. /**
  6219. * Class used to hold a RBGA color
  6220. */
  6221. export class Color4 {
  6222. /**
  6223. * Defines the red component (between 0 and 1, default is 0)
  6224. */
  6225. r: number;
  6226. /**
  6227. * Defines the green component (between 0 and 1, default is 0)
  6228. */
  6229. g: number;
  6230. /**
  6231. * Defines the blue component (between 0 and 1, default is 0)
  6232. */
  6233. b: number;
  6234. /**
  6235. * Defines the alpha component (between 0 and 1, default is 1)
  6236. */
  6237. a: number;
  6238. /**
  6239. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  6240. * @param r defines the red component (between 0 and 1, default is 0)
  6241. * @param g defines the green component (between 0 and 1, default is 0)
  6242. * @param b defines the blue component (between 0 and 1, default is 0)
  6243. * @param a defines the alpha component (between 0 and 1, default is 1)
  6244. */
  6245. constructor(
  6246. /**
  6247. * Defines the red component (between 0 and 1, default is 0)
  6248. */
  6249. r?: number,
  6250. /**
  6251. * Defines the green component (between 0 and 1, default is 0)
  6252. */
  6253. g?: number,
  6254. /**
  6255. * Defines the blue component (between 0 and 1, default is 0)
  6256. */
  6257. b?: number,
  6258. /**
  6259. * Defines the alpha component (between 0 and 1, default is 1)
  6260. */
  6261. a?: number);
  6262. /**
  6263. * Adds in place the given Color4 values to the current Color4 object
  6264. * @param right defines the second operand
  6265. * @returns the current updated Color4 object
  6266. */
  6267. addInPlace(right: DeepImmutable<Color4>): Color4;
  6268. /**
  6269. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  6270. * @returns the new array
  6271. */
  6272. asArray(): number[];
  6273. /**
  6274. * Stores from the starting index in the given array the Color4 successive values
  6275. * @param array defines the array where to store the r,g,b components
  6276. * @param index defines an optional index in the target array to define where to start storing values
  6277. * @returns the current Color4 object
  6278. */
  6279. toArray(array: number[], index?: number): Color4;
  6280. /**
  6281. * Update the current color with values stored in an array from the starting index of the given array
  6282. * @param array defines the source array
  6283. * @param offset defines an offset in the source array
  6284. * @returns the current Color4 object
  6285. */
  6286. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  6287. /**
  6288. * Determines equality between Color4 objects
  6289. * @param otherColor defines the second operand
  6290. * @returns true if the rgba values are equal to the given ones
  6291. */
  6292. equals(otherColor: DeepImmutable<Color4>): boolean;
  6293. /**
  6294. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  6295. * @param right defines the second operand
  6296. * @returns a new Color4 object
  6297. */
  6298. add(right: DeepImmutable<Color4>): Color4;
  6299. /**
  6300. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  6301. * @param right defines the second operand
  6302. * @returns a new Color4 object
  6303. */
  6304. subtract(right: DeepImmutable<Color4>): Color4;
  6305. /**
  6306. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  6307. * @param right defines the second operand
  6308. * @param result defines the Color4 object where to store the result
  6309. * @returns the current Color4 object
  6310. */
  6311. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  6312. /**
  6313. * Creates a new Color4 with the current Color4 values multiplied by scale
  6314. * @param scale defines the scaling factor to apply
  6315. * @returns a new Color4 object
  6316. */
  6317. scale(scale: number): Color4;
  6318. /**
  6319. * Multiplies the current Color4 values by scale and stores the result in "result"
  6320. * @param scale defines the scaling factor to apply
  6321. * @param result defines the Color4 object where to store the result
  6322. * @returns the current unmodified Color4
  6323. */
  6324. scaleToRef(scale: number, result: Color4): Color4;
  6325. /**
  6326. * Scale the current Color4 values by a factor and add the result to a given Color4
  6327. * @param scale defines the scale factor
  6328. * @param result defines the Color4 object where to store the result
  6329. * @returns the unmodified current Color4
  6330. */
  6331. scaleAndAddToRef(scale: number, result: Color4): Color4;
  6332. /**
  6333. * Clamps the rgb values by the min and max values and stores the result into "result"
  6334. * @param min defines minimum clamping value (default is 0)
  6335. * @param max defines maximum clamping value (default is 1)
  6336. * @param result defines color to store the result into.
  6337. * @returns the cuurent Color4
  6338. */
  6339. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  6340. /**
  6341. * Multipy an Color4 value by another and return a new Color4 object
  6342. * @param color defines the Color4 value to multiply by
  6343. * @returns a new Color4 object
  6344. */
  6345. multiply(color: Color4): Color4;
  6346. /**
  6347. * Multipy a Color4 value by another and push the result in a reference value
  6348. * @param color defines the Color4 value to multiply by
  6349. * @param result defines the Color4 to fill the result in
  6350. * @returns the result Color4
  6351. */
  6352. multiplyToRef(color: Color4, result: Color4): Color4;
  6353. /**
  6354. * Creates a string with the Color4 current values
  6355. * @returns the string representation of the Color4 object
  6356. */
  6357. toString(): string;
  6358. /**
  6359. * Returns the string "Color4"
  6360. * @returns "Color4"
  6361. */
  6362. getClassName(): string;
  6363. /**
  6364. * Compute the Color4 hash code
  6365. * @returns an unique number that can be used to hash Color4 objects
  6366. */
  6367. getHashCode(): number;
  6368. /**
  6369. * Creates a new Color4 copied from the current one
  6370. * @returns a new Color4 object
  6371. */
  6372. clone(): Color4;
  6373. /**
  6374. * Copies the given Color4 values into the current one
  6375. * @param source defines the source Color4 object
  6376. * @returns the current updated Color4 object
  6377. */
  6378. copyFrom(source: Color4): Color4;
  6379. /**
  6380. * Copies the given float values into the current one
  6381. * @param r defines the red component to read from
  6382. * @param g defines the green component to read from
  6383. * @param b defines the blue component to read from
  6384. * @param a defines the alpha component to read from
  6385. * @returns the current updated Color4 object
  6386. */
  6387. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  6388. /**
  6389. * Copies the given float values into the current one
  6390. * @param r defines the red component to read from
  6391. * @param g defines the green component to read from
  6392. * @param b defines the blue component to read from
  6393. * @param a defines the alpha component to read from
  6394. * @returns the current updated Color4 object
  6395. */
  6396. set(r: number, g: number, b: number, a: number): Color4;
  6397. /**
  6398. * Compute the Color4 hexadecimal code as a string
  6399. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  6400. * @returns a string containing the hexadecimal representation of the Color4 object
  6401. */
  6402. toHexString(returnAsColor3?: boolean): string;
  6403. /**
  6404. * Computes a new Color4 converted from the current one to linear space
  6405. * @returns a new Color4 object
  6406. */
  6407. toLinearSpace(): Color4;
  6408. /**
  6409. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  6410. * @param convertedColor defines the Color4 object where to store the linear space version
  6411. * @returns the unmodified Color4
  6412. */
  6413. toLinearSpaceToRef(convertedColor: Color4): Color4;
  6414. /**
  6415. * Computes a new Color4 converted from the current one to gamma space
  6416. * @returns a new Color4 object
  6417. */
  6418. toGammaSpace(): Color4;
  6419. /**
  6420. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  6421. * @param convertedColor defines the Color4 object where to store the gamma space version
  6422. * @returns the unmodified Color4
  6423. */
  6424. toGammaSpaceToRef(convertedColor: Color4): Color4;
  6425. /**
  6426. * Creates a new Color4 from the string containing valid hexadecimal values
  6427. * @param hex defines a string containing valid hexadecimal values
  6428. * @returns a new Color4 object
  6429. */
  6430. static FromHexString(hex: string): Color4;
  6431. /**
  6432. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6433. * @param left defines the start value
  6434. * @param right defines the end value
  6435. * @param amount defines the gradient factor
  6436. * @returns a new Color4 object
  6437. */
  6438. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  6439. /**
  6440. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6441. * @param left defines the start value
  6442. * @param right defines the end value
  6443. * @param amount defines the gradient factor
  6444. * @param result defines the Color4 object where to store data
  6445. */
  6446. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  6447. /**
  6448. * Creates a new Color4 from a Color3 and an alpha value
  6449. * @param color3 defines the source Color3 to read from
  6450. * @param alpha defines the alpha component (1.0 by default)
  6451. * @returns a new Color4 object
  6452. */
  6453. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  6454. /**
  6455. * Creates a new Color4 from the starting index element of the given array
  6456. * @param array defines the source array to read from
  6457. * @param offset defines the offset in the source array
  6458. * @returns a new Color4 object
  6459. */
  6460. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  6461. /**
  6462. * Creates a new Color4 from the starting index element of the given array
  6463. * @param array defines the source array to read from
  6464. * @param offset defines the offset in the source array
  6465. * @param result defines the target Color4 object
  6466. */
  6467. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  6468. /**
  6469. * Creates a new Color3 from integer values (< 256)
  6470. * @param r defines the red component to read from (value between 0 and 255)
  6471. * @param g defines the green component to read from (value between 0 and 255)
  6472. * @param b defines the blue component to read from (value between 0 and 255)
  6473. * @param a defines the alpha component to read from (value between 0 and 255)
  6474. * @returns a new Color3 object
  6475. */
  6476. static FromInts(r: number, g: number, b: number, a: number): Color4;
  6477. /**
  6478. * Check the content of a given array and convert it to an array containing RGBA data
  6479. * If the original array was already containing count * 4 values then it is returned directly
  6480. * @param colors defines the array to check
  6481. * @param count defines the number of RGBA data to expect
  6482. * @returns an array containing count * 4 values (RGBA)
  6483. */
  6484. static CheckColors4(colors: number[], count: number): number[];
  6485. }
  6486. /**
  6487. * @hidden
  6488. */
  6489. export class TmpColors {
  6490. static Color3: Color3[];
  6491. static Color4: Color4[];
  6492. }
  6493. }
  6494. declare module BABYLON {
  6495. /**
  6496. * Defines an interface which represents an animation key frame
  6497. */
  6498. export interface IAnimationKey {
  6499. /**
  6500. * Frame of the key frame
  6501. */
  6502. frame: number;
  6503. /**
  6504. * Value at the specifies key frame
  6505. */
  6506. value: any;
  6507. /**
  6508. * The input tangent for the cubic hermite spline
  6509. */
  6510. inTangent?: any;
  6511. /**
  6512. * The output tangent for the cubic hermite spline
  6513. */
  6514. outTangent?: any;
  6515. /**
  6516. * The animation interpolation type
  6517. */
  6518. interpolation?: AnimationKeyInterpolation;
  6519. }
  6520. /**
  6521. * Enum for the animation key frame interpolation type
  6522. */
  6523. export enum AnimationKeyInterpolation {
  6524. /**
  6525. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  6526. */
  6527. STEP = 1
  6528. }
  6529. }
  6530. declare module BABYLON {
  6531. /**
  6532. * Represents the range of an animation
  6533. */
  6534. export class AnimationRange {
  6535. /**The name of the animation range**/
  6536. name: string;
  6537. /**The starting frame of the animation */
  6538. from: number;
  6539. /**The ending frame of the animation*/
  6540. to: number;
  6541. /**
  6542. * Initializes the range of an animation
  6543. * @param name The name of the animation range
  6544. * @param from The starting frame of the animation
  6545. * @param to The ending frame of the animation
  6546. */
  6547. constructor(
  6548. /**The name of the animation range**/
  6549. name: string,
  6550. /**The starting frame of the animation */
  6551. from: number,
  6552. /**The ending frame of the animation*/
  6553. to: number);
  6554. /**
  6555. * Makes a copy of the animation range
  6556. * @returns A copy of the animation range
  6557. */
  6558. clone(): AnimationRange;
  6559. }
  6560. }
  6561. declare module BABYLON {
  6562. /**
  6563. * Composed of a frame, and an action function
  6564. */
  6565. export class AnimationEvent {
  6566. /** The frame for which the event is triggered **/
  6567. frame: number;
  6568. /** The event to perform when triggered **/
  6569. action: (currentFrame: number) => void;
  6570. /** Specifies if the event should be triggered only once**/
  6571. onlyOnce?: boolean | undefined;
  6572. /**
  6573. * Specifies if the animation event is done
  6574. */
  6575. isDone: boolean;
  6576. /**
  6577. * Initializes the animation event
  6578. * @param frame The frame for which the event is triggered
  6579. * @param action The event to perform when triggered
  6580. * @param onlyOnce Specifies if the event should be triggered only once
  6581. */
  6582. constructor(
  6583. /** The frame for which the event is triggered **/
  6584. frame: number,
  6585. /** The event to perform when triggered **/
  6586. action: (currentFrame: number) => void,
  6587. /** Specifies if the event should be triggered only once**/
  6588. onlyOnce?: boolean | undefined);
  6589. /** @hidden */
  6590. _clone(): AnimationEvent;
  6591. }
  6592. }
  6593. declare module BABYLON {
  6594. /**
  6595. * Interface used to define a behavior
  6596. */
  6597. export interface Behavior<T> {
  6598. /** gets or sets behavior's name */
  6599. name: string;
  6600. /**
  6601. * Function called when the behavior needs to be initialized (after attaching it to a target)
  6602. */
  6603. init(): void;
  6604. /**
  6605. * Called when the behavior is attached to a target
  6606. * @param target defines the target where the behavior is attached to
  6607. */
  6608. attach(target: T): void;
  6609. /**
  6610. * Called when the behavior is detached from its target
  6611. */
  6612. detach(): void;
  6613. }
  6614. /**
  6615. * Interface implemented by classes supporting behaviors
  6616. */
  6617. export interface IBehaviorAware<T> {
  6618. /**
  6619. * Attach a behavior
  6620. * @param behavior defines the behavior to attach
  6621. * @returns the current host
  6622. */
  6623. addBehavior(behavior: Behavior<T>): T;
  6624. /**
  6625. * Remove a behavior from the current object
  6626. * @param behavior defines the behavior to detach
  6627. * @returns the current host
  6628. */
  6629. removeBehavior(behavior: Behavior<T>): T;
  6630. /**
  6631. * Gets a behavior using its name to search
  6632. * @param name defines the name to search
  6633. * @returns the behavior or null if not found
  6634. */
  6635. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  6636. }
  6637. }
  6638. declare module BABYLON {
  6639. /**
  6640. * Class used to store data that will be store in GPU memory
  6641. */
  6642. export class Buffer {
  6643. private _engine;
  6644. private _buffer;
  6645. /** @hidden */
  6646. _data: Nullable<DataArray>;
  6647. private _updatable;
  6648. private _instanced;
  6649. private _divisor;
  6650. /**
  6651. * Gets the byte stride.
  6652. */
  6653. readonly byteStride: number;
  6654. /**
  6655. * Constructor
  6656. * @param engine the engine
  6657. * @param data the data to use for this buffer
  6658. * @param updatable whether the data is updatable
  6659. * @param stride the stride (optional)
  6660. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6661. * @param instanced whether the buffer is instanced (optional)
  6662. * @param useBytes set to true if the stride in in bytes (optional)
  6663. * @param divisor sets an optional divisor for instances (1 by default)
  6664. */
  6665. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6666. /**
  6667. * Create a new VertexBuffer based on the current buffer
  6668. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6669. * @param offset defines offset in the buffer (0 by default)
  6670. * @param size defines the size in floats of attributes (position is 3 for instance)
  6671. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6672. * @param instanced defines if the vertex buffer contains indexed data
  6673. * @param useBytes defines if the offset and stride are in bytes *
  6674. * @param divisor sets an optional divisor for instances (1 by default)
  6675. * @returns the new vertex buffer
  6676. */
  6677. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6678. /**
  6679. * Gets a boolean indicating if the Buffer is updatable?
  6680. * @returns true if the buffer is updatable
  6681. */
  6682. isUpdatable(): boolean;
  6683. /**
  6684. * Gets current buffer's data
  6685. * @returns a DataArray or null
  6686. */
  6687. getData(): Nullable<DataArray>;
  6688. /**
  6689. * Gets underlying native buffer
  6690. * @returns underlying native buffer
  6691. */
  6692. getBuffer(): Nullable<DataBuffer>;
  6693. /**
  6694. * Gets the stride in float32 units (i.e. byte stride / 4).
  6695. * May not be an integer if the byte stride is not divisible by 4.
  6696. * @returns the stride in float32 units
  6697. * @deprecated Please use byteStride instead.
  6698. */
  6699. getStrideSize(): number;
  6700. /**
  6701. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6702. * @param data defines the data to store
  6703. */
  6704. create(data?: Nullable<DataArray>): void;
  6705. /** @hidden */
  6706. _rebuild(): void;
  6707. /**
  6708. * Update current buffer data
  6709. * @param data defines the data to store
  6710. */
  6711. update(data: DataArray): void;
  6712. /**
  6713. * Updates the data directly.
  6714. * @param data the new data
  6715. * @param offset the new offset
  6716. * @param vertexCount the vertex count (optional)
  6717. * @param useBytes set to true if the offset is in bytes
  6718. */
  6719. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6720. /**
  6721. * Release all resources
  6722. */
  6723. dispose(): void;
  6724. }
  6725. /**
  6726. * Specialized buffer used to store vertex data
  6727. */
  6728. export class VertexBuffer {
  6729. /** @hidden */
  6730. _buffer: Buffer;
  6731. private _kind;
  6732. private _size;
  6733. private _ownsBuffer;
  6734. private _instanced;
  6735. private _instanceDivisor;
  6736. /**
  6737. * The byte type.
  6738. */
  6739. static readonly BYTE: number;
  6740. /**
  6741. * The unsigned byte type.
  6742. */
  6743. static readonly UNSIGNED_BYTE: number;
  6744. /**
  6745. * The short type.
  6746. */
  6747. static readonly SHORT: number;
  6748. /**
  6749. * The unsigned short type.
  6750. */
  6751. static readonly UNSIGNED_SHORT: number;
  6752. /**
  6753. * The integer type.
  6754. */
  6755. static readonly INT: number;
  6756. /**
  6757. * The unsigned integer type.
  6758. */
  6759. static readonly UNSIGNED_INT: number;
  6760. /**
  6761. * The float type.
  6762. */
  6763. static readonly FLOAT: number;
  6764. /**
  6765. * Gets or sets the instance divisor when in instanced mode
  6766. */
  6767. get instanceDivisor(): number;
  6768. set instanceDivisor(value: number);
  6769. /**
  6770. * Gets the byte stride.
  6771. */
  6772. readonly byteStride: number;
  6773. /**
  6774. * Gets the byte offset.
  6775. */
  6776. readonly byteOffset: number;
  6777. /**
  6778. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6779. */
  6780. readonly normalized: boolean;
  6781. /**
  6782. * Gets the data type of each component in the array.
  6783. */
  6784. readonly type: number;
  6785. /**
  6786. * Constructor
  6787. * @param engine the engine
  6788. * @param data the data to use for this vertex buffer
  6789. * @param kind the vertex buffer kind
  6790. * @param updatable whether the data is updatable
  6791. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6792. * @param stride the stride (optional)
  6793. * @param instanced whether the buffer is instanced (optional)
  6794. * @param offset the offset of the data (optional)
  6795. * @param size the number of components (optional)
  6796. * @param type the type of the component (optional)
  6797. * @param normalized whether the data contains normalized data (optional)
  6798. * @param useBytes set to true if stride and offset are in bytes (optional)
  6799. * @param divisor defines the instance divisor to use (1 by default)
  6800. */
  6801. constructor(engine: any, data: DataArray | Buffer, kind: string, updatable: boolean, postponeInternalCreation?: boolean, stride?: number, instanced?: boolean, offset?: number, size?: number, type?: number, normalized?: boolean, useBytes?: boolean, divisor?: number);
  6802. /** @hidden */
  6803. _rebuild(): void;
  6804. /**
  6805. * Returns the kind of the VertexBuffer (string)
  6806. * @returns a string
  6807. */
  6808. getKind(): string;
  6809. /**
  6810. * Gets a boolean indicating if the VertexBuffer is updatable?
  6811. * @returns true if the buffer is updatable
  6812. */
  6813. isUpdatable(): boolean;
  6814. /**
  6815. * Gets current buffer's data
  6816. * @returns a DataArray or null
  6817. */
  6818. getData(): Nullable<DataArray>;
  6819. /**
  6820. * Gets underlying native buffer
  6821. * @returns underlying native buffer
  6822. */
  6823. getBuffer(): Nullable<DataBuffer>;
  6824. /**
  6825. * Gets the stride in float32 units (i.e. byte stride / 4).
  6826. * May not be an integer if the byte stride is not divisible by 4.
  6827. * @returns the stride in float32 units
  6828. * @deprecated Please use byteStride instead.
  6829. */
  6830. getStrideSize(): number;
  6831. /**
  6832. * Returns the offset as a multiple of the type byte length.
  6833. * @returns the offset in bytes
  6834. * @deprecated Please use byteOffset instead.
  6835. */
  6836. getOffset(): number;
  6837. /**
  6838. * Returns the number of components per vertex attribute (integer)
  6839. * @returns the size in float
  6840. */
  6841. getSize(): number;
  6842. /**
  6843. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6844. * @returns true if this buffer is instanced
  6845. */
  6846. getIsInstanced(): boolean;
  6847. /**
  6848. * Returns the instancing divisor, zero for non-instanced (integer).
  6849. * @returns a number
  6850. */
  6851. getInstanceDivisor(): number;
  6852. /**
  6853. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6854. * @param data defines the data to store
  6855. */
  6856. create(data?: DataArray): void;
  6857. /**
  6858. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6859. * This function will create a new buffer if the current one is not updatable
  6860. * @param data defines the data to store
  6861. */
  6862. update(data: DataArray): void;
  6863. /**
  6864. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6865. * Returns the directly updated WebGLBuffer.
  6866. * @param data the new data
  6867. * @param offset the new offset
  6868. * @param useBytes set to true if the offset is in bytes
  6869. */
  6870. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6871. /**
  6872. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6873. */
  6874. dispose(): void;
  6875. /**
  6876. * Enumerates each value of this vertex buffer as numbers.
  6877. * @param count the number of values to enumerate
  6878. * @param callback the callback function called for each value
  6879. */
  6880. forEach(count: number, callback: (value: number, index: number) => void): void;
  6881. /**
  6882. * Positions
  6883. */
  6884. static readonly PositionKind: string;
  6885. /**
  6886. * Normals
  6887. */
  6888. static readonly NormalKind: string;
  6889. /**
  6890. * Tangents
  6891. */
  6892. static readonly TangentKind: string;
  6893. /**
  6894. * Texture coordinates
  6895. */
  6896. static readonly UVKind: string;
  6897. /**
  6898. * Texture coordinates 2
  6899. */
  6900. static readonly UV2Kind: string;
  6901. /**
  6902. * Texture coordinates 3
  6903. */
  6904. static readonly UV3Kind: string;
  6905. /**
  6906. * Texture coordinates 4
  6907. */
  6908. static readonly UV4Kind: string;
  6909. /**
  6910. * Texture coordinates 5
  6911. */
  6912. static readonly UV5Kind: string;
  6913. /**
  6914. * Texture coordinates 6
  6915. */
  6916. static readonly UV6Kind: string;
  6917. /**
  6918. * Colors
  6919. */
  6920. static readonly ColorKind: string;
  6921. /**
  6922. * Matrix indices (for bones)
  6923. */
  6924. static readonly MatricesIndicesKind: string;
  6925. /**
  6926. * Matrix weights (for bones)
  6927. */
  6928. static readonly MatricesWeightsKind: string;
  6929. /**
  6930. * Additional matrix indices (for bones)
  6931. */
  6932. static readonly MatricesIndicesExtraKind: string;
  6933. /**
  6934. * Additional matrix weights (for bones)
  6935. */
  6936. static readonly MatricesWeightsExtraKind: string;
  6937. /**
  6938. * Deduces the stride given a kind.
  6939. * @param kind The kind string to deduce
  6940. * @returns The deduced stride
  6941. */
  6942. static DeduceStride(kind: string): number;
  6943. /**
  6944. * Gets the byte length of the given type.
  6945. * @param type the type
  6946. * @returns the number of bytes
  6947. */
  6948. static GetTypeByteLength(type: number): number;
  6949. /**
  6950. * Enumerates each value of the given parameters as numbers.
  6951. * @param data the data to enumerate
  6952. * @param byteOffset the byte offset of the data
  6953. * @param byteStride the byte stride of the data
  6954. * @param componentCount the number of components per element
  6955. * @param componentType the type of the component
  6956. * @param count the number of values to enumerate
  6957. * @param normalized whether the data is normalized
  6958. * @param callback the callback function called for each value
  6959. */
  6960. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6961. private static _GetFloatValue;
  6962. }
  6963. }
  6964. declare module BABYLON {
  6965. /**
  6966. * @hidden
  6967. */
  6968. export class IntersectionInfo {
  6969. bu: Nullable<number>;
  6970. bv: Nullable<number>;
  6971. distance: number;
  6972. faceId: number;
  6973. subMeshId: number;
  6974. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6975. }
  6976. }
  6977. declare module BABYLON {
  6978. /**
  6979. * Class used to store bounding sphere information
  6980. */
  6981. export class BoundingSphere {
  6982. /**
  6983. * Gets the center of the bounding sphere in local space
  6984. */
  6985. readonly center: Vector3;
  6986. /**
  6987. * Radius of the bounding sphere in local space
  6988. */
  6989. radius: number;
  6990. /**
  6991. * Gets the center of the bounding sphere in world space
  6992. */
  6993. readonly centerWorld: Vector3;
  6994. /**
  6995. * Radius of the bounding sphere in world space
  6996. */
  6997. radiusWorld: number;
  6998. /**
  6999. * Gets the minimum vector in local space
  7000. */
  7001. readonly minimum: Vector3;
  7002. /**
  7003. * Gets the maximum vector in local space
  7004. */
  7005. readonly maximum: Vector3;
  7006. private _worldMatrix;
  7007. private static readonly TmpVector3;
  7008. /**
  7009. * Creates a new bounding sphere
  7010. * @param min defines the minimum vector (in local space)
  7011. * @param max defines the maximum vector (in local space)
  7012. * @param worldMatrix defines the new world matrix
  7013. */
  7014. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7015. /**
  7016. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  7017. * @param min defines the new minimum vector (in local space)
  7018. * @param max defines the new maximum vector (in local space)
  7019. * @param worldMatrix defines the new world matrix
  7020. */
  7021. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7022. /**
  7023. * Scale the current bounding sphere by applying a scale factor
  7024. * @param factor defines the scale factor to apply
  7025. * @returns the current bounding box
  7026. */
  7027. scale(factor: number): BoundingSphere;
  7028. /**
  7029. * Gets the world matrix of the bounding box
  7030. * @returns a matrix
  7031. */
  7032. getWorldMatrix(): DeepImmutable<Matrix>;
  7033. /** @hidden */
  7034. _update(worldMatrix: DeepImmutable<Matrix>): void;
  7035. /**
  7036. * Tests if the bounding sphere is intersecting the frustum planes
  7037. * @param frustumPlanes defines the frustum planes to test
  7038. * @returns true if there is an intersection
  7039. */
  7040. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7041. /**
  7042. * Tests if the bounding sphere center is in between the frustum planes.
  7043. * Used for optimistic fast inclusion.
  7044. * @param frustumPlanes defines the frustum planes to test
  7045. * @returns true if the sphere center is in between the frustum planes
  7046. */
  7047. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7048. /**
  7049. * Tests if a point is inside the bounding sphere
  7050. * @param point defines the point to test
  7051. * @returns true if the point is inside the bounding sphere
  7052. */
  7053. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7054. /**
  7055. * Checks if two sphere intersct
  7056. * @param sphere0 sphere 0
  7057. * @param sphere1 sphere 1
  7058. * @returns true if the speres intersect
  7059. */
  7060. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  7061. }
  7062. }
  7063. declare module BABYLON {
  7064. /**
  7065. * Class used to store bounding box information
  7066. */
  7067. export class BoundingBox implements ICullable {
  7068. /**
  7069. * Gets the 8 vectors representing the bounding box in local space
  7070. */
  7071. readonly vectors: Vector3[];
  7072. /**
  7073. * Gets the center of the bounding box in local space
  7074. */
  7075. readonly center: Vector3;
  7076. /**
  7077. * Gets the center of the bounding box in world space
  7078. */
  7079. readonly centerWorld: Vector3;
  7080. /**
  7081. * Gets the extend size in local space
  7082. */
  7083. readonly extendSize: Vector3;
  7084. /**
  7085. * Gets the extend size in world space
  7086. */
  7087. readonly extendSizeWorld: Vector3;
  7088. /**
  7089. * Gets the OBB (object bounding box) directions
  7090. */
  7091. readonly directions: Vector3[];
  7092. /**
  7093. * Gets the 8 vectors representing the bounding box in world space
  7094. */
  7095. readonly vectorsWorld: Vector3[];
  7096. /**
  7097. * Gets the minimum vector in world space
  7098. */
  7099. readonly minimumWorld: Vector3;
  7100. /**
  7101. * Gets the maximum vector in world space
  7102. */
  7103. readonly maximumWorld: Vector3;
  7104. /**
  7105. * Gets the minimum vector in local space
  7106. */
  7107. readonly minimum: Vector3;
  7108. /**
  7109. * Gets the maximum vector in local space
  7110. */
  7111. readonly maximum: Vector3;
  7112. private _worldMatrix;
  7113. private static readonly TmpVector3;
  7114. /**
  7115. * @hidden
  7116. */
  7117. _tag: number;
  7118. /**
  7119. * Creates a new bounding box
  7120. * @param min defines the minimum vector (in local space)
  7121. * @param max defines the maximum vector (in local space)
  7122. * @param worldMatrix defines the new world matrix
  7123. */
  7124. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7125. /**
  7126. * Recreates the entire bounding box from scratch as if we call the constructor in place
  7127. * @param min defines the new minimum vector (in local space)
  7128. * @param max defines the new maximum vector (in local space)
  7129. * @param worldMatrix defines the new world matrix
  7130. */
  7131. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7132. /**
  7133. * Scale the current bounding box by applying a scale factor
  7134. * @param factor defines the scale factor to apply
  7135. * @returns the current bounding box
  7136. */
  7137. scale(factor: number): BoundingBox;
  7138. /**
  7139. * Gets the world matrix of the bounding box
  7140. * @returns a matrix
  7141. */
  7142. getWorldMatrix(): DeepImmutable<Matrix>;
  7143. /** @hidden */
  7144. _update(world: DeepImmutable<Matrix>): void;
  7145. /**
  7146. * Tests if the bounding box is intersecting the frustum planes
  7147. * @param frustumPlanes defines the frustum planes to test
  7148. * @returns true if there is an intersection
  7149. */
  7150. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7151. /**
  7152. * Tests if the bounding box is entirely inside the frustum planes
  7153. * @param frustumPlanes defines the frustum planes to test
  7154. * @returns true if there is an inclusion
  7155. */
  7156. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7157. /**
  7158. * Tests if a point is inside the bounding box
  7159. * @param point defines the point to test
  7160. * @returns true if the point is inside the bounding box
  7161. */
  7162. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7163. /**
  7164. * Tests if the bounding box intersects with a bounding sphere
  7165. * @param sphere defines the sphere to test
  7166. * @returns true if there is an intersection
  7167. */
  7168. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  7169. /**
  7170. * Tests if the bounding box intersects with a box defined by a min and max vectors
  7171. * @param min defines the min vector to use
  7172. * @param max defines the max vector to use
  7173. * @returns true if there is an intersection
  7174. */
  7175. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  7176. /**
  7177. * Tests if two bounding boxes are intersections
  7178. * @param box0 defines the first box to test
  7179. * @param box1 defines the second box to test
  7180. * @returns true if there is an intersection
  7181. */
  7182. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  7183. /**
  7184. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  7185. * @param minPoint defines the minimum vector of the bounding box
  7186. * @param maxPoint defines the maximum vector of the bounding box
  7187. * @param sphereCenter defines the sphere center
  7188. * @param sphereRadius defines the sphere radius
  7189. * @returns true if there is an intersection
  7190. */
  7191. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  7192. /**
  7193. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  7194. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7195. * @param frustumPlanes defines the frustum planes to test
  7196. * @return true if there is an inclusion
  7197. */
  7198. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7199. /**
  7200. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  7201. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7202. * @param frustumPlanes defines the frustum planes to test
  7203. * @return true if there is an intersection
  7204. */
  7205. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7206. }
  7207. }
  7208. declare module BABYLON {
  7209. /** @hidden */
  7210. export class Collider {
  7211. /** Define if a collision was found */
  7212. collisionFound: boolean;
  7213. /**
  7214. * Define last intersection point in local space
  7215. */
  7216. intersectionPoint: Vector3;
  7217. /**
  7218. * Define last collided mesh
  7219. */
  7220. collidedMesh: Nullable<AbstractMesh>;
  7221. private _collisionPoint;
  7222. private _planeIntersectionPoint;
  7223. private _tempVector;
  7224. private _tempVector2;
  7225. private _tempVector3;
  7226. private _tempVector4;
  7227. private _edge;
  7228. private _baseToVertex;
  7229. private _destinationPoint;
  7230. private _slidePlaneNormal;
  7231. private _displacementVector;
  7232. /** @hidden */
  7233. _radius: Vector3;
  7234. /** @hidden */
  7235. _retry: number;
  7236. private _velocity;
  7237. private _basePoint;
  7238. private _epsilon;
  7239. /** @hidden */
  7240. _velocityWorldLength: number;
  7241. /** @hidden */
  7242. _basePointWorld: Vector3;
  7243. private _velocityWorld;
  7244. private _normalizedVelocity;
  7245. /** @hidden */
  7246. _initialVelocity: Vector3;
  7247. /** @hidden */
  7248. _initialPosition: Vector3;
  7249. private _nearestDistance;
  7250. private _collisionMask;
  7251. get collisionMask(): number;
  7252. set collisionMask(mask: number);
  7253. /**
  7254. * Gets the plane normal used to compute the sliding response (in local space)
  7255. */
  7256. get slidePlaneNormal(): Vector3;
  7257. /** @hidden */
  7258. _initialize(source: Vector3, dir: Vector3, e: number): void;
  7259. /** @hidden */
  7260. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  7261. /** @hidden */
  7262. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7263. /** @hidden */
  7264. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7265. /** @hidden */
  7266. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7267. /** @hidden */
  7268. _getResponse(pos: Vector3, vel: Vector3): void;
  7269. }
  7270. }
  7271. declare module BABYLON {
  7272. /**
  7273. * Interface for cullable objects
  7274. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7275. */
  7276. export interface ICullable {
  7277. /**
  7278. * Checks if the object or part of the object is in the frustum
  7279. * @param frustumPlanes Camera near/planes
  7280. * @returns true if the object is in frustum otherwise false
  7281. */
  7282. isInFrustum(frustumPlanes: Plane[]): boolean;
  7283. /**
  7284. * Checks if a cullable object (mesh...) is in the camera frustum
  7285. * Unlike isInFrustum this cheks the full bounding box
  7286. * @param frustumPlanes Camera near/planes
  7287. * @returns true if the object is in frustum otherwise false
  7288. */
  7289. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7290. }
  7291. /**
  7292. * Info for a bounding data of a mesh
  7293. */
  7294. export class BoundingInfo implements ICullable {
  7295. /**
  7296. * Bounding box for the mesh
  7297. */
  7298. readonly boundingBox: BoundingBox;
  7299. /**
  7300. * Bounding sphere for the mesh
  7301. */
  7302. readonly boundingSphere: BoundingSphere;
  7303. private _isLocked;
  7304. private static readonly TmpVector3;
  7305. /**
  7306. * Constructs bounding info
  7307. * @param minimum min vector of the bounding box/sphere
  7308. * @param maximum max vector of the bounding box/sphere
  7309. * @param worldMatrix defines the new world matrix
  7310. */
  7311. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7312. /**
  7313. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7314. * @param min defines the new minimum vector (in local space)
  7315. * @param max defines the new maximum vector (in local space)
  7316. * @param worldMatrix defines the new world matrix
  7317. */
  7318. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7319. /**
  7320. * min vector of the bounding box/sphere
  7321. */
  7322. get minimum(): Vector3;
  7323. /**
  7324. * max vector of the bounding box/sphere
  7325. */
  7326. get maximum(): Vector3;
  7327. /**
  7328. * If the info is locked and won't be updated to avoid perf overhead
  7329. */
  7330. get isLocked(): boolean;
  7331. set isLocked(value: boolean);
  7332. /**
  7333. * Updates the bounding sphere and box
  7334. * @param world world matrix to be used to update
  7335. */
  7336. update(world: DeepImmutable<Matrix>): void;
  7337. /**
  7338. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7339. * @param center New center of the bounding info
  7340. * @param extend New extend of the bounding info
  7341. * @returns the current bounding info
  7342. */
  7343. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7344. /**
  7345. * Scale the current bounding info by applying a scale factor
  7346. * @param factor defines the scale factor to apply
  7347. * @returns the current bounding info
  7348. */
  7349. scale(factor: number): BoundingInfo;
  7350. /**
  7351. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7352. * @param frustumPlanes defines the frustum to test
  7353. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7354. * @returns true if the bounding info is in the frustum planes
  7355. */
  7356. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7357. /**
  7358. * Gets the world distance between the min and max points of the bounding box
  7359. */
  7360. get diagonalLength(): number;
  7361. /**
  7362. * Checks if a cullable object (mesh...) is in the camera frustum
  7363. * Unlike isInFrustum this cheks the full bounding box
  7364. * @param frustumPlanes Camera near/planes
  7365. * @returns true if the object is in frustum otherwise false
  7366. */
  7367. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7368. /** @hidden */
  7369. _checkCollision(collider: Collider): boolean;
  7370. /**
  7371. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7372. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7373. * @param point the point to check intersection with
  7374. * @returns if the point intersects
  7375. */
  7376. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7377. /**
  7378. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7379. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7380. * @param boundingInfo the bounding info to check intersection with
  7381. * @param precise if the intersection should be done using OBB
  7382. * @returns if the bounding info intersects
  7383. */
  7384. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7385. }
  7386. }
  7387. declare module BABYLON {
  7388. /**
  7389. * Extracts minimum and maximum values from a list of indexed positions
  7390. * @param positions defines the positions to use
  7391. * @param indices defines the indices to the positions
  7392. * @param indexStart defines the start index
  7393. * @param indexCount defines the end index
  7394. * @param bias defines bias value to add to the result
  7395. * @return minimum and maximum values
  7396. */
  7397. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7398. minimum: Vector3;
  7399. maximum: Vector3;
  7400. };
  7401. /**
  7402. * Extracts minimum and maximum values from a list of positions
  7403. * @param positions defines the positions to use
  7404. * @param start defines the start index in the positions array
  7405. * @param count defines the number of positions to handle
  7406. * @param bias defines bias value to add to the result
  7407. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7408. * @return minimum and maximum values
  7409. */
  7410. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7411. minimum: Vector3;
  7412. maximum: Vector3;
  7413. };
  7414. }
  7415. declare module BABYLON {
  7416. /**
  7417. * Class used to manipulate GUIDs
  7418. */
  7419. export class GUID {
  7420. /**
  7421. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  7422. * Be aware Math.random() could cause collisions, but:
  7423. * "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"
  7424. * @returns a pseudo random id
  7425. */
  7426. static RandomId(): string;
  7427. }
  7428. }
  7429. declare module BABYLON {
  7430. /**
  7431. * Base class of all the textures in babylon.
  7432. * It groups all the common properties the materials, post process, lights... might need
  7433. * in order to make a correct use of the texture.
  7434. */
  7435. export class BaseTexture extends ThinTexture implements IAnimatable {
  7436. /**
  7437. * Default anisotropic filtering level for the application.
  7438. * It is set to 4 as a good tradeoff between perf and quality.
  7439. */
  7440. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  7441. /**
  7442. * Gets or sets the unique id of the texture
  7443. */
  7444. uniqueId: number;
  7445. /**
  7446. * Define the name of the texture.
  7447. */
  7448. name: string;
  7449. /**
  7450. * Gets or sets an object used to store user defined information.
  7451. */
  7452. metadata: any;
  7453. /**
  7454. * For internal use only. Please do not use.
  7455. */
  7456. reservedDataStore: any;
  7457. private _hasAlpha;
  7458. /**
  7459. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  7460. */
  7461. set hasAlpha(value: boolean);
  7462. get hasAlpha(): boolean;
  7463. /**
  7464. * Defines if the alpha value should be determined via the rgb values.
  7465. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  7466. */
  7467. getAlphaFromRGB: boolean;
  7468. /**
  7469. * Intensity or strength of the texture.
  7470. * It is commonly used by materials to fine tune the intensity of the texture
  7471. */
  7472. level: number;
  7473. /**
  7474. * Define the UV chanel to use starting from 0 and defaulting to 0.
  7475. * This is part of the texture as textures usually maps to one uv set.
  7476. */
  7477. coordinatesIndex: number;
  7478. protected _coordinatesMode: number;
  7479. /**
  7480. * How a texture is mapped.
  7481. *
  7482. * | Value | Type | Description |
  7483. * | ----- | ----------------------------------- | ----------- |
  7484. * | 0 | EXPLICIT_MODE | |
  7485. * | 1 | SPHERICAL_MODE | |
  7486. * | 2 | PLANAR_MODE | |
  7487. * | 3 | CUBIC_MODE | |
  7488. * | 4 | PROJECTION_MODE | |
  7489. * | 5 | SKYBOX_MODE | |
  7490. * | 6 | INVCUBIC_MODE | |
  7491. * | 7 | EQUIRECTANGULAR_MODE | |
  7492. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  7493. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  7494. */
  7495. set coordinatesMode(value: number);
  7496. get coordinatesMode(): number;
  7497. /**
  7498. * | Value | Type | Description |
  7499. * | ----- | ------------------ | ----------- |
  7500. * | 0 | CLAMP_ADDRESSMODE | |
  7501. * | 1 | WRAP_ADDRESSMODE | |
  7502. * | 2 | MIRROR_ADDRESSMODE | |
  7503. */
  7504. get wrapU(): number;
  7505. set wrapU(value: number);
  7506. /**
  7507. * | Value | Type | Description |
  7508. * | ----- | ------------------ | ----------- |
  7509. * | 0 | CLAMP_ADDRESSMODE | |
  7510. * | 1 | WRAP_ADDRESSMODE | |
  7511. * | 2 | MIRROR_ADDRESSMODE | |
  7512. */
  7513. get wrapV(): number;
  7514. set wrapV(value: number);
  7515. /**
  7516. * | Value | Type | Description |
  7517. * | ----- | ------------------ | ----------- |
  7518. * | 0 | CLAMP_ADDRESSMODE | |
  7519. * | 1 | WRAP_ADDRESSMODE | |
  7520. * | 2 | MIRROR_ADDRESSMODE | |
  7521. */
  7522. wrapR: number;
  7523. /**
  7524. * With compliant hardware and browser (supporting anisotropic filtering)
  7525. * this defines the level of anisotropic filtering in the texture.
  7526. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  7527. */
  7528. anisotropicFilteringLevel: number;
  7529. private _isCube;
  7530. /**
  7531. * Define if the texture is a cube texture or if false a 2d texture.
  7532. */
  7533. get isCube(): boolean;
  7534. set isCube(value: boolean);
  7535. /**
  7536. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  7537. */
  7538. get is3D(): boolean;
  7539. set is3D(value: boolean);
  7540. /**
  7541. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  7542. */
  7543. get is2DArray(): boolean;
  7544. set is2DArray(value: boolean);
  7545. private _gammaSpace;
  7546. /**
  7547. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  7548. * HDR texture are usually stored in linear space.
  7549. * This only impacts the PBR and Background materials
  7550. */
  7551. get gammaSpace(): boolean;
  7552. set gammaSpace(gamma: boolean);
  7553. /**
  7554. * Gets or sets whether or not the texture contains RGBD data.
  7555. */
  7556. get isRGBD(): boolean;
  7557. set isRGBD(value: boolean);
  7558. /**
  7559. * Is Z inverted in the texture (useful in a cube texture).
  7560. */
  7561. invertZ: boolean;
  7562. /**
  7563. * Are mip maps generated for this texture or not.
  7564. */
  7565. get noMipmap(): boolean;
  7566. /**
  7567. * @hidden
  7568. */
  7569. lodLevelInAlpha: boolean;
  7570. /**
  7571. * With prefiltered texture, defined the offset used during the prefiltering steps.
  7572. */
  7573. get lodGenerationOffset(): number;
  7574. set lodGenerationOffset(value: number);
  7575. /**
  7576. * With prefiltered texture, defined the scale used during the prefiltering steps.
  7577. */
  7578. get lodGenerationScale(): number;
  7579. set lodGenerationScale(value: number);
  7580. /**
  7581. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  7582. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  7583. * average roughness values.
  7584. */
  7585. get linearSpecularLOD(): boolean;
  7586. set linearSpecularLOD(value: boolean);
  7587. /**
  7588. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  7589. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  7590. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  7591. */
  7592. get irradianceTexture(): Nullable<BaseTexture>;
  7593. set irradianceTexture(value: Nullable<BaseTexture>);
  7594. /**
  7595. * Define if the texture is a render target.
  7596. */
  7597. isRenderTarget: boolean;
  7598. /**
  7599. * Define the unique id of the texture in the scene.
  7600. */
  7601. get uid(): string;
  7602. /** @hidden */
  7603. _prefiltered: boolean;
  7604. /**
  7605. * Return a string representation of the texture.
  7606. * @returns the texture as a string
  7607. */
  7608. toString(): string;
  7609. /**
  7610. * Get the class name of the texture.
  7611. * @returns "BaseTexture"
  7612. */
  7613. getClassName(): string;
  7614. /**
  7615. * Define the list of animation attached to the texture.
  7616. */
  7617. animations: Animation[];
  7618. /**
  7619. * An event triggered when the texture is disposed.
  7620. */
  7621. onDisposeObservable: Observable<BaseTexture>;
  7622. private _onDisposeObserver;
  7623. /**
  7624. * Callback triggered when the texture has been disposed.
  7625. * Kept for back compatibility, you can use the onDisposeObservable instead.
  7626. */
  7627. set onDispose(callback: () => void);
  7628. protected _scene: Nullable<Scene>;
  7629. /** @hidden */
  7630. _texture: Nullable<InternalTexture>;
  7631. private _uid;
  7632. /**
  7633. * Define if the texture is preventinga material to render or not.
  7634. * If not and the texture is not ready, the engine will use a default black texture instead.
  7635. */
  7636. get isBlocking(): boolean;
  7637. /**
  7638. * Instantiates a new BaseTexture.
  7639. * Base class of all the textures in babylon.
  7640. * It groups all the common properties the materials, post process, lights... might need
  7641. * in order to make a correct use of the texture.
  7642. * @param sceneOrEngine Define the scene or engine the texture blongs to
  7643. */
  7644. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  7645. /**
  7646. * Get the scene the texture belongs to.
  7647. * @returns the scene or null if undefined
  7648. */
  7649. getScene(): Nullable<Scene>;
  7650. /** @hidden */
  7651. protected _getEngine(): Nullable<ThinEngine>;
  7652. /**
  7653. * Checks if the texture has the same transform matrix than another texture
  7654. * @param texture texture to check against
  7655. * @returns true if the transforms are the same, else false
  7656. */
  7657. checkTransformsAreIdentical(texture: Nullable<BaseTexture>): boolean;
  7658. /**
  7659. * Get the texture transform matrix used to offset tile the texture for istance.
  7660. * @returns the transformation matrix
  7661. */
  7662. getTextureMatrix(): Matrix;
  7663. /**
  7664. * Get the texture reflection matrix used to rotate/transform the reflection.
  7665. * @returns the reflection matrix
  7666. */
  7667. getReflectionTextureMatrix(): Matrix;
  7668. /**
  7669. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  7670. * @returns true if ready or not blocking
  7671. */
  7672. isReadyOrNotBlocking(): boolean;
  7673. /**
  7674. * Scales the texture if is `canRescale()`
  7675. * @param ratio the resize factor we want to use to rescale
  7676. */
  7677. scale(ratio: number): void;
  7678. /**
  7679. * Get if the texture can rescale.
  7680. */
  7681. get canRescale(): boolean;
  7682. /** @hidden */
  7683. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  7684. /** @hidden */
  7685. _rebuild(): void;
  7686. /**
  7687. * Clones the texture.
  7688. * @returns the cloned texture
  7689. */
  7690. clone(): Nullable<BaseTexture>;
  7691. /**
  7692. * Get the texture underlying type (INT, FLOAT...)
  7693. */
  7694. get textureType(): number;
  7695. /**
  7696. * Get the texture underlying format (RGB, RGBA...)
  7697. */
  7698. get textureFormat(): number;
  7699. /**
  7700. * Indicates that textures need to be re-calculated for all materials
  7701. */
  7702. protected _markAllSubMeshesAsTexturesDirty(): void;
  7703. /**
  7704. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  7705. * This will returns an RGBA array buffer containing either in values (0-255) or
  7706. * float values (0-1) depending of the underlying buffer type.
  7707. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  7708. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  7709. * @param buffer defines a user defined buffer to fill with data (can be null)
  7710. * @returns The Array buffer containing the pixels data.
  7711. */
  7712. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  7713. /** @hidden */
  7714. get _lodTextureHigh(): Nullable<BaseTexture>;
  7715. /** @hidden */
  7716. get _lodTextureMid(): Nullable<BaseTexture>;
  7717. /** @hidden */
  7718. get _lodTextureLow(): Nullable<BaseTexture>;
  7719. /**
  7720. * Dispose the texture and release its associated resources.
  7721. */
  7722. dispose(): void;
  7723. /**
  7724. * Serialize the texture into a JSON representation that can be parsed later on.
  7725. * @returns the JSON representation of the texture
  7726. */
  7727. serialize(): any;
  7728. /**
  7729. * Helper function to be called back once a list of texture contains only ready textures.
  7730. * @param textures Define the list of textures to wait for
  7731. * @param callback Define the callback triggered once the entire list will be ready
  7732. */
  7733. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  7734. private static _isScene;
  7735. }
  7736. }
  7737. declare module BABYLON {
  7738. /** @hidden */
  7739. export class WebGLDataBuffer extends DataBuffer {
  7740. private _buffer;
  7741. constructor(resource: WebGLBuffer);
  7742. get underlyingResource(): any;
  7743. }
  7744. }
  7745. declare module BABYLON {
  7746. /** @hidden */
  7747. export class WebGLPipelineContext implements IPipelineContext {
  7748. engine: ThinEngine;
  7749. program: Nullable<WebGLProgram>;
  7750. context?: WebGLRenderingContext;
  7751. vertexShader?: WebGLShader;
  7752. fragmentShader?: WebGLShader;
  7753. isParallelCompiled: boolean;
  7754. onCompiled?: () => void;
  7755. transformFeedback?: WebGLTransformFeedback | null;
  7756. vertexCompilationError: Nullable<string>;
  7757. fragmentCompilationError: Nullable<string>;
  7758. programLinkError: Nullable<string>;
  7759. programValidationError: Nullable<string>;
  7760. get isAsync(): boolean;
  7761. get isReady(): boolean;
  7762. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7763. _getVertexShaderCode(): string | null;
  7764. _getFragmentShaderCode(): string | null;
  7765. }
  7766. }
  7767. declare module BABYLON {
  7768. interface ThinEngine {
  7769. /**
  7770. * Create an uniform buffer
  7771. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7772. * @param elements defines the content of the uniform buffer
  7773. * @returns the webGL uniform buffer
  7774. */
  7775. createUniformBuffer(elements: FloatArray): DataBuffer;
  7776. /**
  7777. * Create a dynamic uniform buffer
  7778. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7779. * @param elements defines the content of the uniform buffer
  7780. * @returns the webGL uniform buffer
  7781. */
  7782. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7783. /**
  7784. * Update an existing uniform buffer
  7785. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7786. * @param uniformBuffer defines the target uniform buffer
  7787. * @param elements defines the content to update
  7788. * @param offset defines the offset in the uniform buffer where update should start
  7789. * @param count defines the size of the data to update
  7790. */
  7791. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7792. /**
  7793. * Bind an uniform buffer to the current webGL context
  7794. * @param buffer defines the buffer to bind
  7795. */
  7796. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7797. /**
  7798. * Bind a buffer to the current webGL context at a given location
  7799. * @param buffer defines the buffer to bind
  7800. * @param location defines the index where to bind the buffer
  7801. */
  7802. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7803. /**
  7804. * Bind a specific block at a given index in a specific shader program
  7805. * @param pipelineContext defines the pipeline context to use
  7806. * @param blockName defines the block name
  7807. * @param index defines the index where to bind the block
  7808. */
  7809. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7810. }
  7811. }
  7812. declare module BABYLON {
  7813. /**
  7814. * Uniform buffer objects.
  7815. *
  7816. * Handles blocks of uniform on the GPU.
  7817. *
  7818. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7819. *
  7820. * For more information, please refer to :
  7821. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7822. */
  7823. export class UniformBuffer {
  7824. private _engine;
  7825. private _buffer;
  7826. private _data;
  7827. private _bufferData;
  7828. private _dynamic?;
  7829. private _uniformLocations;
  7830. private _uniformSizes;
  7831. private _uniformLocationPointer;
  7832. private _needSync;
  7833. private _noUBO;
  7834. private _currentEffect;
  7835. /** @hidden */
  7836. _alreadyBound: boolean;
  7837. private static _MAX_UNIFORM_SIZE;
  7838. private static _tempBuffer;
  7839. /**
  7840. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7841. * This is dynamic to allow compat with webgl 1 and 2.
  7842. * You will need to pass the name of the uniform as well as the value.
  7843. */
  7844. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7845. /**
  7846. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7847. * This is dynamic to allow compat with webgl 1 and 2.
  7848. * You will need to pass the name of the uniform as well as the value.
  7849. */
  7850. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7851. /**
  7852. * Lambda to Update a single float in a uniform buffer.
  7853. * This is dynamic to allow compat with webgl 1 and 2.
  7854. * You will need to pass the name of the uniform as well as the value.
  7855. */
  7856. updateFloat: (name: string, x: number) => void;
  7857. /**
  7858. * Lambda to Update a vec2 of float in a uniform buffer.
  7859. * This is dynamic to allow compat with webgl 1 and 2.
  7860. * You will need to pass the name of the uniform as well as the value.
  7861. */
  7862. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7863. /**
  7864. * Lambda to Update a vec3 of float in a uniform buffer.
  7865. * This is dynamic to allow compat with webgl 1 and 2.
  7866. * You will need to pass the name of the uniform as well as the value.
  7867. */
  7868. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7869. /**
  7870. * Lambda to Update a vec4 of float in a uniform buffer.
  7871. * This is dynamic to allow compat with webgl 1 and 2.
  7872. * You will need to pass the name of the uniform as well as the value.
  7873. */
  7874. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7875. /**
  7876. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7877. * This is dynamic to allow compat with webgl 1 and 2.
  7878. * You will need to pass the name of the uniform as well as the value.
  7879. */
  7880. updateMatrix: (name: string, mat: Matrix) => void;
  7881. /**
  7882. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7883. * This is dynamic to allow compat with webgl 1 and 2.
  7884. * You will need to pass the name of the uniform as well as the value.
  7885. */
  7886. updateVector3: (name: string, vector: Vector3) => void;
  7887. /**
  7888. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7889. * This is dynamic to allow compat with webgl 1 and 2.
  7890. * You will need to pass the name of the uniform as well as the value.
  7891. */
  7892. updateVector4: (name: string, vector: Vector4) => void;
  7893. /**
  7894. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7895. * This is dynamic to allow compat with webgl 1 and 2.
  7896. * You will need to pass the name of the uniform as well as the value.
  7897. */
  7898. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7899. /**
  7900. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7901. * This is dynamic to allow compat with webgl 1 and 2.
  7902. * You will need to pass the name of the uniform as well as the value.
  7903. */
  7904. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7905. /**
  7906. * Instantiates a new Uniform buffer objects.
  7907. *
  7908. * Handles blocks of uniform on the GPU.
  7909. *
  7910. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7911. *
  7912. * For more information, please refer to :
  7913. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7914. * @param engine Define the engine the buffer is associated with
  7915. * @param data Define the data contained in the buffer
  7916. * @param dynamic Define if the buffer is updatable
  7917. */
  7918. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7919. /**
  7920. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7921. * or just falling back on setUniformXXX calls.
  7922. */
  7923. get useUbo(): boolean;
  7924. /**
  7925. * Indicates if the WebGL underlying uniform buffer is in sync
  7926. * with the javascript cache data.
  7927. */
  7928. get isSync(): boolean;
  7929. /**
  7930. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7931. * Also, a dynamic UniformBuffer will disable cache verification and always
  7932. * update the underlying WebGL uniform buffer to the GPU.
  7933. * @returns if Dynamic, otherwise false
  7934. */
  7935. isDynamic(): boolean;
  7936. /**
  7937. * The data cache on JS side.
  7938. * @returns the underlying data as a float array
  7939. */
  7940. getData(): Float32Array;
  7941. /**
  7942. * The underlying WebGL Uniform buffer.
  7943. * @returns the webgl buffer
  7944. */
  7945. getBuffer(): Nullable<DataBuffer>;
  7946. /**
  7947. * std140 layout specifies how to align data within an UBO structure.
  7948. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7949. * for specs.
  7950. */
  7951. private _fillAlignment;
  7952. /**
  7953. * Adds an uniform in the buffer.
  7954. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7955. * for the layout to be correct !
  7956. * @param name Name of the uniform, as used in the uniform block in the shader.
  7957. * @param size Data size, or data directly.
  7958. */
  7959. addUniform(name: string, size: number | number[]): void;
  7960. /**
  7961. * Adds a Matrix 4x4 to the uniform buffer.
  7962. * @param name Name of the uniform, as used in the uniform block in the shader.
  7963. * @param mat A 4x4 matrix.
  7964. */
  7965. addMatrix(name: string, mat: Matrix): void;
  7966. /**
  7967. * Adds a vec2 to the uniform buffer.
  7968. * @param name Name of the uniform, as used in the uniform block in the shader.
  7969. * @param x Define the x component value of the vec2
  7970. * @param y Define the y component value of the vec2
  7971. */
  7972. addFloat2(name: string, x: number, y: number): void;
  7973. /**
  7974. * Adds a vec3 to the uniform buffer.
  7975. * @param name Name of the uniform, as used in the uniform block in the shader.
  7976. * @param x Define the x component value of the vec3
  7977. * @param y Define the y component value of the vec3
  7978. * @param z Define the z component value of the vec3
  7979. */
  7980. addFloat3(name: string, x: number, y: number, z: number): void;
  7981. /**
  7982. * Adds a vec3 to the uniform buffer.
  7983. * @param name Name of the uniform, as used in the uniform block in the shader.
  7984. * @param color Define the vec3 from a Color
  7985. */
  7986. addColor3(name: string, color: Color3): void;
  7987. /**
  7988. * Adds a vec4 to the uniform buffer.
  7989. * @param name Name of the uniform, as used in the uniform block in the shader.
  7990. * @param color Define the rgb components from a Color
  7991. * @param alpha Define the a component of the vec4
  7992. */
  7993. addColor4(name: string, color: Color3, alpha: number): void;
  7994. /**
  7995. * Adds a vec3 to the uniform buffer.
  7996. * @param name Name of the uniform, as used in the uniform block in the shader.
  7997. * @param vector Define the vec3 components from a Vector
  7998. */
  7999. addVector3(name: string, vector: Vector3): void;
  8000. /**
  8001. * Adds a Matrix 3x3 to the uniform buffer.
  8002. * @param name Name of the uniform, as used in the uniform block in the shader.
  8003. */
  8004. addMatrix3x3(name: string): void;
  8005. /**
  8006. * Adds a Matrix 2x2 to the uniform buffer.
  8007. * @param name Name of the uniform, as used in the uniform block in the shader.
  8008. */
  8009. addMatrix2x2(name: string): void;
  8010. /**
  8011. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  8012. */
  8013. create(): void;
  8014. /** @hidden */
  8015. _rebuild(): void;
  8016. /**
  8017. * Updates the WebGL Uniform Buffer on the GPU.
  8018. * If the `dynamic` flag is set to true, no cache comparison is done.
  8019. * Otherwise, the buffer will be updated only if the cache differs.
  8020. */
  8021. update(): void;
  8022. /**
  8023. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  8024. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  8025. * @param data Define the flattened data
  8026. * @param size Define the size of the data.
  8027. */
  8028. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  8029. private _valueCache;
  8030. private _cacheMatrix;
  8031. private _updateMatrix3x3ForUniform;
  8032. private _updateMatrix3x3ForEffect;
  8033. private _updateMatrix2x2ForEffect;
  8034. private _updateMatrix2x2ForUniform;
  8035. private _updateFloatForEffect;
  8036. private _updateFloatForUniform;
  8037. private _updateFloat2ForEffect;
  8038. private _updateFloat2ForUniform;
  8039. private _updateFloat3ForEffect;
  8040. private _updateFloat3ForUniform;
  8041. private _updateFloat4ForEffect;
  8042. private _updateFloat4ForUniform;
  8043. private _updateMatrixForEffect;
  8044. private _updateMatrixForUniform;
  8045. private _updateVector3ForEffect;
  8046. private _updateVector3ForUniform;
  8047. private _updateVector4ForEffect;
  8048. private _updateVector4ForUniform;
  8049. private _updateColor3ForEffect;
  8050. private _updateColor3ForUniform;
  8051. private _updateColor4ForEffect;
  8052. private _updateColor4ForUniform;
  8053. /**
  8054. * Sets a sampler uniform on the effect.
  8055. * @param name Define the name of the sampler.
  8056. * @param texture Define the texture to set in the sampler
  8057. */
  8058. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  8059. /**
  8060. * Directly updates the value of the uniform in the cache AND on the GPU.
  8061. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  8062. * @param data Define the flattened data
  8063. */
  8064. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  8065. /**
  8066. * Binds this uniform buffer to an effect.
  8067. * @param effect Define the effect to bind the buffer to
  8068. * @param name Name of the uniform block in the shader.
  8069. */
  8070. bindToEffect(effect: Effect, name: string): void;
  8071. /**
  8072. * Disposes the uniform buffer.
  8073. */
  8074. dispose(): void;
  8075. }
  8076. }
  8077. declare module BABYLON {
  8078. /**
  8079. * Manages the defines for the Material
  8080. */
  8081. export class MaterialDefines {
  8082. /** @hidden */
  8083. protected _keys: string[];
  8084. private _isDirty;
  8085. /** @hidden */
  8086. _renderId: number;
  8087. /** @hidden */
  8088. _areLightsDirty: boolean;
  8089. /** @hidden */
  8090. _areLightsDisposed: boolean;
  8091. /** @hidden */
  8092. _areAttributesDirty: boolean;
  8093. /** @hidden */
  8094. _areTexturesDirty: boolean;
  8095. /** @hidden */
  8096. _areFresnelDirty: boolean;
  8097. /** @hidden */
  8098. _areMiscDirty: boolean;
  8099. /** @hidden */
  8100. _arePrePassDirty: boolean;
  8101. /** @hidden */
  8102. _areImageProcessingDirty: boolean;
  8103. /** @hidden */
  8104. _normals: boolean;
  8105. /** @hidden */
  8106. _uvs: boolean;
  8107. /** @hidden */
  8108. _needNormals: boolean;
  8109. /** @hidden */
  8110. _needUVs: boolean;
  8111. [id: string]: any;
  8112. /**
  8113. * Specifies if the material needs to be re-calculated
  8114. */
  8115. get isDirty(): boolean;
  8116. /**
  8117. * Marks the material to indicate that it has been re-calculated
  8118. */
  8119. markAsProcessed(): void;
  8120. /**
  8121. * Marks the material to indicate that it needs to be re-calculated
  8122. */
  8123. markAsUnprocessed(): void;
  8124. /**
  8125. * Marks the material to indicate all of its defines need to be re-calculated
  8126. */
  8127. markAllAsDirty(): void;
  8128. /**
  8129. * Marks the material to indicate that image processing needs to be re-calculated
  8130. */
  8131. markAsImageProcessingDirty(): void;
  8132. /**
  8133. * Marks the material to indicate the lights need to be re-calculated
  8134. * @param disposed Defines whether the light is dirty due to dispose or not
  8135. */
  8136. markAsLightDirty(disposed?: boolean): void;
  8137. /**
  8138. * Marks the attribute state as changed
  8139. */
  8140. markAsAttributesDirty(): void;
  8141. /**
  8142. * Marks the texture state as changed
  8143. */
  8144. markAsTexturesDirty(): void;
  8145. /**
  8146. * Marks the fresnel state as changed
  8147. */
  8148. markAsFresnelDirty(): void;
  8149. /**
  8150. * Marks the misc state as changed
  8151. */
  8152. markAsMiscDirty(): void;
  8153. /**
  8154. * Marks the prepass state as changed
  8155. */
  8156. markAsPrePassDirty(): void;
  8157. /**
  8158. * Rebuilds the material defines
  8159. */
  8160. rebuild(): void;
  8161. /**
  8162. * Specifies if two material defines are equal
  8163. * @param other - A material define instance to compare to
  8164. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  8165. */
  8166. isEqual(other: MaterialDefines): boolean;
  8167. /**
  8168. * Clones this instance's defines to another instance
  8169. * @param other - material defines to clone values to
  8170. */
  8171. cloneTo(other: MaterialDefines): void;
  8172. /**
  8173. * Resets the material define values
  8174. */
  8175. reset(): void;
  8176. /**
  8177. * Converts the material define values to a string
  8178. * @returns - String of material define information
  8179. */
  8180. toString(): string;
  8181. }
  8182. }
  8183. declare module BABYLON {
  8184. /**
  8185. * Enum that determines the text-wrapping mode to use.
  8186. */
  8187. export enum InspectableType {
  8188. /**
  8189. * Checkbox for booleans
  8190. */
  8191. Checkbox = 0,
  8192. /**
  8193. * Sliders for numbers
  8194. */
  8195. Slider = 1,
  8196. /**
  8197. * Vector3
  8198. */
  8199. Vector3 = 2,
  8200. /**
  8201. * Quaternions
  8202. */
  8203. Quaternion = 3,
  8204. /**
  8205. * Color3
  8206. */
  8207. Color3 = 4,
  8208. /**
  8209. * String
  8210. */
  8211. String = 5
  8212. }
  8213. /**
  8214. * Interface used to define custom inspectable properties.
  8215. * This interface is used by the inspector to display custom property grids
  8216. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  8217. */
  8218. export interface IInspectable {
  8219. /**
  8220. * Gets the label to display
  8221. */
  8222. label: string;
  8223. /**
  8224. * Gets the name of the property to edit
  8225. */
  8226. propertyName: string;
  8227. /**
  8228. * Gets the type of the editor to use
  8229. */
  8230. type: InspectableType;
  8231. /**
  8232. * Gets the minimum value of the property when using in "slider" mode
  8233. */
  8234. min?: number;
  8235. /**
  8236. * Gets the maximum value of the property when using in "slider" mode
  8237. */
  8238. max?: number;
  8239. /**
  8240. * Gets the setp to use when using in "slider" mode
  8241. */
  8242. step?: number;
  8243. }
  8244. }
  8245. declare module BABYLON {
  8246. /**
  8247. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  8248. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  8249. * 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.
  8250. */
  8251. export abstract class Light extends Node {
  8252. /**
  8253. * Falloff Default: light is falling off following the material specification:
  8254. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  8255. */
  8256. static readonly FALLOFF_DEFAULT: number;
  8257. /**
  8258. * Falloff Physical: light is falling off following the inverse squared distance law.
  8259. */
  8260. static readonly FALLOFF_PHYSICAL: number;
  8261. /**
  8262. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  8263. * to enhance interoperability with other engines.
  8264. */
  8265. static readonly FALLOFF_GLTF: number;
  8266. /**
  8267. * Falloff Standard: light is falling off like in the standard material
  8268. * to enhance interoperability with other materials.
  8269. */
  8270. static readonly FALLOFF_STANDARD: number;
  8271. /**
  8272. * If every light affecting the material is in this lightmapMode,
  8273. * material.lightmapTexture adds or multiplies
  8274. * (depends on material.useLightmapAsShadowmap)
  8275. * after every other light calculations.
  8276. */
  8277. static readonly LIGHTMAP_DEFAULT: number;
  8278. /**
  8279. * material.lightmapTexture as only diffuse lighting from this light
  8280. * adds only specular lighting from this light
  8281. * adds dynamic shadows
  8282. */
  8283. static readonly LIGHTMAP_SPECULAR: number;
  8284. /**
  8285. * material.lightmapTexture as only lighting
  8286. * no light calculation from this light
  8287. * only adds dynamic shadows from this light
  8288. */
  8289. static readonly LIGHTMAP_SHADOWSONLY: number;
  8290. /**
  8291. * Each light type uses the default quantity according to its type:
  8292. * point/spot lights use luminous intensity
  8293. * directional lights use illuminance
  8294. */
  8295. static readonly INTENSITYMODE_AUTOMATIC: number;
  8296. /**
  8297. * lumen (lm)
  8298. */
  8299. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  8300. /**
  8301. * candela (lm/sr)
  8302. */
  8303. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  8304. /**
  8305. * lux (lm/m^2)
  8306. */
  8307. static readonly INTENSITYMODE_ILLUMINANCE: number;
  8308. /**
  8309. * nit (cd/m^2)
  8310. */
  8311. static readonly INTENSITYMODE_LUMINANCE: number;
  8312. /**
  8313. * Light type const id of the point light.
  8314. */
  8315. static readonly LIGHTTYPEID_POINTLIGHT: number;
  8316. /**
  8317. * Light type const id of the directional light.
  8318. */
  8319. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  8320. /**
  8321. * Light type const id of the spot light.
  8322. */
  8323. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  8324. /**
  8325. * Light type const id of the hemispheric light.
  8326. */
  8327. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  8328. /**
  8329. * Diffuse gives the basic color to an object.
  8330. */
  8331. diffuse: Color3;
  8332. /**
  8333. * Specular produces a highlight color on an object.
  8334. * Note: This is note affecting PBR materials.
  8335. */
  8336. specular: Color3;
  8337. /**
  8338. * Defines the falloff type for this light. This lets overrriding how punctual light are
  8339. * falling off base on range or angle.
  8340. * This can be set to any values in Light.FALLOFF_x.
  8341. *
  8342. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  8343. * other types of materials.
  8344. */
  8345. falloffType: number;
  8346. /**
  8347. * Strength of the light.
  8348. * Note: By default it is define in the framework own unit.
  8349. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  8350. */
  8351. intensity: number;
  8352. private _range;
  8353. protected _inverseSquaredRange: number;
  8354. /**
  8355. * Defines how far from the source the light is impacting in scene units.
  8356. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  8357. */
  8358. get range(): number;
  8359. /**
  8360. * Defines how far from the source the light is impacting in scene units.
  8361. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  8362. */
  8363. set range(value: number);
  8364. /**
  8365. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  8366. * of light.
  8367. */
  8368. private _photometricScale;
  8369. private _intensityMode;
  8370. /**
  8371. * Gets the photometric scale used to interpret the intensity.
  8372. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  8373. */
  8374. get intensityMode(): number;
  8375. /**
  8376. * Sets the photometric scale used to interpret the intensity.
  8377. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  8378. */
  8379. set intensityMode(value: number);
  8380. private _radius;
  8381. /**
  8382. * Gets the light radius used by PBR Materials to simulate soft area lights.
  8383. */
  8384. get radius(): number;
  8385. /**
  8386. * sets the light radius used by PBR Materials to simulate soft area lights.
  8387. */
  8388. set radius(value: number);
  8389. private _renderPriority;
  8390. /**
  8391. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  8392. * exceeding the number allowed of the materials.
  8393. */
  8394. renderPriority: number;
  8395. private _shadowEnabled;
  8396. /**
  8397. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  8398. * the current shadow generator.
  8399. */
  8400. get shadowEnabled(): boolean;
  8401. /**
  8402. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  8403. * the current shadow generator.
  8404. */
  8405. set shadowEnabled(value: boolean);
  8406. private _includedOnlyMeshes;
  8407. /**
  8408. * Gets the only meshes impacted by this light.
  8409. */
  8410. get includedOnlyMeshes(): AbstractMesh[];
  8411. /**
  8412. * Sets the only meshes impacted by this light.
  8413. */
  8414. set includedOnlyMeshes(value: AbstractMesh[]);
  8415. private _excludedMeshes;
  8416. /**
  8417. * Gets the meshes not impacted by this light.
  8418. */
  8419. get excludedMeshes(): AbstractMesh[];
  8420. /**
  8421. * Sets the meshes not impacted by this light.
  8422. */
  8423. set excludedMeshes(value: AbstractMesh[]);
  8424. private _excludeWithLayerMask;
  8425. /**
  8426. * Gets the layer id use to find what meshes are not impacted by the light.
  8427. * Inactive if 0
  8428. */
  8429. get excludeWithLayerMask(): number;
  8430. /**
  8431. * Sets the layer id use to find what meshes are not impacted by the light.
  8432. * Inactive if 0
  8433. */
  8434. set excludeWithLayerMask(value: number);
  8435. private _includeOnlyWithLayerMask;
  8436. /**
  8437. * Gets the layer id use to find what meshes are impacted by the light.
  8438. * Inactive if 0
  8439. */
  8440. get includeOnlyWithLayerMask(): number;
  8441. /**
  8442. * Sets the layer id use to find what meshes are impacted by the light.
  8443. * Inactive if 0
  8444. */
  8445. set includeOnlyWithLayerMask(value: number);
  8446. private _lightmapMode;
  8447. /**
  8448. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  8449. */
  8450. get lightmapMode(): number;
  8451. /**
  8452. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  8453. */
  8454. set lightmapMode(value: number);
  8455. /**
  8456. * Shadow generator associted to the light.
  8457. * @hidden Internal use only.
  8458. */
  8459. _shadowGenerator: Nullable<IShadowGenerator>;
  8460. /**
  8461. * @hidden Internal use only.
  8462. */
  8463. _excludedMeshesIds: string[];
  8464. /**
  8465. * @hidden Internal use only.
  8466. */
  8467. _includedOnlyMeshesIds: string[];
  8468. /**
  8469. * The current light unifom buffer.
  8470. * @hidden Internal use only.
  8471. */
  8472. _uniformBuffer: UniformBuffer;
  8473. /** @hidden */
  8474. _renderId: number;
  8475. /**
  8476. * Creates a Light object in the scene.
  8477. * Documentation : https://doc.babylonjs.com/babylon101/lights
  8478. * @param name The firendly name of the light
  8479. * @param scene The scene the light belongs too
  8480. */
  8481. constructor(name: string, scene: Scene);
  8482. protected abstract _buildUniformLayout(): void;
  8483. /**
  8484. * Sets the passed Effect "effect" with the Light information.
  8485. * @param effect The effect to update
  8486. * @param lightIndex The index of the light in the effect to update
  8487. * @returns The light
  8488. */
  8489. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  8490. /**
  8491. * Sets the passed Effect "effect" with the Light textures.
  8492. * @param effect The effect to update
  8493. * @param lightIndex The index of the light in the effect to update
  8494. * @returns The light
  8495. */
  8496. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  8497. /**
  8498. * Binds the lights information from the scene to the effect for the given mesh.
  8499. * @param lightIndex Light index
  8500. * @param scene The scene where the light belongs to
  8501. * @param effect The effect we are binding the data to
  8502. * @param useSpecular Defines if specular is supported
  8503. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  8504. */
  8505. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  8506. /**
  8507. * Sets the passed Effect "effect" with the Light information.
  8508. * @param effect The effect to update
  8509. * @param lightDataUniformName The uniform used to store light data (position or direction)
  8510. * @returns The light
  8511. */
  8512. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  8513. /**
  8514. * Returns the string "Light".
  8515. * @returns the class name
  8516. */
  8517. getClassName(): string;
  8518. /** @hidden */
  8519. readonly _isLight: boolean;
  8520. /**
  8521. * Converts the light information to a readable string for debug purpose.
  8522. * @param fullDetails Supports for multiple levels of logging within scene loading
  8523. * @returns the human readable light info
  8524. */
  8525. toString(fullDetails?: boolean): string;
  8526. /** @hidden */
  8527. protected _syncParentEnabledState(): void;
  8528. /**
  8529. * Set the enabled state of this node.
  8530. * @param value - the new enabled state
  8531. */
  8532. setEnabled(value: boolean): void;
  8533. /**
  8534. * Returns the Light associated shadow generator if any.
  8535. * @return the associated shadow generator.
  8536. */
  8537. getShadowGenerator(): Nullable<IShadowGenerator>;
  8538. /**
  8539. * Returns a Vector3, the absolute light position in the World.
  8540. * @returns the world space position of the light
  8541. */
  8542. getAbsolutePosition(): Vector3;
  8543. /**
  8544. * Specifies if the light will affect the passed mesh.
  8545. * @param mesh The mesh to test against the light
  8546. * @return true the mesh is affected otherwise, false.
  8547. */
  8548. canAffectMesh(mesh: AbstractMesh): boolean;
  8549. /**
  8550. * Sort function to order lights for rendering.
  8551. * @param a First Light object to compare to second.
  8552. * @param b Second Light object to compare first.
  8553. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  8554. */
  8555. static CompareLightsPriority(a: Light, b: Light): number;
  8556. /**
  8557. * Releases resources associated with this node.
  8558. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  8559. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  8560. */
  8561. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  8562. /**
  8563. * Returns the light type ID (integer).
  8564. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  8565. */
  8566. getTypeID(): number;
  8567. /**
  8568. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  8569. * @returns the scaled intensity in intensity mode unit
  8570. */
  8571. getScaledIntensity(): number;
  8572. /**
  8573. * Returns a new Light object, named "name", from the current one.
  8574. * @param name The name of the cloned light
  8575. * @param newParent The parent of this light, if it has one
  8576. * @returns the new created light
  8577. */
  8578. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  8579. /**
  8580. * Serializes the current light into a Serialization object.
  8581. * @returns the serialized object.
  8582. */
  8583. serialize(): any;
  8584. /**
  8585. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  8586. * This new light is named "name" and added to the passed scene.
  8587. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  8588. * @param name The friendly name of the light
  8589. * @param scene The scene the new light will belong to
  8590. * @returns the constructor function
  8591. */
  8592. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  8593. /**
  8594. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  8595. * @param parsedLight The JSON representation of the light
  8596. * @param scene The scene to create the parsed light in
  8597. * @returns the created light after parsing
  8598. */
  8599. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  8600. private _hookArrayForExcluded;
  8601. private _hookArrayForIncludedOnly;
  8602. private _resyncMeshes;
  8603. /**
  8604. * Forces the meshes to update their light related information in their rendering used effects
  8605. * @hidden Internal Use Only
  8606. */
  8607. _markMeshesAsLightDirty(): void;
  8608. /**
  8609. * Recomputes the cached photometric scale if needed.
  8610. */
  8611. private _computePhotometricScale;
  8612. /**
  8613. * Returns the Photometric Scale according to the light type and intensity mode.
  8614. */
  8615. private _getPhotometricScale;
  8616. /**
  8617. * Reorder the light in the scene according to their defined priority.
  8618. * @hidden Internal Use Only
  8619. */
  8620. _reorderLightsInScene(): void;
  8621. /**
  8622. * Prepares the list of defines specific to the light type.
  8623. * @param defines the list of defines
  8624. * @param lightIndex defines the index of the light for the effect
  8625. */
  8626. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  8627. }
  8628. }
  8629. declare module BABYLON {
  8630. /** Defines supported spaces */
  8631. export enum Space {
  8632. /** Local (object) space */
  8633. LOCAL = 0,
  8634. /** World space */
  8635. WORLD = 1,
  8636. /** Bone space */
  8637. BONE = 2
  8638. }
  8639. /** Defines the 3 main axes */
  8640. export class Axis {
  8641. /** X axis */
  8642. static X: Vector3;
  8643. /** Y axis */
  8644. static Y: Vector3;
  8645. /** Z axis */
  8646. static Z: Vector3;
  8647. }
  8648. /**
  8649. * Defines cartesian components.
  8650. */
  8651. export enum Coordinate {
  8652. /** X axis */
  8653. X = 0,
  8654. /** Y axis */
  8655. Y = 1,
  8656. /** Z axis */
  8657. Z = 2
  8658. }
  8659. }
  8660. declare module BABYLON {
  8661. /**
  8662. * Interface describing all the common properties and methods a shadow light needs to implement.
  8663. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  8664. * as well as binding the different shadow properties to the effects.
  8665. */
  8666. export interface IShadowLight extends Light {
  8667. /**
  8668. * The light id in the scene (used in scene.findLighById for instance)
  8669. */
  8670. id: string;
  8671. /**
  8672. * The position the shdow will be casted from.
  8673. */
  8674. position: Vector3;
  8675. /**
  8676. * In 2d mode (needCube being false), the direction used to cast the shadow.
  8677. */
  8678. direction: Vector3;
  8679. /**
  8680. * The transformed position. Position of the light in world space taking parenting in account.
  8681. */
  8682. transformedPosition: Vector3;
  8683. /**
  8684. * The transformed direction. Direction of the light in world space taking parenting in account.
  8685. */
  8686. transformedDirection: Vector3;
  8687. /**
  8688. * The friendly name of the light in the scene.
  8689. */
  8690. name: string;
  8691. /**
  8692. * Defines the shadow projection clipping minimum z value.
  8693. */
  8694. shadowMinZ: number;
  8695. /**
  8696. * Defines the shadow projection clipping maximum z value.
  8697. */
  8698. shadowMaxZ: number;
  8699. /**
  8700. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8701. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8702. */
  8703. computeTransformedInformation(): boolean;
  8704. /**
  8705. * Gets the scene the light belongs to.
  8706. * @returns The scene
  8707. */
  8708. getScene(): Scene;
  8709. /**
  8710. * Callback defining a custom Projection Matrix Builder.
  8711. * This can be used to override the default projection matrix computation.
  8712. */
  8713. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8714. /**
  8715. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  8716. * @param matrix The materix to updated with the projection information
  8717. * @param viewMatrix The transform matrix of the light
  8718. * @param renderList The list of mesh to render in the map
  8719. * @returns The current light
  8720. */
  8721. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  8722. /**
  8723. * Gets the current depth scale used in ESM.
  8724. * @returns The scale
  8725. */
  8726. getDepthScale(): number;
  8727. /**
  8728. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  8729. * @returns true if a cube texture needs to be use
  8730. */
  8731. needCube(): boolean;
  8732. /**
  8733. * Detects if the projection matrix requires to be recomputed this frame.
  8734. * @returns true if it requires to be recomputed otherwise, false.
  8735. */
  8736. needProjectionMatrixCompute(): boolean;
  8737. /**
  8738. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  8739. */
  8740. forceProjectionMatrixCompute(): void;
  8741. /**
  8742. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8743. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8744. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8745. */
  8746. getShadowDirection(faceIndex?: number): Vector3;
  8747. /**
  8748. * Gets the minZ used for shadow according to both the scene and the light.
  8749. * @param activeCamera The camera we are returning the min for
  8750. * @returns the depth min z
  8751. */
  8752. getDepthMinZ(activeCamera: Camera): number;
  8753. /**
  8754. * Gets the maxZ used for shadow according to both the scene and the light.
  8755. * @param activeCamera The camera we are returning the max for
  8756. * @returns the depth max z
  8757. */
  8758. getDepthMaxZ(activeCamera: Camera): number;
  8759. }
  8760. /**
  8761. * Base implementation IShadowLight
  8762. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  8763. */
  8764. export abstract class ShadowLight extends Light implements IShadowLight {
  8765. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  8766. protected _position: Vector3;
  8767. protected _setPosition(value: Vector3): void;
  8768. /**
  8769. * Sets the position the shadow will be casted from. Also use as the light position for both
  8770. * point and spot lights.
  8771. */
  8772. get position(): Vector3;
  8773. /**
  8774. * Sets the position the shadow will be casted from. Also use as the light position for both
  8775. * point and spot lights.
  8776. */
  8777. set position(value: Vector3);
  8778. protected _direction: Vector3;
  8779. protected _setDirection(value: Vector3): void;
  8780. /**
  8781. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  8782. * Also use as the light direction on spot and directional lights.
  8783. */
  8784. get direction(): Vector3;
  8785. /**
  8786. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  8787. * Also use as the light direction on spot and directional lights.
  8788. */
  8789. set direction(value: Vector3);
  8790. protected _shadowMinZ: number;
  8791. /**
  8792. * Gets the shadow projection clipping minimum z value.
  8793. */
  8794. get shadowMinZ(): number;
  8795. /**
  8796. * Sets the shadow projection clipping minimum z value.
  8797. */
  8798. set shadowMinZ(value: number);
  8799. protected _shadowMaxZ: number;
  8800. /**
  8801. * Sets the shadow projection clipping maximum z value.
  8802. */
  8803. get shadowMaxZ(): number;
  8804. /**
  8805. * Gets the shadow projection clipping maximum z value.
  8806. */
  8807. set shadowMaxZ(value: number);
  8808. /**
  8809. * Callback defining a custom Projection Matrix Builder.
  8810. * This can be used to override the default projection matrix computation.
  8811. */
  8812. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8813. /**
  8814. * The transformed position. Position of the light in world space taking parenting in account.
  8815. */
  8816. transformedPosition: Vector3;
  8817. /**
  8818. * The transformed direction. Direction of the light in world space taking parenting in account.
  8819. */
  8820. transformedDirection: Vector3;
  8821. private _needProjectionMatrixCompute;
  8822. /**
  8823. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8824. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8825. */
  8826. computeTransformedInformation(): boolean;
  8827. /**
  8828. * Return the depth scale used for the shadow map.
  8829. * @returns the depth scale.
  8830. */
  8831. getDepthScale(): number;
  8832. /**
  8833. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8834. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8835. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8836. */
  8837. getShadowDirection(faceIndex?: number): Vector3;
  8838. /**
  8839. * Returns the ShadowLight absolute position in the World.
  8840. * @returns the position vector in world space
  8841. */
  8842. getAbsolutePosition(): Vector3;
  8843. /**
  8844. * Sets the ShadowLight direction toward the passed target.
  8845. * @param target The point to target in local space
  8846. * @returns the updated ShadowLight direction
  8847. */
  8848. setDirectionToTarget(target: Vector3): Vector3;
  8849. /**
  8850. * Returns the light rotation in euler definition.
  8851. * @returns the x y z rotation in local space.
  8852. */
  8853. getRotation(): Vector3;
  8854. /**
  8855. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  8856. * @returns true if a cube texture needs to be use
  8857. */
  8858. needCube(): boolean;
  8859. /**
  8860. * Detects if the projection matrix requires to be recomputed this frame.
  8861. * @returns true if it requires to be recomputed otherwise, false.
  8862. */
  8863. needProjectionMatrixCompute(): boolean;
  8864. /**
  8865. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  8866. */
  8867. forceProjectionMatrixCompute(): void;
  8868. /** @hidden */
  8869. _initCache(): void;
  8870. /** @hidden */
  8871. _isSynchronized(): boolean;
  8872. /**
  8873. * Computes the world matrix of the node
  8874. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  8875. * @returns the world matrix
  8876. */
  8877. computeWorldMatrix(force?: boolean): Matrix;
  8878. /**
  8879. * Gets the minZ used for shadow according to both the scene and the light.
  8880. * @param activeCamera The camera we are returning the min for
  8881. * @returns the depth min z
  8882. */
  8883. getDepthMinZ(activeCamera: Camera): number;
  8884. /**
  8885. * Gets the maxZ used for shadow according to both the scene and the light.
  8886. * @param activeCamera The camera we are returning the max for
  8887. * @returns the depth max z
  8888. */
  8889. getDepthMaxZ(activeCamera: Camera): number;
  8890. /**
  8891. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  8892. * @param matrix The materix to updated with the projection information
  8893. * @param viewMatrix The transform matrix of the light
  8894. * @param renderList The list of mesh to render in the map
  8895. * @returns The current light
  8896. */
  8897. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  8898. }
  8899. }
  8900. declare module BABYLON {
  8901. /**
  8902. * Configuration needed for prepass-capable materials
  8903. */
  8904. export class PrePassConfiguration {
  8905. /**
  8906. * Previous world matrices of meshes carrying this material
  8907. * Used for computing velocity
  8908. */
  8909. previousWorldMatrices: {
  8910. [index: number]: Matrix;
  8911. };
  8912. /**
  8913. * Previous view project matrix
  8914. * Used for computing velocity
  8915. */
  8916. previousViewProjection: Matrix;
  8917. /**
  8918. * Previous bones of meshes carrying this material
  8919. * Used for computing velocity
  8920. */
  8921. previousBones: {
  8922. [index: number]: Float32Array;
  8923. };
  8924. /**
  8925. * Add the required uniforms to the current list.
  8926. * @param uniforms defines the current uniform list.
  8927. */
  8928. static AddUniforms(uniforms: string[]): void;
  8929. /**
  8930. * Add the required samplers to the current list.
  8931. * @param samplers defines the current sampler list.
  8932. */
  8933. static AddSamplers(samplers: string[]): void;
  8934. /**
  8935. * Binds the material data.
  8936. * @param effect defines the effect to update
  8937. * @param scene defines the scene the material belongs to.
  8938. * @param mesh The mesh
  8939. * @param world World matrix of this mesh
  8940. * @param isFrozen Is the material frozen
  8941. */
  8942. bindForSubMesh(effect: Effect, scene: Scene, mesh: Mesh, world: Matrix, isFrozen: boolean): void;
  8943. }
  8944. }
  8945. declare module BABYLON {
  8946. /**
  8947. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  8948. * This is the base of the follow, arc rotate cameras and Free camera
  8949. * @see https://doc.babylonjs.com/features/cameras
  8950. */
  8951. export class TargetCamera extends Camera {
  8952. private static _RigCamTransformMatrix;
  8953. private static _TargetTransformMatrix;
  8954. private static _TargetFocalPoint;
  8955. private _tmpUpVector;
  8956. private _tmpTargetVector;
  8957. /**
  8958. * Define the current direction the camera is moving to
  8959. */
  8960. cameraDirection: Vector3;
  8961. /**
  8962. * Define the current rotation the camera is rotating to
  8963. */
  8964. cameraRotation: Vector2;
  8965. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  8966. ignoreParentScaling: boolean;
  8967. /**
  8968. * When set, the up vector of the camera will be updated by the rotation of the camera
  8969. */
  8970. updateUpVectorFromRotation: boolean;
  8971. private _tmpQuaternion;
  8972. /**
  8973. * Define the current rotation of the camera
  8974. */
  8975. rotation: Vector3;
  8976. /**
  8977. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  8978. */
  8979. rotationQuaternion: Quaternion;
  8980. /**
  8981. * Define the current speed of the camera
  8982. */
  8983. speed: number;
  8984. /**
  8985. * Add constraint to the camera to prevent it to move freely in all directions and
  8986. * around all axis.
  8987. */
  8988. noRotationConstraint: boolean;
  8989. /**
  8990. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  8991. * panning
  8992. */
  8993. invertRotation: boolean;
  8994. /**
  8995. * Speed multiplier for inverse camera panning
  8996. */
  8997. inverseRotationSpeed: number;
  8998. /**
  8999. * Define the current target of the camera as an object or a position.
  9000. */
  9001. lockedTarget: any;
  9002. /** @hidden */
  9003. _currentTarget: Vector3;
  9004. /** @hidden */
  9005. _initialFocalDistance: number;
  9006. /** @hidden */
  9007. _viewMatrix: Matrix;
  9008. /** @hidden */
  9009. _camMatrix: Matrix;
  9010. /** @hidden */
  9011. _cameraTransformMatrix: Matrix;
  9012. /** @hidden */
  9013. _cameraRotationMatrix: Matrix;
  9014. /** @hidden */
  9015. _referencePoint: Vector3;
  9016. /** @hidden */
  9017. _transformedReferencePoint: Vector3;
  9018. /** @hidden */
  9019. _reset: () => void;
  9020. private _defaultUp;
  9021. /**
  9022. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  9023. * This is the base of the follow, arc rotate cameras and Free camera
  9024. * @see https://doc.babylonjs.com/features/cameras
  9025. * @param name Defines the name of the camera in the scene
  9026. * @param position Defines the start position of the camera in the scene
  9027. * @param scene Defines the scene the camera belongs to
  9028. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  9029. */
  9030. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  9031. /**
  9032. * Gets the position in front of the camera at a given distance.
  9033. * @param distance The distance from the camera we want the position to be
  9034. * @returns the position
  9035. */
  9036. getFrontPosition(distance: number): Vector3;
  9037. /** @hidden */
  9038. _getLockedTargetPosition(): Nullable<Vector3>;
  9039. private _storedPosition;
  9040. private _storedRotation;
  9041. private _storedRotationQuaternion;
  9042. /**
  9043. * Store current camera state of the camera (fov, position, rotation, etc..)
  9044. * @returns the camera
  9045. */
  9046. storeState(): Camera;
  9047. /**
  9048. * Restored camera state. You must call storeState() first
  9049. * @returns whether it was successful or not
  9050. * @hidden
  9051. */
  9052. _restoreStateValues(): boolean;
  9053. /** @hidden */
  9054. _initCache(): void;
  9055. /** @hidden */
  9056. _updateCache(ignoreParentClass?: boolean): void;
  9057. /** @hidden */
  9058. _isSynchronizedViewMatrix(): boolean;
  9059. /** @hidden */
  9060. _computeLocalCameraSpeed(): number;
  9061. /**
  9062. * Defines the target the camera should look at.
  9063. * @param target Defines the new target as a Vector or a mesh
  9064. */
  9065. setTarget(target: Vector3): void;
  9066. /**
  9067. * Defines the target point of the camera.
  9068. * The camera looks towards it form the radius distance.
  9069. */
  9070. get target(): Vector3;
  9071. set target(value: Vector3);
  9072. /**
  9073. * Return the current target position of the camera. This value is expressed in local space.
  9074. * @returns the target position
  9075. */
  9076. getTarget(): Vector3;
  9077. /** @hidden */
  9078. _decideIfNeedsToMove(): boolean;
  9079. /** @hidden */
  9080. _updatePosition(): void;
  9081. /** @hidden */
  9082. _checkInputs(): void;
  9083. protected _updateCameraRotationMatrix(): void;
  9084. /**
  9085. * 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)
  9086. * @returns the current camera
  9087. */
  9088. private _rotateUpVectorWithCameraRotationMatrix;
  9089. private _cachedRotationZ;
  9090. private _cachedQuaternionRotationZ;
  9091. /** @hidden */
  9092. _getViewMatrix(): Matrix;
  9093. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  9094. /**
  9095. * @hidden
  9096. */
  9097. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  9098. /**
  9099. * @hidden
  9100. */
  9101. _updateRigCameras(): void;
  9102. private _getRigCamPositionAndTarget;
  9103. /**
  9104. * Gets the current object class name.
  9105. * @return the class name
  9106. */
  9107. getClassName(): string;
  9108. }
  9109. }
  9110. declare module BABYLON {
  9111. /**
  9112. * @ignore
  9113. * This is a list of all the different input types that are available in the application.
  9114. * Fo instance: ArcRotateCameraGamepadInput...
  9115. */
  9116. export var CameraInputTypes: {};
  9117. /**
  9118. * This is the contract to implement in order to create a new input class.
  9119. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  9120. */
  9121. export interface ICameraInput<TCamera extends Camera> {
  9122. /**
  9123. * Defines the camera the input is attached to.
  9124. */
  9125. camera: Nullable<TCamera>;
  9126. /**
  9127. * Gets the class name of the current intput.
  9128. * @returns the class name
  9129. */
  9130. getClassName(): string;
  9131. /**
  9132. * Get the friendly name associated with the input class.
  9133. * @returns the input friendly name
  9134. */
  9135. getSimpleName(): string;
  9136. /**
  9137. * Attach the input controls to a specific dom element to get the input from.
  9138. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  9139. */
  9140. attachControl(noPreventDefault?: boolean): void;
  9141. /**
  9142. * Detach the current controls from the specified dom element.
  9143. */
  9144. detachControl(): void;
  9145. /**
  9146. * Update the current camera state depending on the inputs that have been used this frame.
  9147. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  9148. */
  9149. checkInputs?: () => void;
  9150. }
  9151. /**
  9152. * Represents a map of input types to input instance or input index to input instance.
  9153. */
  9154. export interface CameraInputsMap<TCamera extends Camera> {
  9155. /**
  9156. * Accessor to the input by input type.
  9157. */
  9158. [name: string]: ICameraInput<TCamera>;
  9159. /**
  9160. * Accessor to the input by input index.
  9161. */
  9162. [idx: number]: ICameraInput<TCamera>;
  9163. }
  9164. /**
  9165. * This represents the input manager used within a camera.
  9166. * It helps dealing with all the different kind of input attached to a camera.
  9167. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  9168. */
  9169. export class CameraInputsManager<TCamera extends Camera> {
  9170. /**
  9171. * Defines the list of inputs attahed to the camera.
  9172. */
  9173. attached: CameraInputsMap<TCamera>;
  9174. /**
  9175. * Defines the dom element the camera is collecting inputs from.
  9176. * This is null if the controls have not been attached.
  9177. */
  9178. attachedToElement: boolean;
  9179. /**
  9180. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  9181. */
  9182. noPreventDefault: boolean;
  9183. /**
  9184. * Defined the camera the input manager belongs to.
  9185. */
  9186. camera: TCamera;
  9187. /**
  9188. * Update the current camera state depending on the inputs that have been used this frame.
  9189. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  9190. */
  9191. checkInputs: () => void;
  9192. /**
  9193. * Instantiate a new Camera Input Manager.
  9194. * @param camera Defines the camera the input manager blongs to
  9195. */
  9196. constructor(camera: TCamera);
  9197. /**
  9198. * Add an input method to a camera
  9199. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  9200. * @param input camera input method
  9201. */
  9202. add(input: ICameraInput<TCamera>): void;
  9203. /**
  9204. * Remove a specific input method from a camera
  9205. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  9206. * @param inputToRemove camera input method
  9207. */
  9208. remove(inputToRemove: ICameraInput<TCamera>): void;
  9209. /**
  9210. * Remove a specific input type from a camera
  9211. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  9212. * @param inputType the type of the input to remove
  9213. */
  9214. removeByType(inputType: string): void;
  9215. private _addCheckInputs;
  9216. /**
  9217. * Attach the input controls to the currently attached dom element to listen the events from.
  9218. * @param input Defines the input to attach
  9219. */
  9220. attachInput(input: ICameraInput<TCamera>): void;
  9221. /**
  9222. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  9223. * @param element Defines the dom element to collect the events from
  9224. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  9225. */
  9226. attachElement(noPreventDefault?: boolean): void;
  9227. /**
  9228. * Detach the current manager inputs controls from a specific dom element.
  9229. * @param element Defines the dom element to collect the events from
  9230. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  9231. */
  9232. detachElement(disconnect?: boolean): void;
  9233. /**
  9234. * Rebuild the dynamic inputCheck function from the current list of
  9235. * defined inputs in the manager.
  9236. */
  9237. rebuildInputCheck(): void;
  9238. /**
  9239. * Remove all attached input methods from a camera
  9240. */
  9241. clear(): void;
  9242. /**
  9243. * Serialize the current input manager attached to a camera.
  9244. * This ensures than once parsed,
  9245. * the input associated to the camera will be identical to the current ones
  9246. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  9247. */
  9248. serialize(serializedCamera: any): void;
  9249. /**
  9250. * Parses an input manager serialized JSON to restore the previous list of inputs
  9251. * and states associated to a camera.
  9252. * @param parsedCamera Defines the JSON to parse
  9253. */
  9254. parse(parsedCamera: any): void;
  9255. }
  9256. }
  9257. declare module BABYLON {
  9258. /**
  9259. * Gather the list of keyboard event types as constants.
  9260. */
  9261. export class KeyboardEventTypes {
  9262. /**
  9263. * The keydown event is fired when a key becomes active (pressed).
  9264. */
  9265. static readonly KEYDOWN: number;
  9266. /**
  9267. * The keyup event is fired when a key has been released.
  9268. */
  9269. static readonly KEYUP: number;
  9270. }
  9271. /**
  9272. * This class is used to store keyboard related info for the onKeyboardObservable event.
  9273. */
  9274. export class KeyboardInfo {
  9275. /**
  9276. * Defines the type of event (KeyboardEventTypes)
  9277. */
  9278. type: number;
  9279. /**
  9280. * Defines the related dom event
  9281. */
  9282. event: KeyboardEvent;
  9283. /**
  9284. * Instantiates a new keyboard info.
  9285. * This class is used to store keyboard related info for the onKeyboardObservable event.
  9286. * @param type Defines the type of event (KeyboardEventTypes)
  9287. * @param event Defines the related dom event
  9288. */
  9289. constructor(
  9290. /**
  9291. * Defines the type of event (KeyboardEventTypes)
  9292. */
  9293. type: number,
  9294. /**
  9295. * Defines the related dom event
  9296. */
  9297. event: KeyboardEvent);
  9298. }
  9299. /**
  9300. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  9301. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  9302. */
  9303. export class KeyboardInfoPre extends KeyboardInfo {
  9304. /**
  9305. * Defines the type of event (KeyboardEventTypes)
  9306. */
  9307. type: number;
  9308. /**
  9309. * Defines the related dom event
  9310. */
  9311. event: KeyboardEvent;
  9312. /**
  9313. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  9314. */
  9315. skipOnPointerObservable: boolean;
  9316. /**
  9317. * Instantiates a new keyboard pre info.
  9318. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  9319. * @param type Defines the type of event (KeyboardEventTypes)
  9320. * @param event Defines the related dom event
  9321. */
  9322. constructor(
  9323. /**
  9324. * Defines the type of event (KeyboardEventTypes)
  9325. */
  9326. type: number,
  9327. /**
  9328. * Defines the related dom event
  9329. */
  9330. event: KeyboardEvent);
  9331. }
  9332. }
  9333. declare module BABYLON {
  9334. /**
  9335. * Manage the keyboard inputs to control the movement of a free camera.
  9336. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  9337. */
  9338. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  9339. /**
  9340. * Defines the camera the input is attached to.
  9341. */
  9342. camera: FreeCamera;
  9343. /**
  9344. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  9345. */
  9346. keysUp: number[];
  9347. /**
  9348. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  9349. */
  9350. keysUpward: number[];
  9351. /**
  9352. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  9353. */
  9354. keysDown: number[];
  9355. /**
  9356. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  9357. */
  9358. keysDownward: number[];
  9359. /**
  9360. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  9361. */
  9362. keysLeft: number[];
  9363. /**
  9364. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  9365. */
  9366. keysRight: number[];
  9367. private _keys;
  9368. private _onCanvasBlurObserver;
  9369. private _onKeyboardObserver;
  9370. private _engine;
  9371. private _scene;
  9372. /**
  9373. * Attach the input controls to a specific dom element to get the input from.
  9374. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  9375. */
  9376. attachControl(noPreventDefault?: boolean): void;
  9377. /**
  9378. * Detach the current controls from the specified dom element.
  9379. */
  9380. detachControl(): void;
  9381. /**
  9382. * Update the current camera state depending on the inputs that have been used this frame.
  9383. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  9384. */
  9385. checkInputs(): void;
  9386. /**
  9387. * Gets the class name of the current intput.
  9388. * @returns the class name
  9389. */
  9390. getClassName(): string;
  9391. /** @hidden */
  9392. _onLostFocus(): void;
  9393. /**
  9394. * Get the friendly name associated with the input class.
  9395. * @returns the input friendly name
  9396. */
  9397. getSimpleName(): string;
  9398. }
  9399. }
  9400. declare module BABYLON {
  9401. /**
  9402. * Interface used to define Action
  9403. */
  9404. export interface IAction {
  9405. /**
  9406. * Trigger for the action
  9407. */
  9408. trigger: number;
  9409. /** Options of the trigger */
  9410. triggerOptions: any;
  9411. /**
  9412. * Gets the trigger parameters
  9413. * @returns the trigger parameters
  9414. */
  9415. getTriggerParameter(): any;
  9416. /**
  9417. * Internal only - executes current action event
  9418. * @hidden
  9419. */
  9420. _executeCurrent(evt?: ActionEvent): void;
  9421. /**
  9422. * Serialize placeholder for child classes
  9423. * @param parent of child
  9424. * @returns the serialized object
  9425. */
  9426. serialize(parent: any): any;
  9427. /**
  9428. * Internal only
  9429. * @hidden
  9430. */
  9431. _prepare(): void;
  9432. /**
  9433. * Internal only - manager for action
  9434. * @hidden
  9435. */
  9436. _actionManager: Nullable<AbstractActionManager>;
  9437. /**
  9438. * Adds action to chain of actions, may be a DoNothingAction
  9439. * @param action defines the next action to execute
  9440. * @returns The action passed in
  9441. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9442. */
  9443. then(action: IAction): IAction;
  9444. }
  9445. /**
  9446. * The action to be carried out following a trigger
  9447. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  9448. */
  9449. export class Action implements IAction {
  9450. /** the trigger, with or without parameters, for the action */
  9451. triggerOptions: any;
  9452. /**
  9453. * Trigger for the action
  9454. */
  9455. trigger: number;
  9456. /**
  9457. * Internal only - manager for action
  9458. * @hidden
  9459. */
  9460. _actionManager: ActionManager;
  9461. private _nextActiveAction;
  9462. private _child;
  9463. private _condition?;
  9464. private _triggerParameter;
  9465. /**
  9466. * An event triggered prior to action being executed.
  9467. */
  9468. onBeforeExecuteObservable: Observable<Action>;
  9469. /**
  9470. * Creates a new Action
  9471. * @param triggerOptions the trigger, with or without parameters, for the action
  9472. * @param condition an optional determinant of action
  9473. */
  9474. constructor(
  9475. /** the trigger, with or without parameters, for the action */
  9476. triggerOptions: any, condition?: Condition);
  9477. /**
  9478. * Internal only
  9479. * @hidden
  9480. */
  9481. _prepare(): void;
  9482. /**
  9483. * Gets the trigger parameters
  9484. * @returns the trigger parameters
  9485. */
  9486. getTriggerParameter(): any;
  9487. /**
  9488. * Internal only - executes current action event
  9489. * @hidden
  9490. */
  9491. _executeCurrent(evt?: ActionEvent): void;
  9492. /**
  9493. * Execute placeholder for child classes
  9494. * @param evt optional action event
  9495. */
  9496. execute(evt?: ActionEvent): void;
  9497. /**
  9498. * Skips to next active action
  9499. */
  9500. skipToNextActiveAction(): void;
  9501. /**
  9502. * Adds action to chain of actions, may be a DoNothingAction
  9503. * @param action defines the next action to execute
  9504. * @returns The action passed in
  9505. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9506. */
  9507. then(action: Action): Action;
  9508. /**
  9509. * Internal only
  9510. * @hidden
  9511. */
  9512. _getProperty(propertyPath: string): string;
  9513. /**
  9514. * Internal only
  9515. * @hidden
  9516. */
  9517. _getEffectiveTarget(target: any, propertyPath: string): any;
  9518. /**
  9519. * Serialize placeholder for child classes
  9520. * @param parent of child
  9521. * @returns the serialized object
  9522. */
  9523. serialize(parent: any): any;
  9524. /**
  9525. * Internal only called by serialize
  9526. * @hidden
  9527. */
  9528. protected _serialize(serializedAction: any, parent?: any): any;
  9529. /**
  9530. * Internal only
  9531. * @hidden
  9532. */
  9533. static _SerializeValueAsString: (value: any) => string;
  9534. /**
  9535. * Internal only
  9536. * @hidden
  9537. */
  9538. static _GetTargetProperty: (target: Scene | Node) => {
  9539. name: string;
  9540. targetType: string;
  9541. value: string;
  9542. };
  9543. }
  9544. }
  9545. declare module BABYLON {
  9546. /**
  9547. * A Condition applied to an Action
  9548. */
  9549. export class Condition {
  9550. /**
  9551. * Internal only - manager for action
  9552. * @hidden
  9553. */
  9554. _actionManager: ActionManager;
  9555. /**
  9556. * Internal only
  9557. * @hidden
  9558. */
  9559. _evaluationId: number;
  9560. /**
  9561. * Internal only
  9562. * @hidden
  9563. */
  9564. _currentResult: boolean;
  9565. /**
  9566. * Creates a new Condition
  9567. * @param actionManager the manager of the action the condition is applied to
  9568. */
  9569. constructor(actionManager: ActionManager);
  9570. /**
  9571. * Check if the current condition is valid
  9572. * @returns a boolean
  9573. */
  9574. isValid(): boolean;
  9575. /**
  9576. * Internal only
  9577. * @hidden
  9578. */
  9579. _getProperty(propertyPath: string): string;
  9580. /**
  9581. * Internal only
  9582. * @hidden
  9583. */
  9584. _getEffectiveTarget(target: any, propertyPath: string): any;
  9585. /**
  9586. * Serialize placeholder for child classes
  9587. * @returns the serialized object
  9588. */
  9589. serialize(): any;
  9590. /**
  9591. * Internal only
  9592. * @hidden
  9593. */
  9594. protected _serialize(serializedCondition: any): any;
  9595. }
  9596. /**
  9597. * Defines specific conditional operators as extensions of Condition
  9598. */
  9599. export class ValueCondition extends Condition {
  9600. /** path to specify the property of the target the conditional operator uses */
  9601. propertyPath: string;
  9602. /** the value compared by the conditional operator against the current value of the property */
  9603. value: any;
  9604. /** the conditional operator, default ValueCondition.IsEqual */
  9605. operator: number;
  9606. /**
  9607. * Internal only
  9608. * @hidden
  9609. */
  9610. private static _IsEqual;
  9611. /**
  9612. * Internal only
  9613. * @hidden
  9614. */
  9615. private static _IsDifferent;
  9616. /**
  9617. * Internal only
  9618. * @hidden
  9619. */
  9620. private static _IsGreater;
  9621. /**
  9622. * Internal only
  9623. * @hidden
  9624. */
  9625. private static _IsLesser;
  9626. /**
  9627. * returns the number for IsEqual
  9628. */
  9629. static get IsEqual(): number;
  9630. /**
  9631. * Returns the number for IsDifferent
  9632. */
  9633. static get IsDifferent(): number;
  9634. /**
  9635. * Returns the number for IsGreater
  9636. */
  9637. static get IsGreater(): number;
  9638. /**
  9639. * Returns the number for IsLesser
  9640. */
  9641. static get IsLesser(): number;
  9642. /**
  9643. * Internal only The action manager for the condition
  9644. * @hidden
  9645. */
  9646. _actionManager: ActionManager;
  9647. /**
  9648. * Internal only
  9649. * @hidden
  9650. */
  9651. private _target;
  9652. /**
  9653. * Internal only
  9654. * @hidden
  9655. */
  9656. private _effectiveTarget;
  9657. /**
  9658. * Internal only
  9659. * @hidden
  9660. */
  9661. private _property;
  9662. /**
  9663. * Creates a new ValueCondition
  9664. * @param actionManager manager for the action the condition applies to
  9665. * @param target for the action
  9666. * @param propertyPath path to specify the property of the target the conditional operator uses
  9667. * @param value the value compared by the conditional operator against the current value of the property
  9668. * @param operator the conditional operator, default ValueCondition.IsEqual
  9669. */
  9670. constructor(actionManager: ActionManager, target: any,
  9671. /** path to specify the property of the target the conditional operator uses */
  9672. propertyPath: string,
  9673. /** the value compared by the conditional operator against the current value of the property */
  9674. value: any,
  9675. /** the conditional operator, default ValueCondition.IsEqual */
  9676. operator?: number);
  9677. /**
  9678. * Compares the given value with the property value for the specified conditional operator
  9679. * @returns the result of the comparison
  9680. */
  9681. isValid(): boolean;
  9682. /**
  9683. * Serialize the ValueCondition into a JSON compatible object
  9684. * @returns serialization object
  9685. */
  9686. serialize(): any;
  9687. /**
  9688. * Gets the name of the conditional operator for the ValueCondition
  9689. * @param operator the conditional operator
  9690. * @returns the name
  9691. */
  9692. static GetOperatorName(operator: number): string;
  9693. }
  9694. /**
  9695. * Defines a predicate condition as an extension of Condition
  9696. */
  9697. export class PredicateCondition extends Condition {
  9698. /** defines the predicate function used to validate the condition */
  9699. predicate: () => boolean;
  9700. /**
  9701. * Internal only - manager for action
  9702. * @hidden
  9703. */
  9704. _actionManager: ActionManager;
  9705. /**
  9706. * Creates a new PredicateCondition
  9707. * @param actionManager manager for the action the condition applies to
  9708. * @param predicate defines the predicate function used to validate the condition
  9709. */
  9710. constructor(actionManager: ActionManager,
  9711. /** defines the predicate function used to validate the condition */
  9712. predicate: () => boolean);
  9713. /**
  9714. * @returns the validity of the predicate condition
  9715. */
  9716. isValid(): boolean;
  9717. }
  9718. /**
  9719. * Defines a state condition as an extension of Condition
  9720. */
  9721. export class StateCondition extends Condition {
  9722. /** Value to compare with target state */
  9723. value: string;
  9724. /**
  9725. * Internal only - manager for action
  9726. * @hidden
  9727. */
  9728. _actionManager: ActionManager;
  9729. /**
  9730. * Internal only
  9731. * @hidden
  9732. */
  9733. private _target;
  9734. /**
  9735. * Creates a new StateCondition
  9736. * @param actionManager manager for the action the condition applies to
  9737. * @param target of the condition
  9738. * @param value to compare with target state
  9739. */
  9740. constructor(actionManager: ActionManager, target: any,
  9741. /** Value to compare with target state */
  9742. value: string);
  9743. /**
  9744. * Gets a boolean indicating if the current condition is met
  9745. * @returns the validity of the state
  9746. */
  9747. isValid(): boolean;
  9748. /**
  9749. * Serialize the StateCondition into a JSON compatible object
  9750. * @returns serialization object
  9751. */
  9752. serialize(): any;
  9753. }
  9754. }
  9755. declare module BABYLON {
  9756. /**
  9757. * This defines an action responsible to toggle a boolean once triggered.
  9758. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9759. */
  9760. export class SwitchBooleanAction extends Action {
  9761. /**
  9762. * The path to the boolean property in the target object
  9763. */
  9764. propertyPath: string;
  9765. private _target;
  9766. private _effectiveTarget;
  9767. private _property;
  9768. /**
  9769. * Instantiate the action
  9770. * @param triggerOptions defines the trigger options
  9771. * @param target defines the object containing the boolean
  9772. * @param propertyPath defines the path to the boolean property in the target object
  9773. * @param condition defines the trigger related conditions
  9774. */
  9775. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  9776. /** @hidden */
  9777. _prepare(): void;
  9778. /**
  9779. * Execute the action toggle the boolean value.
  9780. */
  9781. execute(): void;
  9782. /**
  9783. * Serializes the actions and its related information.
  9784. * @param parent defines the object to serialize in
  9785. * @returns the serialized object
  9786. */
  9787. serialize(parent: any): any;
  9788. }
  9789. /**
  9790. * This defines an action responsible to set a the state field of the target
  9791. * to a desired value once triggered.
  9792. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9793. */
  9794. export class SetStateAction extends Action {
  9795. /**
  9796. * The value to store in the state field.
  9797. */
  9798. value: string;
  9799. private _target;
  9800. /**
  9801. * Instantiate the action
  9802. * @param triggerOptions defines the trigger options
  9803. * @param target defines the object containing the state property
  9804. * @param value defines the value to store in the state field
  9805. * @param condition defines the trigger related conditions
  9806. */
  9807. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  9808. /**
  9809. * Execute the action and store the value on the target state property.
  9810. */
  9811. execute(): void;
  9812. /**
  9813. * Serializes the actions and its related information.
  9814. * @param parent defines the object to serialize in
  9815. * @returns the serialized object
  9816. */
  9817. serialize(parent: any): any;
  9818. }
  9819. /**
  9820. * This defines an action responsible to set a property of the target
  9821. * to a desired value once triggered.
  9822. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9823. */
  9824. export class SetValueAction extends Action {
  9825. /**
  9826. * The path of the property to set in the target.
  9827. */
  9828. propertyPath: string;
  9829. /**
  9830. * The value to set in the property
  9831. */
  9832. value: any;
  9833. private _target;
  9834. private _effectiveTarget;
  9835. private _property;
  9836. /**
  9837. * Instantiate the action
  9838. * @param triggerOptions defines the trigger options
  9839. * @param target defines the object containing the property
  9840. * @param propertyPath defines the path of the property to set in the target
  9841. * @param value defines the value to set in the property
  9842. * @param condition defines the trigger related conditions
  9843. */
  9844. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  9845. /** @hidden */
  9846. _prepare(): void;
  9847. /**
  9848. * Execute the action and set the targetted property to the desired value.
  9849. */
  9850. execute(): void;
  9851. /**
  9852. * Serializes the actions and its related information.
  9853. * @param parent defines the object to serialize in
  9854. * @returns the serialized object
  9855. */
  9856. serialize(parent: any): any;
  9857. }
  9858. /**
  9859. * This defines an action responsible to increment the target value
  9860. * to a desired value once triggered.
  9861. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9862. */
  9863. export class IncrementValueAction extends Action {
  9864. /**
  9865. * The path of the property to increment in the target.
  9866. */
  9867. propertyPath: string;
  9868. /**
  9869. * The value we should increment the property by.
  9870. */
  9871. value: any;
  9872. private _target;
  9873. private _effectiveTarget;
  9874. private _property;
  9875. /**
  9876. * Instantiate the action
  9877. * @param triggerOptions defines the trigger options
  9878. * @param target defines the object containing the property
  9879. * @param propertyPath defines the path of the property to increment in the target
  9880. * @param value defines the value value we should increment the property by
  9881. * @param condition defines the trigger related conditions
  9882. */
  9883. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  9884. /** @hidden */
  9885. _prepare(): void;
  9886. /**
  9887. * Execute the action and increment the target of the value amount.
  9888. */
  9889. execute(): void;
  9890. /**
  9891. * Serializes the actions and its related information.
  9892. * @param parent defines the object to serialize in
  9893. * @returns the serialized object
  9894. */
  9895. serialize(parent: any): any;
  9896. }
  9897. /**
  9898. * This defines an action responsible to start an animation once triggered.
  9899. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9900. */
  9901. export class PlayAnimationAction extends Action {
  9902. /**
  9903. * Where the animation should start (animation frame)
  9904. */
  9905. from: number;
  9906. /**
  9907. * Where the animation should stop (animation frame)
  9908. */
  9909. to: number;
  9910. /**
  9911. * Define if the animation should loop or stop after the first play.
  9912. */
  9913. loop?: boolean;
  9914. private _target;
  9915. /**
  9916. * Instantiate the action
  9917. * @param triggerOptions defines the trigger options
  9918. * @param target defines the target animation or animation name
  9919. * @param from defines from where the animation should start (animation frame)
  9920. * @param end defines where the animation should stop (animation frame)
  9921. * @param loop defines if the animation should loop or stop after the first play
  9922. * @param condition defines the trigger related conditions
  9923. */
  9924. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  9925. /** @hidden */
  9926. _prepare(): void;
  9927. /**
  9928. * Execute the action and play the animation.
  9929. */
  9930. execute(): void;
  9931. /**
  9932. * Serializes the actions and its related information.
  9933. * @param parent defines the object to serialize in
  9934. * @returns the serialized object
  9935. */
  9936. serialize(parent: any): any;
  9937. }
  9938. /**
  9939. * This defines an action responsible to stop an animation once triggered.
  9940. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9941. */
  9942. export class StopAnimationAction extends Action {
  9943. private _target;
  9944. /**
  9945. * Instantiate the action
  9946. * @param triggerOptions defines the trigger options
  9947. * @param target defines the target animation or animation name
  9948. * @param condition defines the trigger related conditions
  9949. */
  9950. constructor(triggerOptions: any, target: any, condition?: Condition);
  9951. /** @hidden */
  9952. _prepare(): void;
  9953. /**
  9954. * Execute the action and stop the animation.
  9955. */
  9956. execute(): void;
  9957. /**
  9958. * Serializes the actions and its related information.
  9959. * @param parent defines the object to serialize in
  9960. * @returns the serialized object
  9961. */
  9962. serialize(parent: any): any;
  9963. }
  9964. /**
  9965. * This defines an action responsible that does nothing once triggered.
  9966. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9967. */
  9968. export class DoNothingAction extends Action {
  9969. /**
  9970. * Instantiate the action
  9971. * @param triggerOptions defines the trigger options
  9972. * @param condition defines the trigger related conditions
  9973. */
  9974. constructor(triggerOptions?: any, condition?: Condition);
  9975. /**
  9976. * Execute the action and do nothing.
  9977. */
  9978. execute(): void;
  9979. /**
  9980. * Serializes the actions and its related information.
  9981. * @param parent defines the object to serialize in
  9982. * @returns the serialized object
  9983. */
  9984. serialize(parent: any): any;
  9985. }
  9986. /**
  9987. * This defines an action responsible to trigger several actions once triggered.
  9988. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9989. */
  9990. export class CombineAction extends Action {
  9991. /**
  9992. * The list of aggregated animations to run.
  9993. */
  9994. children: Action[];
  9995. /**
  9996. * Instantiate the action
  9997. * @param triggerOptions defines the trigger options
  9998. * @param children defines the list of aggregated animations to run
  9999. * @param condition defines the trigger related conditions
  10000. */
  10001. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10002. /** @hidden */
  10003. _prepare(): void;
  10004. /**
  10005. * Execute the action and executes all the aggregated actions.
  10006. */
  10007. execute(evt: ActionEvent): void;
  10008. /**
  10009. * Serializes the actions and its related information.
  10010. * @param parent defines the object to serialize in
  10011. * @returns the serialized object
  10012. */
  10013. serialize(parent: any): any;
  10014. }
  10015. /**
  10016. * This defines an action responsible to run code (external event) once triggered.
  10017. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10018. */
  10019. export class ExecuteCodeAction extends Action {
  10020. /**
  10021. * The callback function to run.
  10022. */
  10023. func: (evt: ActionEvent) => void;
  10024. /**
  10025. * Instantiate the action
  10026. * @param triggerOptions defines the trigger options
  10027. * @param func defines the callback function to run
  10028. * @param condition defines the trigger related conditions
  10029. */
  10030. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10031. /**
  10032. * Execute the action and run the attached code.
  10033. */
  10034. execute(evt: ActionEvent): void;
  10035. }
  10036. /**
  10037. * This defines an action responsible to set the parent property of the target once triggered.
  10038. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10039. */
  10040. export class SetParentAction extends Action {
  10041. private _parent;
  10042. private _target;
  10043. /**
  10044. * Instantiate the action
  10045. * @param triggerOptions defines the trigger options
  10046. * @param target defines the target containing the parent property
  10047. * @param parent defines from where the animation should start (animation frame)
  10048. * @param condition defines the trigger related conditions
  10049. */
  10050. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10051. /** @hidden */
  10052. _prepare(): void;
  10053. /**
  10054. * Execute the action and set the parent property.
  10055. */
  10056. execute(): void;
  10057. /**
  10058. * Serializes the actions and its related information.
  10059. * @param parent defines the object to serialize in
  10060. * @returns the serialized object
  10061. */
  10062. serialize(parent: any): any;
  10063. }
  10064. }
  10065. declare module BABYLON {
  10066. /**
  10067. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10068. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10069. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10070. */
  10071. export class ActionManager extends AbstractActionManager {
  10072. /**
  10073. * Nothing
  10074. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10075. */
  10076. static readonly NothingTrigger: number;
  10077. /**
  10078. * On pick
  10079. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10080. */
  10081. static readonly OnPickTrigger: number;
  10082. /**
  10083. * On left pick
  10084. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10085. */
  10086. static readonly OnLeftPickTrigger: number;
  10087. /**
  10088. * On right pick
  10089. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10090. */
  10091. static readonly OnRightPickTrigger: number;
  10092. /**
  10093. * On center pick
  10094. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10095. */
  10096. static readonly OnCenterPickTrigger: number;
  10097. /**
  10098. * On pick down
  10099. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10100. */
  10101. static readonly OnPickDownTrigger: number;
  10102. /**
  10103. * On double pick
  10104. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10105. */
  10106. static readonly OnDoublePickTrigger: number;
  10107. /**
  10108. * On pick up
  10109. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10110. */
  10111. static readonly OnPickUpTrigger: number;
  10112. /**
  10113. * On pick out.
  10114. * This trigger will only be raised if you also declared a OnPickDown
  10115. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10116. */
  10117. static readonly OnPickOutTrigger: number;
  10118. /**
  10119. * On long press
  10120. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10121. */
  10122. static readonly OnLongPressTrigger: number;
  10123. /**
  10124. * On pointer over
  10125. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10126. */
  10127. static readonly OnPointerOverTrigger: number;
  10128. /**
  10129. * On pointer out
  10130. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10131. */
  10132. static readonly OnPointerOutTrigger: number;
  10133. /**
  10134. * On every frame
  10135. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10136. */
  10137. static readonly OnEveryFrameTrigger: number;
  10138. /**
  10139. * On intersection enter
  10140. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10141. */
  10142. static readonly OnIntersectionEnterTrigger: number;
  10143. /**
  10144. * On intersection exit
  10145. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10146. */
  10147. static readonly OnIntersectionExitTrigger: number;
  10148. /**
  10149. * On key down
  10150. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10151. */
  10152. static readonly OnKeyDownTrigger: number;
  10153. /**
  10154. * On key up
  10155. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10156. */
  10157. static readonly OnKeyUpTrigger: number;
  10158. private _scene;
  10159. /**
  10160. * Creates a new action manager
  10161. * @param scene defines the hosting scene
  10162. */
  10163. constructor(scene: Scene);
  10164. /**
  10165. * Releases all associated resources
  10166. */
  10167. dispose(): void;
  10168. /**
  10169. * Gets hosting scene
  10170. * @returns the hosting scene
  10171. */
  10172. getScene(): Scene;
  10173. /**
  10174. * Does this action manager handles actions of any of the given triggers
  10175. * @param triggers defines the triggers to be tested
  10176. * @return a boolean indicating whether one (or more) of the triggers is handled
  10177. */
  10178. hasSpecificTriggers(triggers: number[]): boolean;
  10179. /**
  10180. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10181. * speed.
  10182. * @param triggerA defines the trigger to be tested
  10183. * @param triggerB defines the trigger to be tested
  10184. * @return a boolean indicating whether one (or more) of the triggers is handled
  10185. */
  10186. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10187. /**
  10188. * Does this action manager handles actions of a given trigger
  10189. * @param trigger defines the trigger to be tested
  10190. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10191. * @return whether the trigger is handled
  10192. */
  10193. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10194. /**
  10195. * Does this action manager has pointer triggers
  10196. */
  10197. get hasPointerTriggers(): boolean;
  10198. /**
  10199. * Does this action manager has pick triggers
  10200. */
  10201. get hasPickTriggers(): boolean;
  10202. /**
  10203. * Registers an action to this action manager
  10204. * @param action defines the action to be registered
  10205. * @return the action amended (prepared) after registration
  10206. */
  10207. registerAction(action: IAction): Nullable<IAction>;
  10208. /**
  10209. * Unregisters an action to this action manager
  10210. * @param action defines the action to be unregistered
  10211. * @return a boolean indicating whether the action has been unregistered
  10212. */
  10213. unregisterAction(action: IAction): Boolean;
  10214. /**
  10215. * Process a specific trigger
  10216. * @param trigger defines the trigger to process
  10217. * @param evt defines the event details to be processed
  10218. */
  10219. processTrigger(trigger: number, evt?: IActionEvent): void;
  10220. /** @hidden */
  10221. _getEffectiveTarget(target: any, propertyPath: string): any;
  10222. /** @hidden */
  10223. _getProperty(propertyPath: string): string;
  10224. /**
  10225. * Serialize this manager to a JSON object
  10226. * @param name defines the property name to store this manager
  10227. * @returns a JSON representation of this manager
  10228. */
  10229. serialize(name: string): any;
  10230. /**
  10231. * Creates a new ActionManager from a JSON data
  10232. * @param parsedActions defines the JSON data to read from
  10233. * @param object defines the hosting mesh
  10234. * @param scene defines the hosting scene
  10235. */
  10236. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10237. /**
  10238. * Get a trigger name by index
  10239. * @param trigger defines the trigger index
  10240. * @returns a trigger name
  10241. */
  10242. static GetTriggerName(trigger: number): string;
  10243. }
  10244. }
  10245. declare module BABYLON {
  10246. /**
  10247. * Class representing a ray with position and direction
  10248. */
  10249. export class Ray {
  10250. /** origin point */
  10251. origin: Vector3;
  10252. /** direction */
  10253. direction: Vector3;
  10254. /** length of the ray */
  10255. length: number;
  10256. private static readonly _TmpVector3;
  10257. private _tmpRay;
  10258. /**
  10259. * Creates a new ray
  10260. * @param origin origin point
  10261. * @param direction direction
  10262. * @param length length of the ray
  10263. */
  10264. constructor(
  10265. /** origin point */
  10266. origin: Vector3,
  10267. /** direction */
  10268. direction: Vector3,
  10269. /** length of the ray */
  10270. length?: number);
  10271. /**
  10272. * Checks if the ray intersects a box
  10273. * This does not account for the ray lenght by design to improve perfs.
  10274. * @param minimum bound of the box
  10275. * @param maximum bound of the box
  10276. * @param intersectionTreshold extra extend to be added to the box in all direction
  10277. * @returns if the box was hit
  10278. */
  10279. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  10280. /**
  10281. * Checks if the ray intersects a box
  10282. * This does not account for the ray lenght by design to improve perfs.
  10283. * @param box the bounding box to check
  10284. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  10285. * @returns if the box was hit
  10286. */
  10287. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  10288. /**
  10289. * If the ray hits a sphere
  10290. * @param sphere the bounding sphere to check
  10291. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  10292. * @returns true if it hits the sphere
  10293. */
  10294. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  10295. /**
  10296. * If the ray hits a triange
  10297. * @param vertex0 triangle vertex
  10298. * @param vertex1 triangle vertex
  10299. * @param vertex2 triangle vertex
  10300. * @returns intersection information if hit
  10301. */
  10302. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  10303. /**
  10304. * Checks if ray intersects a plane
  10305. * @param plane the plane to check
  10306. * @returns the distance away it was hit
  10307. */
  10308. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  10309. /**
  10310. * Calculate the intercept of a ray on a given axis
  10311. * @param axis to check 'x' | 'y' | 'z'
  10312. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  10313. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  10314. */
  10315. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  10316. /**
  10317. * Checks if ray intersects a mesh
  10318. * @param mesh the mesh to check
  10319. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10320. * @returns picking info of the intersecton
  10321. */
  10322. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  10323. /**
  10324. * Checks if ray intersects a mesh
  10325. * @param meshes the meshes to check
  10326. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10327. * @param results array to store result in
  10328. * @returns Array of picking infos
  10329. */
  10330. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  10331. private _comparePickingInfo;
  10332. private static smallnum;
  10333. private static rayl;
  10334. /**
  10335. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  10336. * @param sega the first point of the segment to test the intersection against
  10337. * @param segb the second point of the segment to test the intersection against
  10338. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  10339. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  10340. */
  10341. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  10342. /**
  10343. * Update the ray from viewport position
  10344. * @param x position
  10345. * @param y y position
  10346. * @param viewportWidth viewport width
  10347. * @param viewportHeight viewport height
  10348. * @param world world matrix
  10349. * @param view view matrix
  10350. * @param projection projection matrix
  10351. * @returns this ray updated
  10352. */
  10353. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10354. /**
  10355. * Creates a ray with origin and direction of 0,0,0
  10356. * @returns the new ray
  10357. */
  10358. static Zero(): Ray;
  10359. /**
  10360. * Creates a new ray from screen space and viewport
  10361. * @param x position
  10362. * @param y y position
  10363. * @param viewportWidth viewport width
  10364. * @param viewportHeight viewport height
  10365. * @param world world matrix
  10366. * @param view view matrix
  10367. * @param projection projection matrix
  10368. * @returns new ray
  10369. */
  10370. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10371. /**
  10372. * 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
  10373. * transformed to the given world matrix.
  10374. * @param origin The origin point
  10375. * @param end The end point
  10376. * @param world a matrix to transform the ray to. Default is the identity matrix.
  10377. * @returns the new ray
  10378. */
  10379. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  10380. /**
  10381. * Transforms a ray by a matrix
  10382. * @param ray ray to transform
  10383. * @param matrix matrix to apply
  10384. * @returns the resulting new ray
  10385. */
  10386. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  10387. /**
  10388. * Transforms a ray by a matrix
  10389. * @param ray ray to transform
  10390. * @param matrix matrix to apply
  10391. * @param result ray to store result in
  10392. */
  10393. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  10394. /**
  10395. * Unproject a ray from screen space to object space
  10396. * @param sourceX defines the screen space x coordinate to use
  10397. * @param sourceY defines the screen space y coordinate to use
  10398. * @param viewportWidth defines the current width of the viewport
  10399. * @param viewportHeight defines the current height of the viewport
  10400. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  10401. * @param view defines the view matrix to use
  10402. * @param projection defines the projection matrix to use
  10403. */
  10404. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  10405. }
  10406. /**
  10407. * Type used to define predicate used to select faces when a mesh intersection is detected
  10408. */
  10409. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  10410. interface Scene {
  10411. /** @hidden */
  10412. _tempPickingRay: Nullable<Ray>;
  10413. /** @hidden */
  10414. _cachedRayForTransform: Ray;
  10415. /** @hidden */
  10416. _pickWithRayInverseMatrix: Matrix;
  10417. /** @hidden */
  10418. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10419. /** @hidden */
  10420. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  10421. /** @hidden */
  10422. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate, skipBoundingInfo?: boolean): Nullable<PickingInfo>;
  10423. }
  10424. }
  10425. declare module BABYLON {
  10426. /**
  10427. * Groups all the scene component constants in one place to ease maintenance.
  10428. * @hidden
  10429. */
  10430. export class SceneComponentConstants {
  10431. static readonly NAME_EFFECTLAYER: string;
  10432. static readonly NAME_LAYER: string;
  10433. static readonly NAME_LENSFLARESYSTEM: string;
  10434. static readonly NAME_BOUNDINGBOXRENDERER: string;
  10435. static readonly NAME_PARTICLESYSTEM: string;
  10436. static readonly NAME_GAMEPAD: string;
  10437. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  10438. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  10439. static readonly NAME_PREPASSRENDERER: string;
  10440. static readonly NAME_DEPTHRENDERER: string;
  10441. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  10442. static readonly NAME_SPRITE: string;
  10443. static readonly NAME_SUBSURFACE: string;
  10444. static readonly NAME_OUTLINERENDERER: string;
  10445. static readonly NAME_PROCEDURALTEXTURE: string;
  10446. static readonly NAME_SHADOWGENERATOR: string;
  10447. static readonly NAME_OCTREE: string;
  10448. static readonly NAME_PHYSICSENGINE: string;
  10449. static readonly NAME_AUDIO: string;
  10450. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  10451. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10452. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  10453. static readonly STEP_PREACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10454. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  10455. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  10456. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  10457. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  10458. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  10459. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  10460. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  10461. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  10462. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  10463. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  10464. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  10465. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  10466. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  10467. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  10468. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  10469. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  10470. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  10471. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  10472. static readonly STEP_AFTERRENDER_AUDIO: number;
  10473. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  10474. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  10475. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  10476. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  10477. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  10478. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  10479. static readonly STEP_POINTERMOVE_SPRITE: number;
  10480. static readonly STEP_POINTERDOWN_SPRITE: number;
  10481. static readonly STEP_POINTERUP_SPRITE: number;
  10482. }
  10483. /**
  10484. * This represents a scene component.
  10485. *
  10486. * This is used to decouple the dependency the scene is having on the different workloads like
  10487. * layers, post processes...
  10488. */
  10489. export interface ISceneComponent {
  10490. /**
  10491. * The name of the component. Each component must have a unique name.
  10492. */
  10493. name: string;
  10494. /**
  10495. * The scene the component belongs to.
  10496. */
  10497. scene: Scene;
  10498. /**
  10499. * Register the component to one instance of a scene.
  10500. */
  10501. register(): void;
  10502. /**
  10503. * Rebuilds the elements related to this component in case of
  10504. * context lost for instance.
  10505. */
  10506. rebuild(): void;
  10507. /**
  10508. * Disposes the component and the associated ressources.
  10509. */
  10510. dispose(): void;
  10511. }
  10512. /**
  10513. * This represents a SERIALIZABLE scene component.
  10514. *
  10515. * This extends Scene Component to add Serialization methods on top.
  10516. */
  10517. export interface ISceneSerializableComponent extends ISceneComponent {
  10518. /**
  10519. * Adds all the elements from the container to the scene
  10520. * @param container the container holding the elements
  10521. */
  10522. addFromContainer(container: AbstractScene): void;
  10523. /**
  10524. * Removes all the elements in the container from the scene
  10525. * @param container contains the elements to remove
  10526. * @param dispose if the removed element should be disposed (default: false)
  10527. */
  10528. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  10529. /**
  10530. * Serializes the component data to the specified json object
  10531. * @param serializationObject The object to serialize to
  10532. */
  10533. serialize(serializationObject: any): void;
  10534. }
  10535. /**
  10536. * Strong typing of a Mesh related stage step action
  10537. */
  10538. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  10539. /**
  10540. * Strong typing of a Evaluate Sub Mesh related stage step action
  10541. */
  10542. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  10543. /**
  10544. * Strong typing of a pre active Mesh related stage step action
  10545. */
  10546. export type PreActiveMeshStageAction = (mesh: AbstractMesh) => void;
  10547. /**
  10548. * Strong typing of a Camera related stage step action
  10549. */
  10550. export type CameraStageAction = (camera: Camera) => void;
  10551. /**
  10552. * Strong typing of a Camera Frame buffer related stage step action
  10553. */
  10554. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  10555. /**
  10556. * Strong typing of a Render Target related stage step action
  10557. */
  10558. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  10559. /**
  10560. * Strong typing of a RenderingGroup related stage step action
  10561. */
  10562. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  10563. /**
  10564. * Strong typing of a Mesh Render related stage step action
  10565. */
  10566. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  10567. /**
  10568. * Strong typing of a simple stage step action
  10569. */
  10570. export type SimpleStageAction = () => void;
  10571. /**
  10572. * Strong typing of a render target action.
  10573. */
  10574. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  10575. /**
  10576. * Strong typing of a pointer move action.
  10577. */
  10578. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  10579. /**
  10580. * Strong typing of a pointer up/down action.
  10581. */
  10582. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  10583. /**
  10584. * Representation of a stage in the scene (Basically a list of ordered steps)
  10585. * @hidden
  10586. */
  10587. export class Stage<T extends Function> extends Array<{
  10588. index: number;
  10589. component: ISceneComponent;
  10590. action: T;
  10591. }> {
  10592. /**
  10593. * Hide ctor from the rest of the world.
  10594. * @param items The items to add.
  10595. */
  10596. private constructor();
  10597. /**
  10598. * Creates a new Stage.
  10599. * @returns A new instance of a Stage
  10600. */
  10601. static Create<T extends Function>(): Stage<T>;
  10602. /**
  10603. * Registers a step in an ordered way in the targeted stage.
  10604. * @param index Defines the position to register the step in
  10605. * @param component Defines the component attached to the step
  10606. * @param action Defines the action to launch during the step
  10607. */
  10608. registerStep(index: number, component: ISceneComponent, action: T): void;
  10609. /**
  10610. * Clears all the steps from the stage.
  10611. */
  10612. clear(): void;
  10613. }
  10614. }
  10615. declare module BABYLON {
  10616. interface Scene {
  10617. /** @hidden */
  10618. _pointerOverSprite: Nullable<Sprite>;
  10619. /** @hidden */
  10620. _pickedDownSprite: Nullable<Sprite>;
  10621. /** @hidden */
  10622. _tempSpritePickingRay: Nullable<Ray>;
  10623. /**
  10624. * All of the sprite managers added to this scene
  10625. * @see https://doc.babylonjs.com/babylon101/sprites
  10626. */
  10627. spriteManagers: Array<ISpriteManager>;
  10628. /**
  10629. * An event triggered when sprites rendering is about to start
  10630. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  10631. */
  10632. onBeforeSpritesRenderingObservable: Observable<Scene>;
  10633. /**
  10634. * An event triggered when sprites rendering is done
  10635. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  10636. */
  10637. onAfterSpritesRenderingObservable: Observable<Scene>;
  10638. /** @hidden */
  10639. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  10640. /** Launch a ray to try to pick a sprite in the scene
  10641. * @param x position on screen
  10642. * @param y position on screen
  10643. * @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
  10644. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10645. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  10646. * @returns a PickingInfo
  10647. */
  10648. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  10649. /** Use the given ray to pick a sprite in the scene
  10650. * @param ray The ray (in world space) to use to pick meshes
  10651. * @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
  10652. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10653. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  10654. * @returns a PickingInfo
  10655. */
  10656. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  10657. /** @hidden */
  10658. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  10659. /** Launch a ray to try to pick sprites in the scene
  10660. * @param x position on screen
  10661. * @param y position on screen
  10662. * @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
  10663. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  10664. * @returns a PickingInfo array
  10665. */
  10666. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  10667. /** Use the given ray to pick sprites in the scene
  10668. * @param ray The ray (in world space) to use to pick meshes
  10669. * @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
  10670. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  10671. * @returns a PickingInfo array
  10672. */
  10673. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  10674. /**
  10675. * Force the sprite under the pointer
  10676. * @param sprite defines the sprite to use
  10677. */
  10678. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  10679. /**
  10680. * Gets the sprite under the pointer
  10681. * @returns a Sprite or null if no sprite is under the pointer
  10682. */
  10683. getPointerOverSprite(): Nullable<Sprite>;
  10684. }
  10685. /**
  10686. * Defines the sprite scene component responsible to manage sprites
  10687. * in a given scene.
  10688. */
  10689. export class SpriteSceneComponent implements ISceneComponent {
  10690. /**
  10691. * The component name helpfull to identify the component in the list of scene components.
  10692. */
  10693. readonly name: string;
  10694. /**
  10695. * The scene the component belongs to.
  10696. */
  10697. scene: Scene;
  10698. /** @hidden */
  10699. private _spritePredicate;
  10700. /**
  10701. * Creates a new instance of the component for the given scene
  10702. * @param scene Defines the scene to register the component in
  10703. */
  10704. constructor(scene: Scene);
  10705. /**
  10706. * Registers the component in a given scene
  10707. */
  10708. register(): void;
  10709. /**
  10710. * Rebuilds the elements related to this component in case of
  10711. * context lost for instance.
  10712. */
  10713. rebuild(): void;
  10714. /**
  10715. * Disposes the component and the associated ressources.
  10716. */
  10717. dispose(): void;
  10718. private _pickSpriteButKeepRay;
  10719. private _pointerMove;
  10720. private _pointerDown;
  10721. private _pointerUp;
  10722. }
  10723. }
  10724. declare module BABYLON {
  10725. /**
  10726. * Class used to provide helper for timing
  10727. */
  10728. export class TimingTools {
  10729. /**
  10730. * Polyfill for setImmediate
  10731. * @param action defines the action to execute after the current execution block
  10732. */
  10733. static SetImmediate(action: () => void): void;
  10734. }
  10735. }
  10736. declare module BABYLON {
  10737. /**
  10738. * Class used to enable instatition of objects by class name
  10739. */
  10740. export class InstantiationTools {
  10741. /**
  10742. * Use this object to register external classes like custom textures or material
  10743. * to allow the laoders to instantiate them
  10744. */
  10745. static RegisteredExternalClasses: {
  10746. [key: string]: Object;
  10747. };
  10748. /**
  10749. * Tries to instantiate a new object from a given class name
  10750. * @param className defines the class name to instantiate
  10751. * @returns the new object or null if the system was not able to do the instantiation
  10752. */
  10753. static Instantiate(className: string): any;
  10754. }
  10755. }
  10756. declare module BABYLON {
  10757. /**
  10758. * Class used to host copy specific utilities
  10759. */
  10760. export class CopyTools {
  10761. /**
  10762. * Reads the pixels stored in the webgl texture and returns them as a base64 string
  10763. * @param texture defines the texture to read pixels from
  10764. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  10765. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  10766. * @returns The base64 encoded string or null
  10767. */
  10768. static GenerateBase64StringFromTexture(texture: BaseTexture, faceIndex?: number, level?: number): Nullable<string>;
  10769. }
  10770. }
  10771. declare module BABYLON {
  10772. /**
  10773. * Define options used to create a depth texture
  10774. */
  10775. export class DepthTextureCreationOptions {
  10776. /** Specifies whether or not a stencil should be allocated in the texture */
  10777. generateStencil?: boolean;
  10778. /** Specifies whether or not bilinear filtering is enable on the texture */
  10779. bilinearFiltering?: boolean;
  10780. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  10781. comparisonFunction?: number;
  10782. /** Specifies if the created texture is a cube texture */
  10783. isCube?: boolean;
  10784. }
  10785. }
  10786. declare module BABYLON {
  10787. interface ThinEngine {
  10788. /**
  10789. * Creates a depth stencil cube texture.
  10790. * This is only available in WebGL 2.
  10791. * @param size The size of face edge in the cube texture.
  10792. * @param options The options defining the cube texture.
  10793. * @returns The cube texture
  10794. */
  10795. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  10796. /**
  10797. * Creates a cube texture
  10798. * @param rootUrl defines the url where the files to load is located
  10799. * @param scene defines the current scene
  10800. * @param files defines the list of files to load (1 per face)
  10801. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  10802. * @param onLoad defines an optional callback raised when the texture is loaded
  10803. * @param onError defines an optional callback raised if there is an issue to load the texture
  10804. * @param format defines the format of the data
  10805. * @param forcedExtension defines the extension to use to pick the right loader
  10806. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  10807. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  10808. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  10809. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  10810. * @param loaderOptions options to be passed to the loader
  10811. * @returns the cube texture as an InternalTexture
  10812. */
  10813. 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>, loaderOptions: any): InternalTexture;
  10814. /**
  10815. * Creates a cube texture
  10816. * @param rootUrl defines the url where the files to load is located
  10817. * @param scene defines the current scene
  10818. * @param files defines the list of files to load (1 per face)
  10819. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  10820. * @param onLoad defines an optional callback raised when the texture is loaded
  10821. * @param onError defines an optional callback raised if there is an issue to load the texture
  10822. * @param format defines the format of the data
  10823. * @param forcedExtension defines the extension to use to pick the right loader
  10824. * @returns the cube texture as an InternalTexture
  10825. */
  10826. 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;
  10827. /**
  10828. * Creates a cube texture
  10829. * @param rootUrl defines the url where the files to load is located
  10830. * @param scene defines the current scene
  10831. * @param files defines the list of files to load (1 per face)
  10832. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  10833. * @param onLoad defines an optional callback raised when the texture is loaded
  10834. * @param onError defines an optional callback raised if there is an issue to load the texture
  10835. * @param format defines the format of the data
  10836. * @param forcedExtension defines the extension to use to pick the right loader
  10837. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  10838. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  10839. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  10840. * @returns the cube texture as an InternalTexture
  10841. */
  10842. 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;
  10843. /** @hidden */
  10844. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  10845. /** @hidden */
  10846. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  10847. /** @hidden */
  10848. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  10849. /** @hidden */
  10850. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  10851. /**
  10852. * @hidden
  10853. */
  10854. _setCubeMapTextureParams(texture: InternalTexture, loadMipmap: boolean): void;
  10855. }
  10856. }
  10857. declare module BABYLON {
  10858. /**
  10859. * Class for creating a cube texture
  10860. */
  10861. export class CubeTexture extends BaseTexture {
  10862. private _delayedOnLoad;
  10863. /**
  10864. * Observable triggered once the texture has been loaded.
  10865. */
  10866. onLoadObservable: Observable<CubeTexture>;
  10867. /**
  10868. * The url of the texture
  10869. */
  10870. url: string;
  10871. /**
  10872. * Gets or sets the center of the bounding box associated with the cube texture.
  10873. * It must define where the camera used to render the texture was set
  10874. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  10875. */
  10876. boundingBoxPosition: Vector3;
  10877. private _boundingBoxSize;
  10878. /**
  10879. * Gets or sets the size of the bounding box associated with the cube texture
  10880. * When defined, the cubemap will switch to local mode
  10881. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  10882. * @example https://www.babylonjs-playground.com/#RNASML
  10883. */
  10884. set boundingBoxSize(value: Vector3);
  10885. /**
  10886. * Returns the bounding box size
  10887. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  10888. */
  10889. get boundingBoxSize(): Vector3;
  10890. protected _rotationY: number;
  10891. /**
  10892. * Sets texture matrix rotation angle around Y axis in radians.
  10893. */
  10894. set rotationY(value: number);
  10895. /**
  10896. * Gets texture matrix rotation angle around Y axis radians.
  10897. */
  10898. get rotationY(): number;
  10899. /**
  10900. * Are mip maps generated for this texture or not.
  10901. */
  10902. get noMipmap(): boolean;
  10903. private _noMipmap;
  10904. private _files;
  10905. protected _forcedExtension: Nullable<string>;
  10906. private _extensions;
  10907. private _textureMatrix;
  10908. private _format;
  10909. private _createPolynomials;
  10910. private _loaderOptions;
  10911. /**
  10912. * Creates a cube texture from an array of image urls
  10913. * @param files defines an array of image urls
  10914. * @param scene defines the hosting scene
  10915. * @param noMipmap specifies if mip maps are not used
  10916. * @returns a cube texture
  10917. */
  10918. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  10919. /**
  10920. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  10921. * @param url defines the url of the prefiltered texture
  10922. * @param scene defines the scene the texture is attached to
  10923. * @param forcedExtension defines the extension of the file if different from the url
  10924. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  10925. * @return the prefiltered texture
  10926. */
  10927. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  10928. /**
  10929. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  10930. * as prefiltered data.
  10931. * @param rootUrl defines the url of the texture or the root name of the six images
  10932. * @param null defines the scene or engine the texture is attached to
  10933. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  10934. * @param noMipmap defines if mipmaps should be created or not
  10935. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  10936. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  10937. * @param onError defines a callback triggered in case of error during load
  10938. * @param format defines the internal format to use for the texture once loaded
  10939. * @param prefiltered defines whether or not the texture is created from prefiltered data
  10940. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  10941. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  10942. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  10943. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  10944. * @param loaderOptions options to be passed to the loader
  10945. * @return the cube texture
  10946. */
  10947. constructor(rootUrl: string, sceneOrEngine: Scene | ThinEngine, extensions?: Nullable<string[]>, noMipmap?: boolean, files?: Nullable<string[]>, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, prefiltered?: boolean, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number, loaderOptions?: any);
  10948. /**
  10949. * Get the current class name of the texture useful for serialization or dynamic coding.
  10950. * @returns "CubeTexture"
  10951. */
  10952. getClassName(): string;
  10953. /**
  10954. * Update the url (and optional buffer) of this texture if url was null during construction.
  10955. * @param url the url of the texture
  10956. * @param forcedExtension defines the extension to use
  10957. * @param onLoad callback called when the texture is loaded (defaults to null)
  10958. * @param prefiltered Defines whether the updated texture is prefiltered or not
  10959. */
  10960. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  10961. /**
  10962. * Delays loading of the cube texture
  10963. * @param forcedExtension defines the extension to use
  10964. */
  10965. delayLoad(forcedExtension?: string): void;
  10966. /**
  10967. * Returns the reflection texture matrix
  10968. * @returns the reflection texture matrix
  10969. */
  10970. getReflectionTextureMatrix(): Matrix;
  10971. /**
  10972. * Sets the reflection texture matrix
  10973. * @param value Reflection texture matrix
  10974. */
  10975. setReflectionTextureMatrix(value: Matrix): void;
  10976. /**
  10977. * Parses text to create a cube texture
  10978. * @param parsedTexture define the serialized text to read from
  10979. * @param scene defines the hosting scene
  10980. * @param rootUrl defines the root url of the cube texture
  10981. * @returns a cube texture
  10982. */
  10983. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  10984. /**
  10985. * Makes a clone, or deep copy, of the cube texture
  10986. * @returns a new cube texture
  10987. */
  10988. clone(): CubeTexture;
  10989. }
  10990. }
  10991. declare module BABYLON {
  10992. /**
  10993. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  10994. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  10995. * 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;
  10996. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  10997. */
  10998. export class ColorCurves {
  10999. private _dirty;
  11000. private _tempColor;
  11001. private _globalCurve;
  11002. private _highlightsCurve;
  11003. private _midtonesCurve;
  11004. private _shadowsCurve;
  11005. private _positiveCurve;
  11006. private _negativeCurve;
  11007. private _globalHue;
  11008. private _globalDensity;
  11009. private _globalSaturation;
  11010. private _globalExposure;
  11011. /**
  11012. * Gets the global Hue value.
  11013. * 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).
  11014. */
  11015. get globalHue(): number;
  11016. /**
  11017. * Sets the global Hue value.
  11018. * 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).
  11019. */
  11020. set globalHue(value: number);
  11021. /**
  11022. * Gets the global Density value.
  11023. * 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.
  11024. * Values less than zero provide a filter of opposite hue.
  11025. */
  11026. get globalDensity(): number;
  11027. /**
  11028. * Sets the global Density value.
  11029. * 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.
  11030. * Values less than zero provide a filter of opposite hue.
  11031. */
  11032. set globalDensity(value: number);
  11033. /**
  11034. * Gets the global Saturation value.
  11035. * 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.
  11036. */
  11037. get globalSaturation(): number;
  11038. /**
  11039. * Sets the global Saturation value.
  11040. * 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.
  11041. */
  11042. set globalSaturation(value: number);
  11043. /**
  11044. * Gets the global Exposure value.
  11045. * 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.
  11046. */
  11047. get globalExposure(): number;
  11048. /**
  11049. * Sets the global Exposure value.
  11050. * 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.
  11051. */
  11052. set globalExposure(value: number);
  11053. private _highlightsHue;
  11054. private _highlightsDensity;
  11055. private _highlightsSaturation;
  11056. private _highlightsExposure;
  11057. /**
  11058. * Gets the highlights Hue value.
  11059. * 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).
  11060. */
  11061. get highlightsHue(): number;
  11062. /**
  11063. * Sets the highlights Hue value.
  11064. * 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).
  11065. */
  11066. set highlightsHue(value: number);
  11067. /**
  11068. * Gets the highlights Density value.
  11069. * 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.
  11070. * Values less than zero provide a filter of opposite hue.
  11071. */
  11072. get highlightsDensity(): number;
  11073. /**
  11074. * Sets the highlights Density value.
  11075. * 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.
  11076. * Values less than zero provide a filter of opposite hue.
  11077. */
  11078. set highlightsDensity(value: number);
  11079. /**
  11080. * Gets the highlights Saturation value.
  11081. * 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.
  11082. */
  11083. get highlightsSaturation(): number;
  11084. /**
  11085. * Sets the highlights Saturation value.
  11086. * 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.
  11087. */
  11088. set highlightsSaturation(value: number);
  11089. /**
  11090. * Gets the highlights Exposure value.
  11091. * 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.
  11092. */
  11093. get highlightsExposure(): number;
  11094. /**
  11095. * Sets the highlights Exposure value.
  11096. * 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.
  11097. */
  11098. set highlightsExposure(value: number);
  11099. private _midtonesHue;
  11100. private _midtonesDensity;
  11101. private _midtonesSaturation;
  11102. private _midtonesExposure;
  11103. /**
  11104. * Gets the midtones Hue value.
  11105. * 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).
  11106. */
  11107. get midtonesHue(): number;
  11108. /**
  11109. * Sets the midtones Hue value.
  11110. * 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).
  11111. */
  11112. set midtonesHue(value: number);
  11113. /**
  11114. * Gets the midtones Density value.
  11115. * 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.
  11116. * Values less than zero provide a filter of opposite hue.
  11117. */
  11118. get midtonesDensity(): number;
  11119. /**
  11120. * Sets the midtones Density value.
  11121. * 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.
  11122. * Values less than zero provide a filter of opposite hue.
  11123. */
  11124. set midtonesDensity(value: number);
  11125. /**
  11126. * Gets the midtones Saturation value.
  11127. * 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.
  11128. */
  11129. get midtonesSaturation(): number;
  11130. /**
  11131. * Sets the midtones Saturation value.
  11132. * 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.
  11133. */
  11134. set midtonesSaturation(value: number);
  11135. /**
  11136. * Gets the midtones Exposure value.
  11137. * 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.
  11138. */
  11139. get midtonesExposure(): number;
  11140. /**
  11141. * Sets the midtones Exposure value.
  11142. * 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.
  11143. */
  11144. set midtonesExposure(value: number);
  11145. private _shadowsHue;
  11146. private _shadowsDensity;
  11147. private _shadowsSaturation;
  11148. private _shadowsExposure;
  11149. /**
  11150. * Gets the shadows Hue value.
  11151. * 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).
  11152. */
  11153. get shadowsHue(): number;
  11154. /**
  11155. * Sets the shadows Hue value.
  11156. * 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).
  11157. */
  11158. set shadowsHue(value: number);
  11159. /**
  11160. * Gets the shadows Density value.
  11161. * 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.
  11162. * Values less than zero provide a filter of opposite hue.
  11163. */
  11164. get shadowsDensity(): number;
  11165. /**
  11166. * Sets the shadows Density value.
  11167. * 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.
  11168. * Values less than zero provide a filter of opposite hue.
  11169. */
  11170. set shadowsDensity(value: number);
  11171. /**
  11172. * Gets the shadows Saturation value.
  11173. * 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.
  11174. */
  11175. get shadowsSaturation(): number;
  11176. /**
  11177. * Sets the shadows Saturation value.
  11178. * 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.
  11179. */
  11180. set shadowsSaturation(value: number);
  11181. /**
  11182. * Gets the shadows Exposure value.
  11183. * 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.
  11184. */
  11185. get shadowsExposure(): number;
  11186. /**
  11187. * Sets the shadows Exposure value.
  11188. * 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.
  11189. */
  11190. set shadowsExposure(value: number);
  11191. /**
  11192. * Returns the class name
  11193. * @returns The class name
  11194. */
  11195. getClassName(): string;
  11196. /**
  11197. * Binds the color curves to the shader.
  11198. * @param colorCurves The color curve to bind
  11199. * @param effect The effect to bind to
  11200. * @param positiveUniform The positive uniform shader parameter
  11201. * @param neutralUniform The neutral uniform shader parameter
  11202. * @param negativeUniform The negative uniform shader parameter
  11203. */
  11204. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  11205. /**
  11206. * Prepare the list of uniforms associated with the ColorCurves effects.
  11207. * @param uniformsList The list of uniforms used in the effect
  11208. */
  11209. static PrepareUniforms(uniformsList: string[]): void;
  11210. /**
  11211. * Returns color grading data based on a hue, density, saturation and exposure value.
  11212. * @param filterHue The hue of the color filter.
  11213. * @param filterDensity The density of the color filter.
  11214. * @param saturation The saturation.
  11215. * @param exposure The exposure.
  11216. * @param result The result data container.
  11217. */
  11218. private getColorGradingDataToRef;
  11219. /**
  11220. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  11221. * @param value The input slider value in range [-100,100].
  11222. * @returns Adjusted value.
  11223. */
  11224. private static applyColorGradingSliderNonlinear;
  11225. /**
  11226. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  11227. * @param hue The hue (H) input.
  11228. * @param saturation The saturation (S) input.
  11229. * @param brightness The brightness (B) input.
  11230. * @result An RGBA color represented as Vector4.
  11231. */
  11232. private static fromHSBToRef;
  11233. /**
  11234. * Returns a value clamped between min and max
  11235. * @param value The value to clamp
  11236. * @param min The minimum of value
  11237. * @param max The maximum of value
  11238. * @returns The clamped value.
  11239. */
  11240. private static clamp;
  11241. /**
  11242. * Clones the current color curve instance.
  11243. * @return The cloned curves
  11244. */
  11245. clone(): ColorCurves;
  11246. /**
  11247. * Serializes the current color curve instance to a json representation.
  11248. * @return a JSON representation
  11249. */
  11250. serialize(): any;
  11251. /**
  11252. * Parses the color curve from a json representation.
  11253. * @param source the JSON source to parse
  11254. * @return The parsed curves
  11255. */
  11256. static Parse(source: any): ColorCurves;
  11257. }
  11258. }
  11259. declare module BABYLON {
  11260. /**
  11261. * Interface to follow in your material defines to integrate easily the
  11262. * Image proccessing functions.
  11263. * @hidden
  11264. */
  11265. export interface IImageProcessingConfigurationDefines {
  11266. IMAGEPROCESSING: boolean;
  11267. VIGNETTE: boolean;
  11268. VIGNETTEBLENDMODEMULTIPLY: boolean;
  11269. VIGNETTEBLENDMODEOPAQUE: boolean;
  11270. TONEMAPPING: boolean;
  11271. TONEMAPPING_ACES: boolean;
  11272. CONTRAST: boolean;
  11273. EXPOSURE: boolean;
  11274. COLORCURVES: boolean;
  11275. COLORGRADING: boolean;
  11276. COLORGRADING3D: boolean;
  11277. SAMPLER3DGREENDEPTH: boolean;
  11278. SAMPLER3DBGRMAP: boolean;
  11279. IMAGEPROCESSINGPOSTPROCESS: boolean;
  11280. }
  11281. /**
  11282. * @hidden
  11283. */
  11284. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  11285. IMAGEPROCESSING: boolean;
  11286. VIGNETTE: boolean;
  11287. VIGNETTEBLENDMODEMULTIPLY: boolean;
  11288. VIGNETTEBLENDMODEOPAQUE: boolean;
  11289. TONEMAPPING: boolean;
  11290. TONEMAPPING_ACES: boolean;
  11291. CONTRAST: boolean;
  11292. COLORCURVES: boolean;
  11293. COLORGRADING: boolean;
  11294. COLORGRADING3D: boolean;
  11295. SAMPLER3DGREENDEPTH: boolean;
  11296. SAMPLER3DBGRMAP: boolean;
  11297. IMAGEPROCESSINGPOSTPROCESS: boolean;
  11298. EXPOSURE: boolean;
  11299. constructor();
  11300. }
  11301. /**
  11302. * This groups together the common properties used for image processing either in direct forward pass
  11303. * or through post processing effect depending on the use of the image processing pipeline in your scene
  11304. * or not.
  11305. */
  11306. export class ImageProcessingConfiguration {
  11307. /**
  11308. * Default tone mapping applied in BabylonJS.
  11309. */
  11310. static readonly TONEMAPPING_STANDARD: number;
  11311. /**
  11312. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  11313. * to other engines rendering to increase portability.
  11314. */
  11315. static readonly TONEMAPPING_ACES: number;
  11316. /**
  11317. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  11318. */
  11319. colorCurves: Nullable<ColorCurves>;
  11320. private _colorCurvesEnabled;
  11321. /**
  11322. * Gets wether the color curves effect is enabled.
  11323. */
  11324. get colorCurvesEnabled(): boolean;
  11325. /**
  11326. * Sets wether the color curves effect is enabled.
  11327. */
  11328. set colorCurvesEnabled(value: boolean);
  11329. private _colorGradingTexture;
  11330. /**
  11331. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  11332. */
  11333. get colorGradingTexture(): Nullable<BaseTexture>;
  11334. /**
  11335. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  11336. */
  11337. set colorGradingTexture(value: Nullable<BaseTexture>);
  11338. private _colorGradingEnabled;
  11339. /**
  11340. * Gets wether the color grading effect is enabled.
  11341. */
  11342. get colorGradingEnabled(): boolean;
  11343. /**
  11344. * Sets wether the color grading effect is enabled.
  11345. */
  11346. set colorGradingEnabled(value: boolean);
  11347. private _colorGradingWithGreenDepth;
  11348. /**
  11349. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  11350. */
  11351. get colorGradingWithGreenDepth(): boolean;
  11352. /**
  11353. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  11354. */
  11355. set colorGradingWithGreenDepth(value: boolean);
  11356. private _colorGradingBGR;
  11357. /**
  11358. * Gets wether the color grading texture contains BGR values.
  11359. */
  11360. get colorGradingBGR(): boolean;
  11361. /**
  11362. * Sets wether the color grading texture contains BGR values.
  11363. */
  11364. set colorGradingBGR(value: boolean);
  11365. /** @hidden */
  11366. _exposure: number;
  11367. /**
  11368. * Gets the Exposure used in the effect.
  11369. */
  11370. get exposure(): number;
  11371. /**
  11372. * Sets the Exposure used in the effect.
  11373. */
  11374. set exposure(value: number);
  11375. private _toneMappingEnabled;
  11376. /**
  11377. * Gets wether the tone mapping effect is enabled.
  11378. */
  11379. get toneMappingEnabled(): boolean;
  11380. /**
  11381. * Sets wether the tone mapping effect is enabled.
  11382. */
  11383. set toneMappingEnabled(value: boolean);
  11384. private _toneMappingType;
  11385. /**
  11386. * Gets the type of tone mapping effect.
  11387. */
  11388. get toneMappingType(): number;
  11389. /**
  11390. * Sets the type of tone mapping effect used in BabylonJS.
  11391. */
  11392. set toneMappingType(value: number);
  11393. protected _contrast: number;
  11394. /**
  11395. * Gets the contrast used in the effect.
  11396. */
  11397. get contrast(): number;
  11398. /**
  11399. * Sets the contrast used in the effect.
  11400. */
  11401. set contrast(value: number);
  11402. /**
  11403. * Vignette stretch size.
  11404. */
  11405. vignetteStretch: number;
  11406. /**
  11407. * Vignette centre X Offset.
  11408. */
  11409. vignetteCentreX: number;
  11410. /**
  11411. * Vignette centre Y Offset.
  11412. */
  11413. vignetteCentreY: number;
  11414. /**
  11415. * Vignette weight or intensity of the vignette effect.
  11416. */
  11417. vignetteWeight: number;
  11418. /**
  11419. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  11420. * if vignetteEnabled is set to true.
  11421. */
  11422. vignetteColor: Color4;
  11423. /**
  11424. * Camera field of view used by the Vignette effect.
  11425. */
  11426. vignetteCameraFov: number;
  11427. private _vignetteBlendMode;
  11428. /**
  11429. * Gets the vignette blend mode allowing different kind of effect.
  11430. */
  11431. get vignetteBlendMode(): number;
  11432. /**
  11433. * Sets the vignette blend mode allowing different kind of effect.
  11434. */
  11435. set vignetteBlendMode(value: number);
  11436. private _vignetteEnabled;
  11437. /**
  11438. * Gets wether the vignette effect is enabled.
  11439. */
  11440. get vignetteEnabled(): boolean;
  11441. /**
  11442. * Sets wether the vignette effect is enabled.
  11443. */
  11444. set vignetteEnabled(value: boolean);
  11445. private _applyByPostProcess;
  11446. /**
  11447. * Gets wether the image processing is applied through a post process or not.
  11448. */
  11449. get applyByPostProcess(): boolean;
  11450. /**
  11451. * Sets wether the image processing is applied through a post process or not.
  11452. */
  11453. set applyByPostProcess(value: boolean);
  11454. private _isEnabled;
  11455. /**
  11456. * Gets wether the image processing is enabled or not.
  11457. */
  11458. get isEnabled(): boolean;
  11459. /**
  11460. * Sets wether the image processing is enabled or not.
  11461. */
  11462. set isEnabled(value: boolean);
  11463. /**
  11464. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  11465. */
  11466. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  11467. /**
  11468. * Method called each time the image processing information changes requires to recompile the effect.
  11469. */
  11470. protected _updateParameters(): void;
  11471. /**
  11472. * Gets the current class name.
  11473. * @return "ImageProcessingConfiguration"
  11474. */
  11475. getClassName(): string;
  11476. /**
  11477. * Prepare the list of uniforms associated with the Image Processing effects.
  11478. * @param uniforms The list of uniforms used in the effect
  11479. * @param defines the list of defines currently in use
  11480. */
  11481. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  11482. /**
  11483. * Prepare the list of samplers associated with the Image Processing effects.
  11484. * @param samplersList The list of uniforms used in the effect
  11485. * @param defines the list of defines currently in use
  11486. */
  11487. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  11488. /**
  11489. * Prepare the list of defines associated to the shader.
  11490. * @param defines the list of defines to complete
  11491. * @param forPostProcess Define if we are currently in post process mode or not
  11492. */
  11493. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  11494. /**
  11495. * Returns true if all the image processing information are ready.
  11496. * @returns True if ready, otherwise, false
  11497. */
  11498. isReady(): boolean;
  11499. /**
  11500. * Binds the image processing to the shader.
  11501. * @param effect The effect to bind to
  11502. * @param overrideAspectRatio Override the aspect ratio of the effect
  11503. */
  11504. bind(effect: Effect, overrideAspectRatio?: number): void;
  11505. /**
  11506. * Clones the current image processing instance.
  11507. * @return The cloned image processing
  11508. */
  11509. clone(): ImageProcessingConfiguration;
  11510. /**
  11511. * Serializes the current image processing instance to a json representation.
  11512. * @return a JSON representation
  11513. */
  11514. serialize(): any;
  11515. /**
  11516. * Parses the image processing from a json representation.
  11517. * @param source the JSON source to parse
  11518. * @return The parsed image processing
  11519. */
  11520. static Parse(source: any): ImageProcessingConfiguration;
  11521. private static _VIGNETTEMODE_MULTIPLY;
  11522. private static _VIGNETTEMODE_OPAQUE;
  11523. /**
  11524. * Used to apply the vignette as a mix with the pixel color.
  11525. */
  11526. static get VIGNETTEMODE_MULTIPLY(): number;
  11527. /**
  11528. * Used to apply the vignette as a replacement of the pixel color.
  11529. */
  11530. static get VIGNETTEMODE_OPAQUE(): number;
  11531. }
  11532. }
  11533. declare module BABYLON {
  11534. /** @hidden */
  11535. export var postprocessVertexShader: {
  11536. name: string;
  11537. shader: string;
  11538. };
  11539. }
  11540. declare module BABYLON {
  11541. /**
  11542. * Type used to define a render target texture size (either with a number or with a rect width and height)
  11543. */
  11544. export type RenderTargetTextureSize = number | {
  11545. width: number;
  11546. height: number;
  11547. layers?: number;
  11548. };
  11549. interface ThinEngine {
  11550. /**
  11551. * Creates a new render target texture
  11552. * @param size defines the size of the texture
  11553. * @param options defines the options used to create the texture
  11554. * @returns a new render target texture stored in an InternalTexture
  11555. */
  11556. createRenderTargetTexture(size: RenderTargetTextureSize, options: boolean | RenderTargetCreationOptions): InternalTexture;
  11557. /**
  11558. * Creates a depth stencil texture.
  11559. * This is only available in WebGL 2 or with the depth texture extension available.
  11560. * @param size The size of face edge in the texture.
  11561. * @param options The options defining the texture.
  11562. * @returns The texture
  11563. */
  11564. createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): InternalTexture;
  11565. /** @hidden */
  11566. _createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): InternalTexture;
  11567. }
  11568. }
  11569. declare module BABYLON {
  11570. /**
  11571. * Defines the kind of connection point for node based material
  11572. */
  11573. export enum NodeMaterialBlockConnectionPointTypes {
  11574. /** Float */
  11575. Float = 1,
  11576. /** Int */
  11577. Int = 2,
  11578. /** Vector2 */
  11579. Vector2 = 4,
  11580. /** Vector3 */
  11581. Vector3 = 8,
  11582. /** Vector4 */
  11583. Vector4 = 16,
  11584. /** Color3 */
  11585. Color3 = 32,
  11586. /** Color4 */
  11587. Color4 = 64,
  11588. /** Matrix */
  11589. Matrix = 128,
  11590. /** Custom object */
  11591. Object = 256,
  11592. /** Detect type based on connection */
  11593. AutoDetect = 1024,
  11594. /** Output type that will be defined by input type */
  11595. BasedOnInput = 2048
  11596. }
  11597. }
  11598. declare module BABYLON {
  11599. /**
  11600. * Enum used to define the target of a block
  11601. */
  11602. export enum NodeMaterialBlockTargets {
  11603. /** Vertex shader */
  11604. Vertex = 1,
  11605. /** Fragment shader */
  11606. Fragment = 2,
  11607. /** Neutral */
  11608. Neutral = 4,
  11609. /** Vertex and Fragment */
  11610. VertexAndFragment = 3
  11611. }
  11612. }
  11613. declare module BABYLON {
  11614. /**
  11615. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  11616. */
  11617. export enum NodeMaterialBlockConnectionPointMode {
  11618. /** Value is an uniform */
  11619. Uniform = 0,
  11620. /** Value is a mesh attribute */
  11621. Attribute = 1,
  11622. /** Value is a varying between vertex and fragment shaders */
  11623. Varying = 2,
  11624. /** Mode is undefined */
  11625. Undefined = 3
  11626. }
  11627. }
  11628. declare module BABYLON {
  11629. /**
  11630. * Enum used to define system values e.g. values automatically provided by the system
  11631. */
  11632. export enum NodeMaterialSystemValues {
  11633. /** World */
  11634. World = 1,
  11635. /** View */
  11636. View = 2,
  11637. /** Projection */
  11638. Projection = 3,
  11639. /** ViewProjection */
  11640. ViewProjection = 4,
  11641. /** WorldView */
  11642. WorldView = 5,
  11643. /** WorldViewProjection */
  11644. WorldViewProjection = 6,
  11645. /** CameraPosition */
  11646. CameraPosition = 7,
  11647. /** Fog Color */
  11648. FogColor = 8,
  11649. /** Delta time */
  11650. DeltaTime = 9
  11651. }
  11652. }
  11653. declare module BABYLON {
  11654. /**
  11655. * Represents a camera frustum
  11656. */
  11657. export class Frustum {
  11658. /**
  11659. * Gets the planes representing the frustum
  11660. * @param transform matrix to be applied to the returned planes
  11661. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  11662. */
  11663. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  11664. /**
  11665. * Gets the near frustum plane transformed by the transform matrix
  11666. * @param transform transformation matrix to be applied to the resulting frustum plane
  11667. * @param frustumPlane the resuling frustum plane
  11668. */
  11669. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  11670. /**
  11671. * Gets the far frustum plane transformed by the transform matrix
  11672. * @param transform transformation matrix to be applied to the resulting frustum plane
  11673. * @param frustumPlane the resuling frustum plane
  11674. */
  11675. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  11676. /**
  11677. * Gets the left frustum plane transformed by the transform matrix
  11678. * @param transform transformation matrix to be applied to the resulting frustum plane
  11679. * @param frustumPlane the resuling frustum plane
  11680. */
  11681. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  11682. /**
  11683. * Gets the right frustum plane transformed by the transform matrix
  11684. * @param transform transformation matrix to be applied to the resulting frustum plane
  11685. * @param frustumPlane the resuling frustum plane
  11686. */
  11687. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  11688. /**
  11689. * Gets the top frustum plane transformed by the transform matrix
  11690. * @param transform transformation matrix to be applied to the resulting frustum plane
  11691. * @param frustumPlane the resuling frustum plane
  11692. */
  11693. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  11694. /**
  11695. * Gets the bottom frustum plane transformed by the transform matrix
  11696. * @param transform transformation matrix to be applied to the resulting frustum plane
  11697. * @param frustumPlane the resuling frustum plane
  11698. */
  11699. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  11700. /**
  11701. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  11702. * @param transform transformation matrix to be applied to the resulting frustum planes
  11703. * @param frustumPlanes the resuling frustum planes
  11704. */
  11705. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  11706. }
  11707. }
  11708. declare module BABYLON {
  11709. /**
  11710. * Contains position and normal vectors for a vertex
  11711. */
  11712. export class PositionNormalVertex {
  11713. /** the position of the vertex (defaut: 0,0,0) */
  11714. position: Vector3;
  11715. /** the normal of the vertex (defaut: 0,1,0) */
  11716. normal: Vector3;
  11717. /**
  11718. * Creates a PositionNormalVertex
  11719. * @param position the position of the vertex (defaut: 0,0,0)
  11720. * @param normal the normal of the vertex (defaut: 0,1,0)
  11721. */
  11722. constructor(
  11723. /** the position of the vertex (defaut: 0,0,0) */
  11724. position?: Vector3,
  11725. /** the normal of the vertex (defaut: 0,1,0) */
  11726. normal?: Vector3);
  11727. /**
  11728. * Clones the PositionNormalVertex
  11729. * @returns the cloned PositionNormalVertex
  11730. */
  11731. clone(): PositionNormalVertex;
  11732. }
  11733. /**
  11734. * Contains position, normal and uv vectors for a vertex
  11735. */
  11736. export class PositionNormalTextureVertex {
  11737. /** the position of the vertex (defaut: 0,0,0) */
  11738. position: Vector3;
  11739. /** the normal of the vertex (defaut: 0,1,0) */
  11740. normal: Vector3;
  11741. /** the uv of the vertex (default: 0,0) */
  11742. uv: Vector2;
  11743. /**
  11744. * Creates a PositionNormalTextureVertex
  11745. * @param position the position of the vertex (defaut: 0,0,0)
  11746. * @param normal the normal of the vertex (defaut: 0,1,0)
  11747. * @param uv the uv of the vertex (default: 0,0)
  11748. */
  11749. constructor(
  11750. /** the position of the vertex (defaut: 0,0,0) */
  11751. position?: Vector3,
  11752. /** the normal of the vertex (defaut: 0,1,0) */
  11753. normal?: Vector3,
  11754. /** the uv of the vertex (default: 0,0) */
  11755. uv?: Vector2);
  11756. /**
  11757. * Clones the PositionNormalTextureVertex
  11758. * @returns the cloned PositionNormalTextureVertex
  11759. */
  11760. clone(): PositionNormalTextureVertex;
  11761. }
  11762. }
  11763. declare module BABYLON {
  11764. /**
  11765. * Enum defining the type of animations supported by InputBlock
  11766. */
  11767. export enum AnimatedInputBlockTypes {
  11768. /** No animation */
  11769. None = 0,
  11770. /** Time based animation. Will only work for floats */
  11771. Time = 1
  11772. }
  11773. }
  11774. declare module BABYLON {
  11775. /**
  11776. * Block used to expose an input value
  11777. */
  11778. export class InputBlock extends NodeMaterialBlock {
  11779. private _mode;
  11780. private _associatedVariableName;
  11781. private _storedValue;
  11782. private _valueCallback;
  11783. private _type;
  11784. private _animationType;
  11785. /** Gets or set a value used to limit the range of float values */
  11786. min: number;
  11787. /** Gets or set a value used to limit the range of float values */
  11788. max: number;
  11789. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  11790. isBoolean: boolean;
  11791. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  11792. matrixMode: number;
  11793. /** @hidden */
  11794. _systemValue: Nullable<NodeMaterialSystemValues>;
  11795. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  11796. isConstant: boolean;
  11797. /** Gets or sets the group to use to display this block in the Inspector */
  11798. groupInInspector: string;
  11799. /** Gets an observable raised when the value is changed */
  11800. onValueChangedObservable: Observable<InputBlock>;
  11801. /** Gets or sets a boolean indicating if content needs to be converted to gamma space (for color3/4 only) */
  11802. convertToGammaSpace: boolean;
  11803. /** Gets or sets a boolean indicating if content needs to be converted to linear space (for color3/4 only) */
  11804. convertToLinearSpace: boolean;
  11805. /**
  11806. * Gets or sets the connection point type (default is float)
  11807. */
  11808. get type(): NodeMaterialBlockConnectionPointTypes;
  11809. /**
  11810. * Creates a new InputBlock
  11811. * @param name defines the block name
  11812. * @param target defines the target of that block (Vertex by default)
  11813. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  11814. */
  11815. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  11816. /**
  11817. * Validates if a name is a reserve word.
  11818. * @param newName the new name to be given to the node.
  11819. * @returns false if the name is a reserve word, else true.
  11820. */
  11821. validateBlockName(newName: string): boolean;
  11822. /**
  11823. * Gets the output component
  11824. */
  11825. get output(): NodeMaterialConnectionPoint;
  11826. /**
  11827. * Set the source of this connection point to a vertex attribute
  11828. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  11829. * @returns the current connection point
  11830. */
  11831. setAsAttribute(attributeName?: string): InputBlock;
  11832. /**
  11833. * Set the source of this connection point to a system value
  11834. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  11835. * @returns the current connection point
  11836. */
  11837. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  11838. /**
  11839. * Gets or sets the value of that point.
  11840. * Please note that this value will be ignored if valueCallback is defined
  11841. */
  11842. get value(): any;
  11843. set value(value: any);
  11844. /**
  11845. * Gets or sets a callback used to get the value of that point.
  11846. * Please note that setting this value will force the connection point to ignore the value property
  11847. */
  11848. get valueCallback(): () => any;
  11849. set valueCallback(value: () => any);
  11850. /**
  11851. * Gets or sets the associated variable name in the shader
  11852. */
  11853. get associatedVariableName(): string;
  11854. set associatedVariableName(value: string);
  11855. /** Gets or sets the type of animation applied to the input */
  11856. get animationType(): AnimatedInputBlockTypes;
  11857. set animationType(value: AnimatedInputBlockTypes);
  11858. /**
  11859. * Gets a boolean indicating that this connection point not defined yet
  11860. */
  11861. get isUndefined(): boolean;
  11862. /**
  11863. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  11864. * In this case the connection point name must be the name of the uniform to use.
  11865. * Can only be set on inputs
  11866. */
  11867. get isUniform(): boolean;
  11868. set isUniform(value: boolean);
  11869. /**
  11870. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  11871. * In this case the connection point name must be the name of the attribute to use
  11872. * Can only be set on inputs
  11873. */
  11874. get isAttribute(): boolean;
  11875. set isAttribute(value: boolean);
  11876. /**
  11877. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  11878. * Can only be set on exit points
  11879. */
  11880. get isVarying(): boolean;
  11881. set isVarying(value: boolean);
  11882. /**
  11883. * Gets a boolean indicating that the current connection point is a system value
  11884. */
  11885. get isSystemValue(): boolean;
  11886. /**
  11887. * Gets or sets the current well known value or null if not defined as a system value
  11888. */
  11889. get systemValue(): Nullable<NodeMaterialSystemValues>;
  11890. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  11891. /**
  11892. * Gets the current class name
  11893. * @returns the class name
  11894. */
  11895. getClassName(): string;
  11896. /**
  11897. * Animate the input if animationType !== None
  11898. * @param scene defines the rendering scene
  11899. */
  11900. animate(scene: Scene): void;
  11901. private _emitDefine;
  11902. initialize(state: NodeMaterialBuildState): void;
  11903. /**
  11904. * Set the input block to its default value (based on its type)
  11905. */
  11906. setDefaultValue(): void;
  11907. private _emitConstant;
  11908. /** @hidden */
  11909. get _noContextSwitch(): boolean;
  11910. private _emit;
  11911. /** @hidden */
  11912. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  11913. /** @hidden */
  11914. _transmit(effect: Effect, scene: Scene): void;
  11915. protected _buildBlock(state: NodeMaterialBuildState): void;
  11916. protected _dumpPropertiesCode(): string;
  11917. dispose(): void;
  11918. serialize(): any;
  11919. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  11920. }
  11921. }
  11922. declare module BABYLON {
  11923. /**
  11924. * Enum used to define the compatibility state between two connection points
  11925. */
  11926. export enum NodeMaterialConnectionPointCompatibilityStates {
  11927. /** Points are compatibles */
  11928. Compatible = 0,
  11929. /** Points are incompatible because of their types */
  11930. TypeIncompatible = 1,
  11931. /** Points are incompatible because of their targets (vertex vs fragment) */
  11932. TargetIncompatible = 2
  11933. }
  11934. /**
  11935. * Defines the direction of a connection point
  11936. */
  11937. export enum NodeMaterialConnectionPointDirection {
  11938. /** Input */
  11939. Input = 0,
  11940. /** Output */
  11941. Output = 1
  11942. }
  11943. /**
  11944. * Defines a connection point for a block
  11945. */
  11946. export class NodeMaterialConnectionPoint {
  11947. /**
  11948. * Checks if two types are equivalent
  11949. * @param type1 type 1 to check
  11950. * @param type2 type 2 to check
  11951. * @returns true if both types are equivalent, else false
  11952. */
  11953. static AreEquivalentTypes(type1: number, type2: number): boolean;
  11954. /** @hidden */
  11955. _ownerBlock: NodeMaterialBlock;
  11956. /** @hidden */
  11957. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  11958. private _endpoints;
  11959. private _associatedVariableName;
  11960. private _direction;
  11961. /** @hidden */
  11962. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  11963. /** @hidden */
  11964. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  11965. /** @hidden */
  11966. _acceptedConnectionPointType: Nullable<NodeMaterialConnectionPoint>;
  11967. private _type;
  11968. /** @hidden */
  11969. _enforceAssociatedVariableName: boolean;
  11970. /** Gets the direction of the point */
  11971. get direction(): NodeMaterialConnectionPointDirection;
  11972. /** Indicates that this connection point needs dual validation before being connected to another point */
  11973. needDualDirectionValidation: boolean;
  11974. /**
  11975. * Gets or sets the additional types supported by this connection point
  11976. */
  11977. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  11978. /**
  11979. * Gets or sets the additional types excluded by this connection point
  11980. */
  11981. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  11982. /**
  11983. * Observable triggered when this point is connected
  11984. */
  11985. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  11986. /**
  11987. * Gets or sets the associated variable name in the shader
  11988. */
  11989. get associatedVariableName(): string;
  11990. set associatedVariableName(value: string);
  11991. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  11992. get innerType(): NodeMaterialBlockConnectionPointTypes;
  11993. /**
  11994. * Gets or sets the connection point type (default is float)
  11995. */
  11996. get type(): NodeMaterialBlockConnectionPointTypes;
  11997. set type(value: NodeMaterialBlockConnectionPointTypes);
  11998. /**
  11999. * Gets or sets the connection point name
  12000. */
  12001. name: string;
  12002. /**
  12003. * Gets or sets the connection point name
  12004. */
  12005. displayName: string;
  12006. /**
  12007. * Gets or sets a boolean indicating that this connection point can be omitted
  12008. */
  12009. isOptional: boolean;
  12010. /**
  12011. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  12012. */
  12013. isExposedOnFrame: boolean;
  12014. /**
  12015. * Gets or sets number indicating the position that the port is exposed to on a frame
  12016. */
  12017. exposedPortPosition: number;
  12018. /**
  12019. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  12020. */
  12021. define: string;
  12022. /** @hidden */
  12023. _prioritizeVertex: boolean;
  12024. private _target;
  12025. /** Gets or sets the target of that connection point */
  12026. get target(): NodeMaterialBlockTargets;
  12027. set target(value: NodeMaterialBlockTargets);
  12028. /**
  12029. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  12030. */
  12031. get isConnected(): boolean;
  12032. /**
  12033. * Gets a boolean indicating that the current point is connected to an input block
  12034. */
  12035. get isConnectedToInputBlock(): boolean;
  12036. /**
  12037. * Gets a the connected input block (if any)
  12038. */
  12039. get connectInputBlock(): Nullable<InputBlock>;
  12040. /** Get the other side of the connection (if any) */
  12041. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  12042. /** Get the block that owns this connection point */
  12043. get ownerBlock(): NodeMaterialBlock;
  12044. /** Get the block connected on the other side of this connection (if any) */
  12045. get sourceBlock(): Nullable<NodeMaterialBlock>;
  12046. /** Get the block connected on the endpoints of this connection (if any) */
  12047. get connectedBlocks(): Array<NodeMaterialBlock>;
  12048. /** Gets the list of connected endpoints */
  12049. get endpoints(): NodeMaterialConnectionPoint[];
  12050. /** Gets a boolean indicating if that output point is connected to at least one input */
  12051. get hasEndpoints(): boolean;
  12052. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  12053. get isConnectedInVertexShader(): boolean;
  12054. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  12055. get isConnectedInFragmentShader(): boolean;
  12056. /**
  12057. * Creates a block suitable to be used as an input for this input point.
  12058. * If null is returned, a block based on the point type will be created.
  12059. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  12060. */
  12061. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  12062. /**
  12063. * Creates a new connection point
  12064. * @param name defines the connection point name
  12065. * @param ownerBlock defines the block hosting this connection point
  12066. * @param direction defines the direction of the connection point
  12067. */
  12068. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  12069. /**
  12070. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  12071. * @returns the class name
  12072. */
  12073. getClassName(): string;
  12074. /**
  12075. * Gets a boolean indicating if the current point can be connected to another point
  12076. * @param connectionPoint defines the other connection point
  12077. * @returns a boolean
  12078. */
  12079. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  12080. /**
  12081. * Gets a number indicating if the current point can be connected to another point
  12082. * @param connectionPoint defines the other connection point
  12083. * @returns a number defining the compatibility state
  12084. */
  12085. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  12086. /**
  12087. * Connect this point to another connection point
  12088. * @param connectionPoint defines the other connection point
  12089. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  12090. * @returns the current connection point
  12091. */
  12092. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  12093. /**
  12094. * Disconnect this point from one of his endpoint
  12095. * @param endpoint defines the other connection point
  12096. * @returns the current connection point
  12097. */
  12098. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  12099. /**
  12100. * Serializes this point in a JSON representation
  12101. * @param isInput defines if the connection point is an input (default is true)
  12102. * @returns the serialized point object
  12103. */
  12104. serialize(isInput?: boolean): any;
  12105. /**
  12106. * Release resources
  12107. */
  12108. dispose(): void;
  12109. }
  12110. }
  12111. declare module BABYLON {
  12112. /**
  12113. * Enum used to define the material modes
  12114. */
  12115. export enum NodeMaterialModes {
  12116. /** Regular material */
  12117. Material = 0,
  12118. /** For post process */
  12119. PostProcess = 1,
  12120. /** For particle system */
  12121. Particle = 2,
  12122. /** For procedural texture */
  12123. ProceduralTexture = 3
  12124. }
  12125. }
  12126. declare module BABYLON {
  12127. /** @hidden */
  12128. export var helperFunctions: {
  12129. name: string;
  12130. shader: string;
  12131. };
  12132. }
  12133. declare module BABYLON {
  12134. /**
  12135. * Block used to read a texture from a sampler
  12136. */
  12137. export class TextureBlock extends NodeMaterialBlock {
  12138. private _defineName;
  12139. private _linearDefineName;
  12140. private _gammaDefineName;
  12141. private _tempTextureRead;
  12142. private _samplerName;
  12143. private _transformedUVName;
  12144. private _textureTransformName;
  12145. private _textureInfoName;
  12146. private _mainUVName;
  12147. private _mainUVDefineName;
  12148. private _fragmentOnly;
  12149. /**
  12150. * Gets or sets the texture associated with the node
  12151. */
  12152. texture: Nullable<Texture>;
  12153. /**
  12154. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  12155. */
  12156. convertToGammaSpace: boolean;
  12157. /**
  12158. * Gets or sets a boolean indicating if content needs to be converted to linear space
  12159. */
  12160. convertToLinearSpace: boolean;
  12161. /**
  12162. * Create a new TextureBlock
  12163. * @param name defines the block name
  12164. */
  12165. constructor(name: string, fragmentOnly?: boolean);
  12166. /**
  12167. * Gets the current class name
  12168. * @returns the class name
  12169. */
  12170. getClassName(): string;
  12171. /**
  12172. * Gets the uv input component
  12173. */
  12174. get uv(): NodeMaterialConnectionPoint;
  12175. /**
  12176. * Gets the rgba output component
  12177. */
  12178. get rgba(): NodeMaterialConnectionPoint;
  12179. /**
  12180. * Gets the rgb output component
  12181. */
  12182. get rgb(): NodeMaterialConnectionPoint;
  12183. /**
  12184. * Gets the r output component
  12185. */
  12186. get r(): NodeMaterialConnectionPoint;
  12187. /**
  12188. * Gets the g output component
  12189. */
  12190. get g(): NodeMaterialConnectionPoint;
  12191. /**
  12192. * Gets the b output component
  12193. */
  12194. get b(): NodeMaterialConnectionPoint;
  12195. /**
  12196. * Gets the a output component
  12197. */
  12198. get a(): NodeMaterialConnectionPoint;
  12199. get target(): NodeMaterialBlockTargets;
  12200. autoConfigure(material: NodeMaterial): void;
  12201. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  12202. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  12203. isReady(): boolean;
  12204. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  12205. private get _isMixed();
  12206. private _injectVertexCode;
  12207. private _writeTextureRead;
  12208. private _writeOutput;
  12209. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  12210. protected _dumpPropertiesCode(): string;
  12211. serialize(): any;
  12212. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  12213. }
  12214. }
  12215. declare module BABYLON {
  12216. /** @hidden */
  12217. export var reflectionFunction: {
  12218. name: string;
  12219. shader: string;
  12220. };
  12221. }
  12222. declare module BABYLON {
  12223. /**
  12224. * Base block used to read a reflection texture from a sampler
  12225. */
  12226. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  12227. /** @hidden */
  12228. _define3DName: string;
  12229. /** @hidden */
  12230. _defineCubicName: string;
  12231. /** @hidden */
  12232. _defineExplicitName: string;
  12233. /** @hidden */
  12234. _defineProjectionName: string;
  12235. /** @hidden */
  12236. _defineLocalCubicName: string;
  12237. /** @hidden */
  12238. _defineSphericalName: string;
  12239. /** @hidden */
  12240. _definePlanarName: string;
  12241. /** @hidden */
  12242. _defineEquirectangularName: string;
  12243. /** @hidden */
  12244. _defineMirroredEquirectangularFixedName: string;
  12245. /** @hidden */
  12246. _defineEquirectangularFixedName: string;
  12247. /** @hidden */
  12248. _defineSkyboxName: string;
  12249. /** @hidden */
  12250. _defineOppositeZ: string;
  12251. /** @hidden */
  12252. _cubeSamplerName: string;
  12253. /** @hidden */
  12254. _2DSamplerName: string;
  12255. protected _positionUVWName: string;
  12256. protected _directionWName: string;
  12257. protected _reflectionVectorName: string;
  12258. /** @hidden */
  12259. _reflectionCoordsName: string;
  12260. /** @hidden */
  12261. _reflectionMatrixName: string;
  12262. protected _reflectionColorName: string;
  12263. /**
  12264. * Gets or sets the texture associated with the node
  12265. */
  12266. texture: Nullable<BaseTexture>;
  12267. /**
  12268. * Create a new ReflectionTextureBaseBlock
  12269. * @param name defines the block name
  12270. */
  12271. constructor(name: string);
  12272. /**
  12273. * Gets the current class name
  12274. * @returns the class name
  12275. */
  12276. getClassName(): string;
  12277. /**
  12278. * Gets the world position input component
  12279. */
  12280. abstract get position(): NodeMaterialConnectionPoint;
  12281. /**
  12282. * Gets the world position input component
  12283. */
  12284. abstract get worldPosition(): NodeMaterialConnectionPoint;
  12285. /**
  12286. * Gets the world normal input component
  12287. */
  12288. abstract get worldNormal(): NodeMaterialConnectionPoint;
  12289. /**
  12290. * Gets the world input component
  12291. */
  12292. abstract get world(): NodeMaterialConnectionPoint;
  12293. /**
  12294. * Gets the camera (or eye) position component
  12295. */
  12296. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  12297. /**
  12298. * Gets the view input component
  12299. */
  12300. abstract get view(): NodeMaterialConnectionPoint;
  12301. protected _getTexture(): Nullable<BaseTexture>;
  12302. autoConfigure(material: NodeMaterial): void;
  12303. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  12304. isReady(): boolean;
  12305. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  12306. /**
  12307. * Gets the code to inject in the vertex shader
  12308. * @param state current state of the node material building
  12309. * @returns the shader code
  12310. */
  12311. handleVertexSide(state: NodeMaterialBuildState): string;
  12312. /**
  12313. * Handles the inits for the fragment code path
  12314. * @param state node material build state
  12315. */
  12316. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  12317. /**
  12318. * Generates the reflection coords code for the fragment code path
  12319. * @param worldNormalVarName name of the world normal variable
  12320. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  12321. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  12322. * @returns the shader code
  12323. */
  12324. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  12325. /**
  12326. * Generates the reflection color code for the fragment code path
  12327. * @param lodVarName name of the lod variable
  12328. * @param swizzleLookupTexture swizzle to use for the final color variable
  12329. * @returns the shader code
  12330. */
  12331. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  12332. /**
  12333. * Generates the code corresponding to the connected output points
  12334. * @param state node material build state
  12335. * @param varName name of the variable to output
  12336. * @returns the shader code
  12337. */
  12338. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  12339. protected _buildBlock(state: NodeMaterialBuildState): this;
  12340. protected _dumpPropertiesCode(): string;
  12341. serialize(): any;
  12342. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  12343. }
  12344. }
  12345. declare module BABYLON {
  12346. /**
  12347. * Defines a connection point to be used for points with a custom object type
  12348. */
  12349. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  12350. private _blockType;
  12351. private _blockName;
  12352. private _nameForCheking?;
  12353. /**
  12354. * Creates a new connection point
  12355. * @param name defines the connection point name
  12356. * @param ownerBlock defines the block hosting this connection point
  12357. * @param direction defines the direction of the connection point
  12358. */
  12359. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  12360. /**
  12361. * Gets a number indicating if the current point can be connected to another point
  12362. * @param connectionPoint defines the other connection point
  12363. * @returns a number defining the compatibility state
  12364. */
  12365. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  12366. /**
  12367. * Creates a block suitable to be used as an input for this input point.
  12368. * If null is returned, a block based on the point type will be created.
  12369. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  12370. */
  12371. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  12372. }
  12373. }
  12374. declare module BABYLON {
  12375. /**
  12376. * Enum defining the type of properties that can be edited in the property pages in the NME
  12377. */
  12378. export enum PropertyTypeForEdition {
  12379. /** property is a boolean */
  12380. Boolean = 0,
  12381. /** property is a float */
  12382. Float = 1,
  12383. /** property is a Vector2 */
  12384. Vector2 = 2,
  12385. /** property is a list of values */
  12386. List = 3
  12387. }
  12388. /**
  12389. * Interface that defines an option in a variable of type list
  12390. */
  12391. export interface IEditablePropertyListOption {
  12392. /** label of the option */
  12393. "label": string;
  12394. /** value of the option */
  12395. "value": number;
  12396. }
  12397. /**
  12398. * Interface that defines the options available for an editable property
  12399. */
  12400. export interface IEditablePropertyOption {
  12401. /** min value */
  12402. "min"?: number;
  12403. /** max value */
  12404. "max"?: number;
  12405. /** notifiers: indicates which actions to take when the property is changed */
  12406. "notifiers"?: {
  12407. /** the material should be rebuilt */
  12408. "rebuild"?: boolean;
  12409. /** the preview should be updated */
  12410. "update"?: boolean;
  12411. };
  12412. /** list of the options for a variable of type list */
  12413. "options"?: IEditablePropertyListOption[];
  12414. }
  12415. /**
  12416. * Interface that describes an editable property
  12417. */
  12418. export interface IPropertyDescriptionForEdition {
  12419. /** name of the property */
  12420. "propertyName": string;
  12421. /** display name of the property */
  12422. "displayName": string;
  12423. /** type of the property */
  12424. "type": PropertyTypeForEdition;
  12425. /** group of the property - all properties with the same group value will be displayed in a specific section */
  12426. "groupName": string;
  12427. /** options for the property */
  12428. "options": IEditablePropertyOption;
  12429. }
  12430. /**
  12431. * Decorator that flags a property in a node material block as being editable
  12432. */
  12433. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  12434. }
  12435. declare module BABYLON {
  12436. /**
  12437. * Block used to implement the refraction part of the sub surface module of the PBR material
  12438. */
  12439. export class RefractionBlock extends NodeMaterialBlock {
  12440. /** @hidden */
  12441. _define3DName: string;
  12442. /** @hidden */
  12443. _refractionMatrixName: string;
  12444. /** @hidden */
  12445. _defineLODRefractionAlpha: string;
  12446. /** @hidden */
  12447. _defineLinearSpecularRefraction: string;
  12448. /** @hidden */
  12449. _defineOppositeZ: string;
  12450. /** @hidden */
  12451. _cubeSamplerName: string;
  12452. /** @hidden */
  12453. _2DSamplerName: string;
  12454. /** @hidden */
  12455. _vRefractionMicrosurfaceInfosName: string;
  12456. /** @hidden */
  12457. _vRefractionInfosName: string;
  12458. private _scene;
  12459. /**
  12460. * The properties below are set by the main PBR block prior to calling methods of this class.
  12461. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  12462. * It's less burden on the user side in the editor part.
  12463. */
  12464. /** @hidden */
  12465. viewConnectionPoint: NodeMaterialConnectionPoint;
  12466. /** @hidden */
  12467. indexOfRefractionConnectionPoint: NodeMaterialConnectionPoint;
  12468. /**
  12469. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  12470. * Materials half opaque for instance using refraction could benefit from this control.
  12471. */
  12472. linkRefractionWithTransparency: boolean;
  12473. /**
  12474. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  12475. */
  12476. invertRefractionY: boolean;
  12477. /**
  12478. * Gets or sets the texture associated with the node
  12479. */
  12480. texture: Nullable<BaseTexture>;
  12481. /**
  12482. * Create a new RefractionBlock
  12483. * @param name defines the block name
  12484. */
  12485. constructor(name: string);
  12486. /**
  12487. * Gets the current class name
  12488. * @returns the class name
  12489. */
  12490. getClassName(): string;
  12491. /**
  12492. * Gets the intensity input component
  12493. */
  12494. get intensity(): NodeMaterialConnectionPoint;
  12495. /**
  12496. * Gets the tint at distance input component
  12497. */
  12498. get tintAtDistance(): NodeMaterialConnectionPoint;
  12499. /**
  12500. * Gets the view input component
  12501. */
  12502. get view(): NodeMaterialConnectionPoint;
  12503. /**
  12504. * Gets the refraction object output component
  12505. */
  12506. get refraction(): NodeMaterialConnectionPoint;
  12507. /**
  12508. * Returns true if the block has a texture
  12509. */
  12510. get hasTexture(): boolean;
  12511. protected _getTexture(): Nullable<BaseTexture>;
  12512. autoConfigure(material: NodeMaterial): void;
  12513. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  12514. isReady(): boolean;
  12515. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  12516. /**
  12517. * Gets the main code of the block (fragment side)
  12518. * @param state current state of the node material building
  12519. * @returns the shader code
  12520. */
  12521. getCode(state: NodeMaterialBuildState): string;
  12522. protected _buildBlock(state: NodeMaterialBuildState): this;
  12523. protected _dumpPropertiesCode(): string;
  12524. serialize(): any;
  12525. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  12526. }
  12527. }
  12528. declare module BABYLON {
  12529. /**
  12530. * Base block used as input for post process
  12531. */
  12532. export class CurrentScreenBlock extends NodeMaterialBlock {
  12533. private _samplerName;
  12534. private _linearDefineName;
  12535. private _gammaDefineName;
  12536. private _mainUVName;
  12537. private _tempTextureRead;
  12538. /**
  12539. * Gets or sets the texture associated with the node
  12540. */
  12541. texture: Nullable<BaseTexture>;
  12542. /**
  12543. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  12544. */
  12545. convertToGammaSpace: boolean;
  12546. /**
  12547. * Gets or sets a boolean indicating if content needs to be converted to linear space
  12548. */
  12549. convertToLinearSpace: boolean;
  12550. /**
  12551. * Create a new CurrentScreenBlock
  12552. * @param name defines the block name
  12553. */
  12554. constructor(name: string);
  12555. /**
  12556. * Gets the current class name
  12557. * @returns the class name
  12558. */
  12559. getClassName(): string;
  12560. /**
  12561. * Gets the uv input component
  12562. */
  12563. get uv(): NodeMaterialConnectionPoint;
  12564. /**
  12565. * Gets the rgba output component
  12566. */
  12567. get rgba(): NodeMaterialConnectionPoint;
  12568. /**
  12569. * Gets the rgb output component
  12570. */
  12571. get rgb(): NodeMaterialConnectionPoint;
  12572. /**
  12573. * Gets the r output component
  12574. */
  12575. get r(): NodeMaterialConnectionPoint;
  12576. /**
  12577. * Gets the g output component
  12578. */
  12579. get g(): NodeMaterialConnectionPoint;
  12580. /**
  12581. * Gets the b output component
  12582. */
  12583. get b(): NodeMaterialConnectionPoint;
  12584. /**
  12585. * Gets the a output component
  12586. */
  12587. get a(): NodeMaterialConnectionPoint;
  12588. /**
  12589. * Initialize the block and prepare the context for build
  12590. * @param state defines the state that will be used for the build
  12591. */
  12592. initialize(state: NodeMaterialBuildState): void;
  12593. get target(): NodeMaterialBlockTargets;
  12594. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  12595. isReady(): boolean;
  12596. private _injectVertexCode;
  12597. private _writeTextureRead;
  12598. private _writeOutput;
  12599. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  12600. serialize(): any;
  12601. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  12602. }
  12603. }
  12604. declare module BABYLON {
  12605. /**
  12606. * Base block used for the particle texture
  12607. */
  12608. export class ParticleTextureBlock extends NodeMaterialBlock {
  12609. private _samplerName;
  12610. private _linearDefineName;
  12611. private _gammaDefineName;
  12612. private _tempTextureRead;
  12613. /**
  12614. * Gets or sets the texture associated with the node
  12615. */
  12616. texture: Nullable<BaseTexture>;
  12617. /**
  12618. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  12619. */
  12620. convertToGammaSpace: boolean;
  12621. /**
  12622. * Gets or sets a boolean indicating if content needs to be converted to linear space
  12623. */
  12624. convertToLinearSpace: boolean;
  12625. /**
  12626. * Create a new ParticleTextureBlock
  12627. * @param name defines the block name
  12628. */
  12629. constructor(name: string);
  12630. /**
  12631. * Gets the current class name
  12632. * @returns the class name
  12633. */
  12634. getClassName(): string;
  12635. /**
  12636. * Gets the uv input component
  12637. */
  12638. get uv(): NodeMaterialConnectionPoint;
  12639. /**
  12640. * Gets the rgba output component
  12641. */
  12642. get rgba(): NodeMaterialConnectionPoint;
  12643. /**
  12644. * Gets the rgb output component
  12645. */
  12646. get rgb(): NodeMaterialConnectionPoint;
  12647. /**
  12648. * Gets the r output component
  12649. */
  12650. get r(): NodeMaterialConnectionPoint;
  12651. /**
  12652. * Gets the g output component
  12653. */
  12654. get g(): NodeMaterialConnectionPoint;
  12655. /**
  12656. * Gets the b output component
  12657. */
  12658. get b(): NodeMaterialConnectionPoint;
  12659. /**
  12660. * Gets the a output component
  12661. */
  12662. get a(): NodeMaterialConnectionPoint;
  12663. /**
  12664. * Initialize the block and prepare the context for build
  12665. * @param state defines the state that will be used for the build
  12666. */
  12667. initialize(state: NodeMaterialBuildState): void;
  12668. autoConfigure(material: NodeMaterial): void;
  12669. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  12670. isReady(): boolean;
  12671. private _writeOutput;
  12672. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  12673. serialize(): any;
  12674. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  12675. }
  12676. }
  12677. declare module BABYLON {
  12678. /**
  12679. * Class used to store shared data between 2 NodeMaterialBuildState
  12680. */
  12681. export class NodeMaterialBuildStateSharedData {
  12682. /**
  12683. * Gets the list of emitted varyings
  12684. */
  12685. temps: string[];
  12686. /**
  12687. * Gets the list of emitted varyings
  12688. */
  12689. varyings: string[];
  12690. /**
  12691. * Gets the varying declaration string
  12692. */
  12693. varyingDeclaration: string;
  12694. /**
  12695. * Input blocks
  12696. */
  12697. inputBlocks: InputBlock[];
  12698. /**
  12699. * Input blocks
  12700. */
  12701. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  12702. /**
  12703. * Bindable blocks (Blocks that need to set data to the effect)
  12704. */
  12705. bindableBlocks: NodeMaterialBlock[];
  12706. /**
  12707. * List of blocks that can provide a compilation fallback
  12708. */
  12709. blocksWithFallbacks: NodeMaterialBlock[];
  12710. /**
  12711. * List of blocks that can provide a define update
  12712. */
  12713. blocksWithDefines: NodeMaterialBlock[];
  12714. /**
  12715. * List of blocks that can provide a repeatable content
  12716. */
  12717. repeatableContentBlocks: NodeMaterialBlock[];
  12718. /**
  12719. * List of blocks that can provide a dynamic list of uniforms
  12720. */
  12721. dynamicUniformBlocks: NodeMaterialBlock[];
  12722. /**
  12723. * List of blocks that can block the isReady function for the material
  12724. */
  12725. blockingBlocks: NodeMaterialBlock[];
  12726. /**
  12727. * Gets the list of animated inputs
  12728. */
  12729. animatedInputs: InputBlock[];
  12730. /**
  12731. * Build Id used to avoid multiple recompilations
  12732. */
  12733. buildId: number;
  12734. /** List of emitted variables */
  12735. variableNames: {
  12736. [key: string]: number;
  12737. };
  12738. /** List of emitted defines */
  12739. defineNames: {
  12740. [key: string]: number;
  12741. };
  12742. /** Should emit comments? */
  12743. emitComments: boolean;
  12744. /** Emit build activity */
  12745. verbose: boolean;
  12746. /** Gets or sets the hosting scene */
  12747. scene: Scene;
  12748. /**
  12749. * Gets the compilation hints emitted at compilation time
  12750. */
  12751. hints: {
  12752. needWorldViewMatrix: boolean;
  12753. needWorldViewProjectionMatrix: boolean;
  12754. needAlphaBlending: boolean;
  12755. needAlphaTesting: boolean;
  12756. };
  12757. /**
  12758. * List of compilation checks
  12759. */
  12760. checks: {
  12761. emitVertex: boolean;
  12762. emitFragment: boolean;
  12763. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  12764. };
  12765. /**
  12766. * Is vertex program allowed to be empty?
  12767. */
  12768. allowEmptyVertexProgram: boolean;
  12769. /** Creates a new shared data */
  12770. constructor();
  12771. /**
  12772. * Emits console errors and exceptions if there is a failing check
  12773. */
  12774. emitErrors(): void;
  12775. }
  12776. }
  12777. declare module BABYLON {
  12778. /**
  12779. * Class used to store node based material build state
  12780. */
  12781. export class NodeMaterialBuildState {
  12782. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  12783. supportUniformBuffers: boolean;
  12784. /**
  12785. * Gets the list of emitted attributes
  12786. */
  12787. attributes: string[];
  12788. /**
  12789. * Gets the list of emitted uniforms
  12790. */
  12791. uniforms: string[];
  12792. /**
  12793. * Gets the list of emitted constants
  12794. */
  12795. constants: string[];
  12796. /**
  12797. * Gets the list of emitted samplers
  12798. */
  12799. samplers: string[];
  12800. /**
  12801. * Gets the list of emitted functions
  12802. */
  12803. functions: {
  12804. [key: string]: string;
  12805. };
  12806. /**
  12807. * Gets the list of emitted extensions
  12808. */
  12809. extensions: {
  12810. [key: string]: string;
  12811. };
  12812. /**
  12813. * Gets the target of the compilation state
  12814. */
  12815. target: NodeMaterialBlockTargets;
  12816. /**
  12817. * Gets the list of emitted counters
  12818. */
  12819. counters: {
  12820. [key: string]: number;
  12821. };
  12822. /**
  12823. * Shared data between multiple NodeMaterialBuildState instances
  12824. */
  12825. sharedData: NodeMaterialBuildStateSharedData;
  12826. /** @hidden */
  12827. _vertexState: NodeMaterialBuildState;
  12828. /** @hidden */
  12829. _attributeDeclaration: string;
  12830. /** @hidden */
  12831. _uniformDeclaration: string;
  12832. /** @hidden */
  12833. _constantDeclaration: string;
  12834. /** @hidden */
  12835. _samplerDeclaration: string;
  12836. /** @hidden */
  12837. _varyingTransfer: string;
  12838. /** @hidden */
  12839. _injectAtEnd: string;
  12840. private _repeatableContentAnchorIndex;
  12841. /** @hidden */
  12842. _builtCompilationString: string;
  12843. /**
  12844. * Gets the emitted compilation strings
  12845. */
  12846. compilationString: string;
  12847. /**
  12848. * Finalize the compilation strings
  12849. * @param state defines the current compilation state
  12850. */
  12851. finalize(state: NodeMaterialBuildState): void;
  12852. /** @hidden */
  12853. get _repeatableContentAnchor(): string;
  12854. /** @hidden */
  12855. _getFreeVariableName(prefix: string): string;
  12856. /** @hidden */
  12857. _getFreeDefineName(prefix: string): string;
  12858. /** @hidden */
  12859. _excludeVariableName(name: string): void;
  12860. /** @hidden */
  12861. _emit2DSampler(name: string): void;
  12862. /** @hidden */
  12863. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  12864. /** @hidden */
  12865. _emitExtension(name: string, extension: string, define?: string): void;
  12866. /** @hidden */
  12867. _emitFunction(name: string, code: string, comments: string): void;
  12868. /** @hidden */
  12869. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  12870. replaceStrings?: {
  12871. search: RegExp;
  12872. replace: string;
  12873. }[];
  12874. repeatKey?: string;
  12875. }): string;
  12876. /** @hidden */
  12877. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  12878. repeatKey?: string;
  12879. removeAttributes?: boolean;
  12880. removeUniforms?: boolean;
  12881. removeVaryings?: boolean;
  12882. removeIfDef?: boolean;
  12883. replaceStrings?: {
  12884. search: RegExp;
  12885. replace: string;
  12886. }[];
  12887. }, storeKey?: string): void;
  12888. /** @hidden */
  12889. _registerTempVariable(name: string): boolean;
  12890. /** @hidden */
  12891. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  12892. /** @hidden */
  12893. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  12894. /** @hidden */
  12895. _emitFloat(value: number): string;
  12896. }
  12897. }
  12898. declare module BABYLON {
  12899. /**
  12900. * Helper class used to generate session unique ID
  12901. */
  12902. export class UniqueIdGenerator {
  12903. private static _UniqueIdCounter;
  12904. /**
  12905. * Gets an unique (relatively to the current scene) Id
  12906. */
  12907. static get UniqueId(): number;
  12908. }
  12909. }
  12910. declare module BABYLON {
  12911. /**
  12912. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  12913. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  12914. */
  12915. export class EffectFallbacks implements IEffectFallbacks {
  12916. private _defines;
  12917. private _currentRank;
  12918. private _maxRank;
  12919. private _mesh;
  12920. /**
  12921. * Removes the fallback from the bound mesh.
  12922. */
  12923. unBindMesh(): void;
  12924. /**
  12925. * Adds a fallback on the specified property.
  12926. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  12927. * @param define The name of the define in the shader
  12928. */
  12929. addFallback(rank: number, define: string): void;
  12930. /**
  12931. * Sets the mesh to use CPU skinning when needing to fallback.
  12932. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  12933. * @param mesh The mesh to use the fallbacks.
  12934. */
  12935. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  12936. /**
  12937. * Checks to see if more fallbacks are still availible.
  12938. */
  12939. get hasMoreFallbacks(): boolean;
  12940. /**
  12941. * Removes the defines that should be removed when falling back.
  12942. * @param currentDefines defines the current define statements for the shader.
  12943. * @param effect defines the current effect we try to compile
  12944. * @returns The resulting defines with defines of the current rank removed.
  12945. */
  12946. reduce(currentDefines: string, effect: Effect): string;
  12947. }
  12948. }
  12949. declare module BABYLON {
  12950. /**
  12951. * Defines a block that can be used inside a node based material
  12952. */
  12953. export class NodeMaterialBlock {
  12954. private _buildId;
  12955. private _buildTarget;
  12956. private _target;
  12957. private _isFinalMerger;
  12958. private _isInput;
  12959. private _name;
  12960. protected _isUnique: boolean;
  12961. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  12962. inputsAreExclusive: boolean;
  12963. /** @hidden */
  12964. _codeVariableName: string;
  12965. /** @hidden */
  12966. _inputs: NodeMaterialConnectionPoint[];
  12967. /** @hidden */
  12968. _outputs: NodeMaterialConnectionPoint[];
  12969. /** @hidden */
  12970. _preparationId: number;
  12971. /**
  12972. * Gets the name of the block
  12973. */
  12974. get name(): string;
  12975. /**
  12976. * Sets the name of the block. Will check if the name is valid.
  12977. */
  12978. set name(newName: string);
  12979. /**
  12980. * Gets or sets the unique id of the node
  12981. */
  12982. uniqueId: number;
  12983. /**
  12984. * Gets or sets the comments associated with this block
  12985. */
  12986. comments: string;
  12987. /**
  12988. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  12989. */
  12990. get isUnique(): boolean;
  12991. /**
  12992. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  12993. */
  12994. get isFinalMerger(): boolean;
  12995. /**
  12996. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  12997. */
  12998. get isInput(): boolean;
  12999. /**
  13000. * Gets or sets the build Id
  13001. */
  13002. get buildId(): number;
  13003. set buildId(value: number);
  13004. /**
  13005. * Gets or sets the target of the block
  13006. */
  13007. get target(): NodeMaterialBlockTargets;
  13008. set target(value: NodeMaterialBlockTargets);
  13009. /**
  13010. * Gets the list of input points
  13011. */
  13012. get inputs(): NodeMaterialConnectionPoint[];
  13013. /** Gets the list of output points */
  13014. get outputs(): NodeMaterialConnectionPoint[];
  13015. /**
  13016. * Find an input by its name
  13017. * @param name defines the name of the input to look for
  13018. * @returns the input or null if not found
  13019. */
  13020. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  13021. /**
  13022. * Find an output by its name
  13023. * @param name defines the name of the outputto look for
  13024. * @returns the output or null if not found
  13025. */
  13026. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  13027. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  13028. visibleInInspector: boolean;
  13029. /**
  13030. * Creates a new NodeMaterialBlock
  13031. * @param name defines the block name
  13032. * @param target defines the target of that block (Vertex by default)
  13033. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  13034. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  13035. */
  13036. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  13037. /**
  13038. * Initialize the block and prepare the context for build
  13039. * @param state defines the state that will be used for the build
  13040. */
  13041. initialize(state: NodeMaterialBuildState): void;
  13042. /**
  13043. * Bind data to effect. Will only be called for blocks with isBindable === true
  13044. * @param effect defines the effect to bind data to
  13045. * @param nodeMaterial defines the hosting NodeMaterial
  13046. * @param mesh defines the mesh that will be rendered
  13047. * @param subMesh defines the submesh that will be rendered
  13048. */
  13049. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  13050. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  13051. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  13052. protected _writeFloat(value: number): string;
  13053. /**
  13054. * Gets the current class name e.g. "NodeMaterialBlock"
  13055. * @returns the class name
  13056. */
  13057. getClassName(): string;
  13058. /**
  13059. * Register a new input. Must be called inside a block constructor
  13060. * @param name defines the connection point name
  13061. * @param type defines the connection point type
  13062. * @param isOptional defines a boolean indicating that this input can be omitted
  13063. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  13064. * @param point an already created connection point. If not provided, create a new one
  13065. * @returns the current block
  13066. */
  13067. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  13068. /**
  13069. * Register a new output. Must be called inside a block constructor
  13070. * @param name defines the connection point name
  13071. * @param type defines the connection point type
  13072. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  13073. * @param point an already created connection point. If not provided, create a new one
  13074. * @returns the current block
  13075. */
  13076. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  13077. /**
  13078. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  13079. * @param forOutput defines an optional connection point to check compatibility with
  13080. * @returns the first available input or null
  13081. */
  13082. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  13083. /**
  13084. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  13085. * @param forBlock defines an optional block to check compatibility with
  13086. * @returns the first available input or null
  13087. */
  13088. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  13089. /**
  13090. * Gets the sibling of the given output
  13091. * @param current defines the current output
  13092. * @returns the next output in the list or null
  13093. */
  13094. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  13095. /**
  13096. * Connect current block with another block
  13097. * @param other defines the block to connect with
  13098. * @param options define the various options to help pick the right connections
  13099. * @returns the current block
  13100. */
  13101. connectTo(other: NodeMaterialBlock, options?: {
  13102. input?: string;
  13103. output?: string;
  13104. outputSwizzle?: string;
  13105. }): this | undefined;
  13106. protected _buildBlock(state: NodeMaterialBuildState): void;
  13107. /**
  13108. * Add uniforms, samplers and uniform buffers at compilation time
  13109. * @param state defines the state to update
  13110. * @param nodeMaterial defines the node material requesting the update
  13111. * @param defines defines the material defines to update
  13112. * @param uniformBuffers defines the list of uniform buffer names
  13113. */
  13114. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  13115. /**
  13116. * Add potential fallbacks if shader compilation fails
  13117. * @param mesh defines the mesh to be rendered
  13118. * @param fallbacks defines the current prioritized list of fallbacks
  13119. */
  13120. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  13121. /**
  13122. * Initialize defines for shader compilation
  13123. * @param mesh defines the mesh to be rendered
  13124. * @param nodeMaterial defines the node material requesting the update
  13125. * @param defines defines the material defines to update
  13126. * @param useInstances specifies that instances should be used
  13127. */
  13128. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  13129. /**
  13130. * Update defines for shader compilation
  13131. * @param mesh defines the mesh to be rendered
  13132. * @param nodeMaterial defines the node material requesting the update
  13133. * @param defines defines the material defines to update
  13134. * @param useInstances specifies that instances should be used
  13135. * @param subMesh defines which submesh to render
  13136. */
  13137. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  13138. /**
  13139. * Lets the block try to connect some inputs automatically
  13140. * @param material defines the hosting NodeMaterial
  13141. */
  13142. autoConfigure(material: NodeMaterial): void;
  13143. /**
  13144. * Function called when a block is declared as repeatable content generator
  13145. * @param vertexShaderState defines the current compilation state for the vertex shader
  13146. * @param fragmentShaderState defines the current compilation state for the fragment shader
  13147. * @param mesh defines the mesh to be rendered
  13148. * @param defines defines the material defines to update
  13149. */
  13150. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  13151. /**
  13152. * Checks if the block is ready
  13153. * @param mesh defines the mesh to be rendered
  13154. * @param nodeMaterial defines the node material requesting the update
  13155. * @param defines defines the material defines to update
  13156. * @param useInstances specifies that instances should be used
  13157. * @returns true if the block is ready
  13158. */
  13159. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  13160. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number, looseCoupling?: boolean): void;
  13161. private _processBuild;
  13162. /**
  13163. * Validates the new name for the block node.
  13164. * @param newName the new name to be given to the node.
  13165. * @returns false if the name is a reserve word, else true.
  13166. */
  13167. validateBlockName(newName: string): boolean;
  13168. /**
  13169. * Compile the current node and generate the shader code
  13170. * @param state defines the current compilation state (uniforms, samplers, current string)
  13171. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  13172. * @returns true if already built
  13173. */
  13174. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  13175. protected _inputRename(name: string): string;
  13176. protected _outputRename(name: string): string;
  13177. protected _dumpPropertiesCode(): string;
  13178. /** @hidden */
  13179. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  13180. /** @hidden */
  13181. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  13182. /**
  13183. * Clone the current block to a new identical block
  13184. * @param scene defines the hosting scene
  13185. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  13186. * @returns a copy of the current block
  13187. */
  13188. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  13189. /**
  13190. * Serializes this block in a JSON representation
  13191. * @returns the serialized block object
  13192. */
  13193. serialize(): any;
  13194. /** @hidden */
  13195. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  13196. private _deserializePortDisplayNamesAndExposedOnFrame;
  13197. /**
  13198. * Release resources
  13199. */
  13200. dispose(): void;
  13201. }
  13202. }
  13203. declare module BABYLON {
  13204. /**
  13205. * Base class of materials working in push mode in babylon JS
  13206. * @hidden
  13207. */
  13208. export class PushMaterial extends Material {
  13209. protected _activeEffect: Effect;
  13210. protected _normalMatrix: Matrix;
  13211. constructor(name: string, scene: Scene);
  13212. getEffect(): Effect;
  13213. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  13214. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  13215. /**
  13216. * Binds the given world matrix to the active effect
  13217. *
  13218. * @param world the matrix to bind
  13219. */
  13220. bindOnlyWorldMatrix(world: Matrix): void;
  13221. /**
  13222. * Binds the given normal matrix to the active effect
  13223. *
  13224. * @param normalMatrix the matrix to bind
  13225. */
  13226. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  13227. bind(world: Matrix, mesh?: Mesh): void;
  13228. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  13229. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  13230. }
  13231. }
  13232. declare module BABYLON {
  13233. /**
  13234. * Root class for all node material optimizers
  13235. */
  13236. export class NodeMaterialOptimizer {
  13237. /**
  13238. * Function used to optimize a NodeMaterial graph
  13239. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  13240. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  13241. */
  13242. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  13243. }
  13244. }
  13245. declare module BABYLON {
  13246. /**
  13247. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  13248. */
  13249. export class TransformBlock extends NodeMaterialBlock {
  13250. /**
  13251. * Defines the value to use to complement W value to transform it to a Vector4
  13252. */
  13253. complementW: number;
  13254. /**
  13255. * Defines the value to use to complement z value to transform it to a Vector4
  13256. */
  13257. complementZ: number;
  13258. /**
  13259. * Creates a new TransformBlock
  13260. * @param name defines the block name
  13261. */
  13262. constructor(name: string);
  13263. /**
  13264. * Gets the current class name
  13265. * @returns the class name
  13266. */
  13267. getClassName(): string;
  13268. /**
  13269. * Gets the vector input
  13270. */
  13271. get vector(): NodeMaterialConnectionPoint;
  13272. /**
  13273. * Gets the output component
  13274. */
  13275. get output(): NodeMaterialConnectionPoint;
  13276. /**
  13277. * Gets the xyz output component
  13278. */
  13279. get xyz(): NodeMaterialConnectionPoint;
  13280. /**
  13281. * Gets the matrix transform input
  13282. */
  13283. get transform(): NodeMaterialConnectionPoint;
  13284. protected _buildBlock(state: NodeMaterialBuildState): this;
  13285. /**
  13286. * Update defines for shader compilation
  13287. * @param mesh defines the mesh to be rendered
  13288. * @param nodeMaterial defines the node material requesting the update
  13289. * @param defines defines the material defines to update
  13290. * @param useInstances specifies that instances should be used
  13291. * @param subMesh defines which submesh to render
  13292. */
  13293. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  13294. serialize(): any;
  13295. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  13296. protected _dumpPropertiesCode(): string;
  13297. }
  13298. }
  13299. declare module BABYLON {
  13300. /**
  13301. * Block used to output the vertex position
  13302. */
  13303. export class VertexOutputBlock extends NodeMaterialBlock {
  13304. /**
  13305. * Creates a new VertexOutputBlock
  13306. * @param name defines the block name
  13307. */
  13308. constructor(name: string);
  13309. /**
  13310. * Gets the current class name
  13311. * @returns the class name
  13312. */
  13313. getClassName(): string;
  13314. /**
  13315. * Gets the vector input component
  13316. */
  13317. get vector(): NodeMaterialConnectionPoint;
  13318. protected _buildBlock(state: NodeMaterialBuildState): this;
  13319. }
  13320. }
  13321. declare module BABYLON {
  13322. /**
  13323. * Block used to output the final color
  13324. */
  13325. export class FragmentOutputBlock extends NodeMaterialBlock {
  13326. /**
  13327. * Create a new FragmentOutputBlock
  13328. * @param name defines the block name
  13329. */
  13330. constructor(name: string);
  13331. /**
  13332. * Gets the current class name
  13333. * @returns the class name
  13334. */
  13335. getClassName(): string;
  13336. /**
  13337. * Gets the rgba input component
  13338. */
  13339. get rgba(): NodeMaterialConnectionPoint;
  13340. /**
  13341. * Gets the rgb input component
  13342. */
  13343. get rgb(): NodeMaterialConnectionPoint;
  13344. /**
  13345. * Gets the a input component
  13346. */
  13347. get a(): NodeMaterialConnectionPoint;
  13348. protected _buildBlock(state: NodeMaterialBuildState): this;
  13349. }
  13350. }
  13351. declare module BABYLON {
  13352. /**
  13353. * Block used for the particle ramp gradient section
  13354. */
  13355. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  13356. /**
  13357. * Create a new ParticleRampGradientBlock
  13358. * @param name defines the block name
  13359. */
  13360. constructor(name: string);
  13361. /**
  13362. * Gets the current class name
  13363. * @returns the class name
  13364. */
  13365. getClassName(): string;
  13366. /**
  13367. * Gets the color input component
  13368. */
  13369. get color(): NodeMaterialConnectionPoint;
  13370. /**
  13371. * Gets the rampColor output component
  13372. */
  13373. get rampColor(): NodeMaterialConnectionPoint;
  13374. /**
  13375. * Initialize the block and prepare the context for build
  13376. * @param state defines the state that will be used for the build
  13377. */
  13378. initialize(state: NodeMaterialBuildState): void;
  13379. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  13380. }
  13381. }
  13382. declare module BABYLON {
  13383. /**
  13384. * Block used for the particle blend multiply section
  13385. */
  13386. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  13387. /**
  13388. * Create a new ParticleBlendMultiplyBlock
  13389. * @param name defines the block name
  13390. */
  13391. constructor(name: string);
  13392. /**
  13393. * Gets the current class name
  13394. * @returns the class name
  13395. */
  13396. getClassName(): string;
  13397. /**
  13398. * Gets the color input component
  13399. */
  13400. get color(): NodeMaterialConnectionPoint;
  13401. /**
  13402. * Gets the alphaTexture input component
  13403. */
  13404. get alphaTexture(): NodeMaterialConnectionPoint;
  13405. /**
  13406. * Gets the alphaColor input component
  13407. */
  13408. get alphaColor(): NodeMaterialConnectionPoint;
  13409. /**
  13410. * Gets the blendColor output component
  13411. */
  13412. get blendColor(): NodeMaterialConnectionPoint;
  13413. /**
  13414. * Initialize the block and prepare the context for build
  13415. * @param state defines the state that will be used for the build
  13416. */
  13417. initialize(state: NodeMaterialBuildState): void;
  13418. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  13419. }
  13420. }
  13421. declare module BABYLON {
  13422. /**
  13423. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  13424. */
  13425. export class VectorMergerBlock extends NodeMaterialBlock {
  13426. /**
  13427. * Create a new VectorMergerBlock
  13428. * @param name defines the block name
  13429. */
  13430. constructor(name: string);
  13431. /**
  13432. * Gets the current class name
  13433. * @returns the class name
  13434. */
  13435. getClassName(): string;
  13436. /**
  13437. * Gets the xyz component (input)
  13438. */
  13439. get xyzIn(): NodeMaterialConnectionPoint;
  13440. /**
  13441. * Gets the xy component (input)
  13442. */
  13443. get xyIn(): NodeMaterialConnectionPoint;
  13444. /**
  13445. * Gets the x component (input)
  13446. */
  13447. get x(): NodeMaterialConnectionPoint;
  13448. /**
  13449. * Gets the y component (input)
  13450. */
  13451. get y(): NodeMaterialConnectionPoint;
  13452. /**
  13453. * Gets the z component (input)
  13454. */
  13455. get z(): NodeMaterialConnectionPoint;
  13456. /**
  13457. * Gets the w component (input)
  13458. */
  13459. get w(): NodeMaterialConnectionPoint;
  13460. /**
  13461. * Gets the xyzw component (output)
  13462. */
  13463. get xyzw(): NodeMaterialConnectionPoint;
  13464. /**
  13465. * Gets the xyz component (output)
  13466. */
  13467. get xyzOut(): NodeMaterialConnectionPoint;
  13468. /**
  13469. * Gets the xy component (output)
  13470. */
  13471. get xyOut(): NodeMaterialConnectionPoint;
  13472. /**
  13473. * Gets the xy component (output)
  13474. * @deprecated Please use xyOut instead.
  13475. */
  13476. get xy(): NodeMaterialConnectionPoint;
  13477. /**
  13478. * Gets the xyz component (output)
  13479. * @deprecated Please use xyzOut instead.
  13480. */
  13481. get xyz(): NodeMaterialConnectionPoint;
  13482. protected _buildBlock(state: NodeMaterialBuildState): this;
  13483. }
  13484. }
  13485. declare module BABYLON {
  13486. /**
  13487. * Block used to remap a float from a range to a new one
  13488. */
  13489. export class RemapBlock extends NodeMaterialBlock {
  13490. /**
  13491. * Gets or sets the source range
  13492. */
  13493. sourceRange: Vector2;
  13494. /**
  13495. * Gets or sets the target range
  13496. */
  13497. targetRange: Vector2;
  13498. /**
  13499. * Creates a new RemapBlock
  13500. * @param name defines the block name
  13501. */
  13502. constructor(name: string);
  13503. /**
  13504. * Gets the current class name
  13505. * @returns the class name
  13506. */
  13507. getClassName(): string;
  13508. /**
  13509. * Gets the input component
  13510. */
  13511. get input(): NodeMaterialConnectionPoint;
  13512. /**
  13513. * Gets the source min input component
  13514. */
  13515. get sourceMin(): NodeMaterialConnectionPoint;
  13516. /**
  13517. * Gets the source max input component
  13518. */
  13519. get sourceMax(): NodeMaterialConnectionPoint;
  13520. /**
  13521. * Gets the target min input component
  13522. */
  13523. get targetMin(): NodeMaterialConnectionPoint;
  13524. /**
  13525. * Gets the target max input component
  13526. */
  13527. get targetMax(): NodeMaterialConnectionPoint;
  13528. /**
  13529. * Gets the output component
  13530. */
  13531. get output(): NodeMaterialConnectionPoint;
  13532. protected _buildBlock(state: NodeMaterialBuildState): this;
  13533. protected _dumpPropertiesCode(): string;
  13534. serialize(): any;
  13535. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  13536. }
  13537. }
  13538. declare module BABYLON {
  13539. /**
  13540. * Block used to multiply 2 values
  13541. */
  13542. export class MultiplyBlock extends NodeMaterialBlock {
  13543. /**
  13544. * Creates a new MultiplyBlock
  13545. * @param name defines the block name
  13546. */
  13547. constructor(name: string);
  13548. /**
  13549. * Gets the current class name
  13550. * @returns the class name
  13551. */
  13552. getClassName(): string;
  13553. /**
  13554. * Gets the left operand input component
  13555. */
  13556. get left(): NodeMaterialConnectionPoint;
  13557. /**
  13558. * Gets the right operand input component
  13559. */
  13560. get right(): NodeMaterialConnectionPoint;
  13561. /**
  13562. * Gets the output component
  13563. */
  13564. get output(): NodeMaterialConnectionPoint;
  13565. protected _buildBlock(state: NodeMaterialBuildState): this;
  13566. }
  13567. }
  13568. declare module BABYLON {
  13569. /** Interface used by value gradients (color, factor, ...) */
  13570. export interface IValueGradient {
  13571. /**
  13572. * Gets or sets the gradient value (between 0 and 1)
  13573. */
  13574. gradient: number;
  13575. }
  13576. /** Class used to store color4 gradient */
  13577. export class ColorGradient implements IValueGradient {
  13578. /**
  13579. * Gets or sets the gradient value (between 0 and 1)
  13580. */
  13581. gradient: number;
  13582. /**
  13583. * Gets or sets first associated color
  13584. */
  13585. color1: Color4;
  13586. /**
  13587. * Gets or sets second associated color
  13588. */
  13589. color2?: Color4 | undefined;
  13590. /**
  13591. * Creates a new color4 gradient
  13592. * @param gradient gets or sets the gradient value (between 0 and 1)
  13593. * @param color1 gets or sets first associated color
  13594. * @param color2 gets or sets first second color
  13595. */
  13596. constructor(
  13597. /**
  13598. * Gets or sets the gradient value (between 0 and 1)
  13599. */
  13600. gradient: number,
  13601. /**
  13602. * Gets or sets first associated color
  13603. */
  13604. color1: Color4,
  13605. /**
  13606. * Gets or sets second associated color
  13607. */
  13608. color2?: Color4 | undefined);
  13609. /**
  13610. * Will get a color picked randomly between color1 and color2.
  13611. * If color2 is undefined then color1 will be used
  13612. * @param result defines the target Color4 to store the result in
  13613. */
  13614. getColorToRef(result: Color4): void;
  13615. }
  13616. /** Class used to store color 3 gradient */
  13617. export class Color3Gradient implements IValueGradient {
  13618. /**
  13619. * Gets or sets the gradient value (between 0 and 1)
  13620. */
  13621. gradient: number;
  13622. /**
  13623. * Gets or sets the associated color
  13624. */
  13625. color: Color3;
  13626. /**
  13627. * Creates a new color3 gradient
  13628. * @param gradient gets or sets the gradient value (between 0 and 1)
  13629. * @param color gets or sets associated color
  13630. */
  13631. constructor(
  13632. /**
  13633. * Gets or sets the gradient value (between 0 and 1)
  13634. */
  13635. gradient: number,
  13636. /**
  13637. * Gets or sets the associated color
  13638. */
  13639. color: Color3);
  13640. }
  13641. /** Class used to store factor gradient */
  13642. export class FactorGradient implements IValueGradient {
  13643. /**
  13644. * Gets or sets the gradient value (between 0 and 1)
  13645. */
  13646. gradient: number;
  13647. /**
  13648. * Gets or sets first associated factor
  13649. */
  13650. factor1: number;
  13651. /**
  13652. * Gets or sets second associated factor
  13653. */
  13654. factor2?: number | undefined;
  13655. /**
  13656. * Creates a new factor gradient
  13657. * @param gradient gets or sets the gradient value (between 0 and 1)
  13658. * @param factor1 gets or sets first associated factor
  13659. * @param factor2 gets or sets second associated factor
  13660. */
  13661. constructor(
  13662. /**
  13663. * Gets or sets the gradient value (between 0 and 1)
  13664. */
  13665. gradient: number,
  13666. /**
  13667. * Gets or sets first associated factor
  13668. */
  13669. factor1: number,
  13670. /**
  13671. * Gets or sets second associated factor
  13672. */
  13673. factor2?: number | undefined);
  13674. /**
  13675. * Will get a number picked randomly between factor1 and factor2.
  13676. * If factor2 is undefined then factor1 will be used
  13677. * @returns the picked number
  13678. */
  13679. getFactor(): number;
  13680. }
  13681. /**
  13682. * Helper used to simplify some generic gradient tasks
  13683. */
  13684. export class GradientHelper {
  13685. /**
  13686. * Gets the current gradient from an array of IValueGradient
  13687. * @param ratio defines the current ratio to get
  13688. * @param gradients defines the array of IValueGradient
  13689. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  13690. */
  13691. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  13692. }
  13693. }
  13694. declare module BABYLON {
  13695. interface ThinEngine {
  13696. /**
  13697. * Creates a raw texture
  13698. * @param data defines the data to store in the texture
  13699. * @param width defines the width of the texture
  13700. * @param height defines the height of the texture
  13701. * @param format defines the format of the data
  13702. * @param generateMipMaps defines if the engine should generate the mip levels
  13703. * @param invertY defines if data must be stored with Y axis inverted
  13704. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  13705. * @param compression defines the compression used (null by default)
  13706. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  13707. * @returns the raw texture inside an InternalTexture
  13708. */
  13709. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  13710. /**
  13711. * Update a raw texture
  13712. * @param texture defines the texture to update
  13713. * @param data defines the data to store in the texture
  13714. * @param format defines the format of the data
  13715. * @param invertY defines if data must be stored with Y axis inverted
  13716. */
  13717. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  13718. /**
  13719. * Update a raw texture
  13720. * @param texture defines the texture to update
  13721. * @param data defines the data to store in the texture
  13722. * @param format defines the format of the data
  13723. * @param invertY defines if data must be stored with Y axis inverted
  13724. * @param compression defines the compression used (null by default)
  13725. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  13726. */
  13727. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  13728. /**
  13729. * Creates a new raw cube texture
  13730. * @param data defines the array of data to use to create each face
  13731. * @param size defines the size of the textures
  13732. * @param format defines the format of the data
  13733. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  13734. * @param generateMipMaps defines if the engine should generate the mip levels
  13735. * @param invertY defines if data must be stored with Y axis inverted
  13736. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  13737. * @param compression defines the compression used (null by default)
  13738. * @returns the cube texture as an InternalTexture
  13739. */
  13740. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  13741. /**
  13742. * Update a raw cube texture
  13743. * @param texture defines the texture to udpdate
  13744. * @param data defines the data to store
  13745. * @param format defines the data format
  13746. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  13747. * @param invertY defines if data must be stored with Y axis inverted
  13748. */
  13749. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  13750. /**
  13751. * Update a raw cube texture
  13752. * @param texture defines the texture to udpdate
  13753. * @param data defines the data to store
  13754. * @param format defines the data format
  13755. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  13756. * @param invertY defines if data must be stored with Y axis inverted
  13757. * @param compression defines the compression used (null by default)
  13758. */
  13759. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  13760. /**
  13761. * Update a raw cube texture
  13762. * @param texture defines the texture to udpdate
  13763. * @param data defines the data to store
  13764. * @param format defines the data format
  13765. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  13766. * @param invertY defines if data must be stored with Y axis inverted
  13767. * @param compression defines the compression used (null by default)
  13768. * @param level defines which level of the texture to update
  13769. */
  13770. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  13771. /**
  13772. * Creates a new raw cube texture from a specified url
  13773. * @param url defines the url where the data is located
  13774. * @param scene defines the current scene
  13775. * @param size defines the size of the textures
  13776. * @param format defines the format of the data
  13777. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  13778. * @param noMipmap defines if the engine should avoid generating the mip levels
  13779. * @param callback defines a callback used to extract texture data from loaded data
  13780. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  13781. * @param onLoad defines a callback called when texture is loaded
  13782. * @param onError defines a callback called if there is an error
  13783. * @returns the cube texture as an InternalTexture
  13784. */
  13785. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>): InternalTexture;
  13786. /**
  13787. * Creates a new raw cube texture from a specified url
  13788. * @param url defines the url where the data is located
  13789. * @param scene defines the current scene
  13790. * @param size defines the size of the textures
  13791. * @param format defines the format of the data
  13792. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  13793. * @param noMipmap defines if the engine should avoid generating the mip levels
  13794. * @param callback defines a callback used to extract texture data from loaded data
  13795. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  13796. * @param onLoad defines a callback called when texture is loaded
  13797. * @param onError defines a callback called if there is an error
  13798. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  13799. * @param invertY defines if data must be stored with Y axis inverted
  13800. * @returns the cube texture as an InternalTexture
  13801. */
  13802. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>, samplingMode: number, invertY: boolean): InternalTexture;
  13803. /**
  13804. * Creates a new raw 3D texture
  13805. * @param data defines the data used to create the texture
  13806. * @param width defines the width of the texture
  13807. * @param height defines the height of the texture
  13808. * @param depth defines the depth of the texture
  13809. * @param format defines the format of the texture
  13810. * @param generateMipMaps defines if the engine must generate mip levels
  13811. * @param invertY defines if data must be stored with Y axis inverted
  13812. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  13813. * @param compression defines the compressed used (can be null)
  13814. * @param textureType defines the compressed used (can be null)
  13815. * @returns a new raw 3D texture (stored in an InternalTexture)
  13816. */
  13817. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  13818. /**
  13819. * Update a raw 3D texture
  13820. * @param texture defines the texture to update
  13821. * @param data defines the data to store
  13822. * @param format defines the data format
  13823. * @param invertY defines if data must be stored with Y axis inverted
  13824. */
  13825. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  13826. /**
  13827. * Update a raw 3D texture
  13828. * @param texture defines the texture to update
  13829. * @param data defines the data to store
  13830. * @param format defines the data format
  13831. * @param invertY defines if data must be stored with Y axis inverted
  13832. * @param compression defines the used compression (can be null)
  13833. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  13834. */
  13835. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  13836. /**
  13837. * Creates a new raw 2D array texture
  13838. * @param data defines the data used to create the texture
  13839. * @param width defines the width of the texture
  13840. * @param height defines the height of the texture
  13841. * @param depth defines the number of layers of the texture
  13842. * @param format defines the format of the texture
  13843. * @param generateMipMaps defines if the engine must generate mip levels
  13844. * @param invertY defines if data must be stored with Y axis inverted
  13845. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  13846. * @param compression defines the compressed used (can be null)
  13847. * @param textureType defines the compressed used (can be null)
  13848. * @returns a new raw 2D array texture (stored in an InternalTexture)
  13849. */
  13850. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  13851. /**
  13852. * Update a raw 2D array texture
  13853. * @param texture defines the texture to update
  13854. * @param data defines the data to store
  13855. * @param format defines the data format
  13856. * @param invertY defines if data must be stored with Y axis inverted
  13857. */
  13858. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  13859. /**
  13860. * Update a raw 2D array texture
  13861. * @param texture defines the texture to update
  13862. * @param data defines the data to store
  13863. * @param format defines the data format
  13864. * @param invertY defines if data must be stored with Y axis inverted
  13865. * @param compression defines the used compression (can be null)
  13866. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  13867. */
  13868. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  13869. }
  13870. }
  13871. declare module BABYLON {
  13872. /**
  13873. * Raw texture can help creating a texture directly from an array of data.
  13874. * This can be super useful if you either get the data from an uncompressed source or
  13875. * if you wish to create your texture pixel by pixel.
  13876. */
  13877. export class RawTexture extends Texture {
  13878. /**
  13879. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  13880. */
  13881. format: number;
  13882. /**
  13883. * Instantiates a new RawTexture.
  13884. * Raw texture can help creating a texture directly from an array of data.
  13885. * This can be super useful if you either get the data from an uncompressed source or
  13886. * if you wish to create your texture pixel by pixel.
  13887. * @param data define the array of data to use to create the texture
  13888. * @param width define the width of the texture
  13889. * @param height define the height of the texture
  13890. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  13891. * @param sceneOrEngine defines the scene or engine the texture will belong to
  13892. * @param generateMipMaps define whether mip maps should be generated or not
  13893. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  13894. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  13895. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  13896. */
  13897. constructor(data: ArrayBufferView, width: number, height: number,
  13898. /**
  13899. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  13900. */
  13901. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  13902. /**
  13903. * Updates the texture underlying data.
  13904. * @param data Define the new data of the texture
  13905. */
  13906. update(data: ArrayBufferView): void;
  13907. /**
  13908. * Creates a luminance texture from some data.
  13909. * @param data Define the texture data
  13910. * @param width Define the width of the texture
  13911. * @param height Define the height of the texture
  13912. * @param sceneOrEngine defines the scene or engine the texture will belong to
  13913. * @param generateMipMaps Define whether or not to create mip maps for the texture
  13914. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  13915. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  13916. * @returns the luminance texture
  13917. */
  13918. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  13919. /**
  13920. * Creates a luminance alpha texture from some data.
  13921. * @param data Define the texture data
  13922. * @param width Define the width of the texture
  13923. * @param height Define the height of the texture
  13924. * @param sceneOrEngine defines the scene or engine the texture will belong to
  13925. * @param generateMipMaps Define whether or not to create mip maps for the texture
  13926. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  13927. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  13928. * @returns the luminance alpha texture
  13929. */
  13930. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  13931. /**
  13932. * Creates an alpha texture from some data.
  13933. * @param data Define the texture data
  13934. * @param width Define the width of the texture
  13935. * @param height Define the height of the texture
  13936. * @param sceneOrEngine defines the scene or engine the texture will belong to
  13937. * @param generateMipMaps Define whether or not to create mip maps for the texture
  13938. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  13939. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  13940. * @returns the alpha texture
  13941. */
  13942. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  13943. /**
  13944. * Creates a RGB texture from some data.
  13945. * @param data Define the texture data
  13946. * @param width Define the width of the texture
  13947. * @param height Define the height of the texture
  13948. * @param sceneOrEngine defines the scene or engine the texture will belong to
  13949. * @param generateMipMaps Define whether or not to create mip maps for the texture
  13950. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  13951. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  13952. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  13953. * @returns the RGB alpha texture
  13954. */
  13955. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  13956. /**
  13957. * Creates a RGBA texture from some data.
  13958. * @param data Define the texture data
  13959. * @param width Define the width of the texture
  13960. * @param height Define the height of the texture
  13961. * @param sceneOrEngine defines the scene or engine the texture will belong to
  13962. * @param generateMipMaps Define whether or not to create mip maps for the texture
  13963. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  13964. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  13965. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  13966. * @returns the RGBA texture
  13967. */
  13968. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  13969. /**
  13970. * Creates a R texture from some data.
  13971. * @param data Define the texture data
  13972. * @param width Define the width of the texture
  13973. * @param height Define the height of the texture
  13974. * @param sceneOrEngine defines the scene or engine the texture will belong to
  13975. * @param generateMipMaps Define whether or not to create mip maps for the texture
  13976. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  13977. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  13978. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  13979. * @returns the R texture
  13980. */
  13981. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  13982. }
  13983. }
  13984. declare module BABYLON {
  13985. interface ThinEngine {
  13986. /**
  13987. * Update a dynamic index buffer
  13988. * @param indexBuffer defines the target index buffer
  13989. * @param indices defines the data to update
  13990. * @param offset defines the offset in the target index buffer where update should start
  13991. */
  13992. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  13993. /**
  13994. * Updates a dynamic vertex buffer.
  13995. * @param vertexBuffer the vertex buffer to update
  13996. * @param data the data used to update the vertex buffer
  13997. * @param byteOffset the byte offset of the data
  13998. * @param byteLength the byte length of the data
  13999. */
  14000. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  14001. }
  14002. }
  14003. declare module BABYLON {
  14004. interface AbstractScene {
  14005. /**
  14006. * The list of procedural textures added to the scene
  14007. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  14008. */
  14009. proceduralTextures: Array<ProceduralTexture>;
  14010. }
  14011. /**
  14012. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  14013. * in a given scene.
  14014. */
  14015. export class ProceduralTextureSceneComponent implements ISceneComponent {
  14016. /**
  14017. * The component name helpfull to identify the component in the list of scene components.
  14018. */
  14019. readonly name: string;
  14020. /**
  14021. * The scene the component belongs to.
  14022. */
  14023. scene: Scene;
  14024. /**
  14025. * Creates a new instance of the component for the given scene
  14026. * @param scene Defines the scene to register the component in
  14027. */
  14028. constructor(scene: Scene);
  14029. /**
  14030. * Registers the component in a given scene
  14031. */
  14032. register(): void;
  14033. /**
  14034. * Rebuilds the elements related to this component in case of
  14035. * context lost for instance.
  14036. */
  14037. rebuild(): void;
  14038. /**
  14039. * Disposes the component and the associated ressources.
  14040. */
  14041. dispose(): void;
  14042. private _beforeClear;
  14043. }
  14044. }
  14045. declare module BABYLON {
  14046. interface ThinEngine {
  14047. /**
  14048. * Creates a new render target cube texture
  14049. * @param size defines the size of the texture
  14050. * @param options defines the options used to create the texture
  14051. * @returns a new render target cube texture stored in an InternalTexture
  14052. */
  14053. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  14054. }
  14055. }
  14056. declare module BABYLON {
  14057. /** @hidden */
  14058. export var proceduralVertexShader: {
  14059. name: string;
  14060. shader: string;
  14061. };
  14062. }
  14063. declare module BABYLON {
  14064. /**
  14065. * 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.
  14066. * This is the base class of any Procedural texture and contains most of the shareable code.
  14067. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  14068. */
  14069. export class ProceduralTexture extends Texture {
  14070. /**
  14071. * Define if the texture is enabled or not (disabled texture will not render)
  14072. */
  14073. isEnabled: boolean;
  14074. /**
  14075. * Define if the texture must be cleared before rendering (default is true)
  14076. */
  14077. autoClear: boolean;
  14078. /**
  14079. * Callback called when the texture is generated
  14080. */
  14081. onGenerated: () => void;
  14082. /**
  14083. * Event raised when the texture is generated
  14084. */
  14085. onGeneratedObservable: Observable<ProceduralTexture>;
  14086. /**
  14087. * Event raised before the texture is generated
  14088. */
  14089. onBeforeGenerationObservable: Observable<ProceduralTexture>;
  14090. /**
  14091. * Gets or sets the node material used to create this texture (null if the texture was manually created)
  14092. */
  14093. nodeMaterialSource: Nullable<NodeMaterial>;
  14094. /** @hidden */
  14095. _generateMipMaps: boolean;
  14096. /** @hidden **/
  14097. _effect: Effect;
  14098. /** @hidden */
  14099. _textures: {
  14100. [key: string]: Texture;
  14101. };
  14102. /** @hidden */
  14103. protected _fallbackTexture: Nullable<Texture>;
  14104. private _size;
  14105. private _currentRefreshId;
  14106. private _frameId;
  14107. private _refreshRate;
  14108. private _vertexBuffers;
  14109. private _indexBuffer;
  14110. private _uniforms;
  14111. private _samplers;
  14112. private _fragment;
  14113. private _floats;
  14114. private _ints;
  14115. private _floatsArrays;
  14116. private _colors3;
  14117. private _colors4;
  14118. private _vectors2;
  14119. private _vectors3;
  14120. private _matrices;
  14121. private _fallbackTextureUsed;
  14122. private _fullEngine;
  14123. private _cachedDefines;
  14124. private _contentUpdateId;
  14125. private _contentData;
  14126. /**
  14127. * Instantiates a new procedural texture.
  14128. * 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.
  14129. * This is the base class of any Procedural texture and contains most of the shareable code.
  14130. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  14131. * @param name Define the name of the texture
  14132. * @param size Define the size of the texture to create
  14133. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  14134. * @param scene Define the scene the texture belongs to
  14135. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  14136. * @param generateMipMaps Define if the texture should creates mip maps or not
  14137. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  14138. * @param textureType The FBO internal texture type
  14139. */
  14140. constructor(name: string, size: RenderTargetTextureSize, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean, textureType?: number);
  14141. /**
  14142. * The effect that is created when initializing the post process.
  14143. * @returns The created effect corresponding the the postprocess.
  14144. */
  14145. getEffect(): Effect;
  14146. /**
  14147. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  14148. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  14149. */
  14150. getContent(): Nullable<ArrayBufferView>;
  14151. private _createIndexBuffer;
  14152. /** @hidden */
  14153. _rebuild(): void;
  14154. /**
  14155. * Resets the texture in order to recreate its associated resources.
  14156. * This can be called in case of context loss
  14157. */
  14158. reset(): void;
  14159. protected _getDefines(): string;
  14160. /**
  14161. * Is the texture ready to be used ? (rendered at least once)
  14162. * @returns true if ready, otherwise, false.
  14163. */
  14164. isReady(): boolean;
  14165. /**
  14166. * Resets the refresh counter of the texture and start bak from scratch.
  14167. * Could be useful to regenerate the texture if it is setup to render only once.
  14168. */
  14169. resetRefreshCounter(): void;
  14170. /**
  14171. * Set the fragment shader to use in order to render the texture.
  14172. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  14173. */
  14174. setFragment(fragment: any): void;
  14175. /**
  14176. * Define the refresh rate of the texture or the rendering frequency.
  14177. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  14178. */
  14179. get refreshRate(): number;
  14180. set refreshRate(value: number);
  14181. /** @hidden */
  14182. _shouldRender(): boolean;
  14183. /**
  14184. * Get the size the texture is rendering at.
  14185. * @returns the size (on cube texture it is always squared)
  14186. */
  14187. getRenderSize(): RenderTargetTextureSize;
  14188. /**
  14189. * Resize the texture to new value.
  14190. * @param size Define the new size the texture should have
  14191. * @param generateMipMaps Define whether the new texture should create mip maps
  14192. */
  14193. resize(size: number, generateMipMaps: boolean): void;
  14194. private _checkUniform;
  14195. /**
  14196. * Set a texture in the shader program used to render.
  14197. * @param name Define the name of the uniform samplers as defined in the shader
  14198. * @param texture Define the texture to bind to this sampler
  14199. * @return the texture itself allowing "fluent" like uniform updates
  14200. */
  14201. setTexture(name: string, texture: Texture): ProceduralTexture;
  14202. /**
  14203. * Set a float in the shader.
  14204. * @param name Define the name of the uniform as defined in the shader
  14205. * @param value Define the value to give to the uniform
  14206. * @return the texture itself allowing "fluent" like uniform updates
  14207. */
  14208. setFloat(name: string, value: number): ProceduralTexture;
  14209. /**
  14210. * Set a int in the shader.
  14211. * @param name Define the name of the uniform as defined in the shader
  14212. * @param value Define the value to give to the uniform
  14213. * @return the texture itself allowing "fluent" like uniform updates
  14214. */
  14215. setInt(name: string, value: number): ProceduralTexture;
  14216. /**
  14217. * Set an array of floats in the shader.
  14218. * @param name Define the name of the uniform as defined in the shader
  14219. * @param value Define the value to give to the uniform
  14220. * @return the texture itself allowing "fluent" like uniform updates
  14221. */
  14222. setFloats(name: string, value: number[]): ProceduralTexture;
  14223. /**
  14224. * Set a vec3 in the shader from a Color3.
  14225. * @param name Define the name of the uniform as defined in the shader
  14226. * @param value Define the value to give to the uniform
  14227. * @return the texture itself allowing "fluent" like uniform updates
  14228. */
  14229. setColor3(name: string, value: Color3): ProceduralTexture;
  14230. /**
  14231. * Set a vec4 in the shader from a Color4.
  14232. * @param name Define the name of the uniform as defined in the shader
  14233. * @param value Define the value to give to the uniform
  14234. * @return the texture itself allowing "fluent" like uniform updates
  14235. */
  14236. setColor4(name: string, value: Color4): ProceduralTexture;
  14237. /**
  14238. * Set a vec2 in the shader from a Vector2.
  14239. * @param name Define the name of the uniform as defined in the shader
  14240. * @param value Define the value to give to the uniform
  14241. * @return the texture itself allowing "fluent" like uniform updates
  14242. */
  14243. setVector2(name: string, value: Vector2): ProceduralTexture;
  14244. /**
  14245. * Set a vec3 in the shader from a Vector3.
  14246. * @param name Define the name of the uniform as defined in the shader
  14247. * @param value Define the value to give to the uniform
  14248. * @return the texture itself allowing "fluent" like uniform updates
  14249. */
  14250. setVector3(name: string, value: Vector3): ProceduralTexture;
  14251. /**
  14252. * Set a mat4 in the shader from a MAtrix.
  14253. * @param name Define the name of the uniform as defined in the shader
  14254. * @param value Define the value to give to the uniform
  14255. * @return the texture itself allowing "fluent" like uniform updates
  14256. */
  14257. setMatrix(name: string, value: Matrix): ProceduralTexture;
  14258. /**
  14259. * Render the texture to its associated render target.
  14260. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  14261. */
  14262. render(useCameraPostProcess?: boolean): void;
  14263. /**
  14264. * Clone the texture.
  14265. * @returns the cloned texture
  14266. */
  14267. clone(): ProceduralTexture;
  14268. /**
  14269. * Dispose the texture and release its asoociated resources.
  14270. */
  14271. dispose(): void;
  14272. }
  14273. }
  14274. declare module BABYLON {
  14275. /**
  14276. * This represents the base class for particle system in Babylon.
  14277. * 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.
  14278. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  14279. * @example https://doc.babylonjs.com/babylon101/particles
  14280. */
  14281. export class BaseParticleSystem {
  14282. /**
  14283. * Source color is added to the destination color without alpha affecting the result
  14284. */
  14285. static BLENDMODE_ONEONE: number;
  14286. /**
  14287. * Blend current color and particle color using particle’s alpha
  14288. */
  14289. static BLENDMODE_STANDARD: number;
  14290. /**
  14291. * Add current color and particle color multiplied by particle’s alpha
  14292. */
  14293. static BLENDMODE_ADD: number;
  14294. /**
  14295. * Multiply current color with particle color
  14296. */
  14297. static BLENDMODE_MULTIPLY: number;
  14298. /**
  14299. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  14300. */
  14301. static BLENDMODE_MULTIPLYADD: number;
  14302. /**
  14303. * List of animations used by the particle system.
  14304. */
  14305. animations: Animation[];
  14306. /**
  14307. * Gets or sets the unique id of the particle system
  14308. */
  14309. uniqueId: number;
  14310. /**
  14311. * The id of the Particle system.
  14312. */
  14313. id: string;
  14314. /**
  14315. * The friendly name of the Particle system.
  14316. */
  14317. name: string;
  14318. /**
  14319. * Snippet ID if the particle system was created from the snippet server
  14320. */
  14321. snippetId: string;
  14322. /**
  14323. * The rendering group used by the Particle system to chose when to render.
  14324. */
  14325. renderingGroupId: number;
  14326. /**
  14327. * The emitter represents the Mesh or position we are attaching the particle system to.
  14328. */
  14329. emitter: Nullable<AbstractMesh | Vector3>;
  14330. /**
  14331. * The maximum number of particles to emit per frame
  14332. */
  14333. emitRate: number;
  14334. /**
  14335. * If you want to launch only a few particles at once, that can be done, as well.
  14336. */
  14337. manualEmitCount: number;
  14338. /**
  14339. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  14340. */
  14341. updateSpeed: number;
  14342. /**
  14343. * The amount of time the particle system is running (depends of the overall update speed).
  14344. */
  14345. targetStopDuration: number;
  14346. /**
  14347. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  14348. */
  14349. disposeOnStop: boolean;
  14350. /**
  14351. * Minimum power of emitting particles.
  14352. */
  14353. minEmitPower: number;
  14354. /**
  14355. * Maximum power of emitting particles.
  14356. */
  14357. maxEmitPower: number;
  14358. /**
  14359. * Minimum life time of emitting particles.
  14360. */
  14361. minLifeTime: number;
  14362. /**
  14363. * Maximum life time of emitting particles.
  14364. */
  14365. maxLifeTime: number;
  14366. /**
  14367. * Minimum Size of emitting particles.
  14368. */
  14369. minSize: number;
  14370. /**
  14371. * Maximum Size of emitting particles.
  14372. */
  14373. maxSize: number;
  14374. /**
  14375. * Minimum scale of emitting particles on X axis.
  14376. */
  14377. minScaleX: number;
  14378. /**
  14379. * Maximum scale of emitting particles on X axis.
  14380. */
  14381. maxScaleX: number;
  14382. /**
  14383. * Minimum scale of emitting particles on Y axis.
  14384. */
  14385. minScaleY: number;
  14386. /**
  14387. * Maximum scale of emitting particles on Y axis.
  14388. */
  14389. maxScaleY: number;
  14390. /**
  14391. * Gets or sets the minimal initial rotation in radians.
  14392. */
  14393. minInitialRotation: number;
  14394. /**
  14395. * Gets or sets the maximal initial rotation in radians.
  14396. */
  14397. maxInitialRotation: number;
  14398. /**
  14399. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  14400. */
  14401. minAngularSpeed: number;
  14402. /**
  14403. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  14404. */
  14405. maxAngularSpeed: number;
  14406. /**
  14407. * The texture used to render each particle. (this can be a spritesheet)
  14408. */
  14409. particleTexture: Nullable<BaseTexture>;
  14410. /**
  14411. * The layer mask we are rendering the particles through.
  14412. */
  14413. layerMask: number;
  14414. /**
  14415. * This can help using your own shader to render the particle system.
  14416. * The according effect will be created
  14417. */
  14418. customShader: any;
  14419. /**
  14420. * By default particle system starts as soon as they are created. This prevents the
  14421. * automatic start to happen and let you decide when to start emitting particles.
  14422. */
  14423. preventAutoStart: boolean;
  14424. private _noiseTexture;
  14425. /**
  14426. * Gets or sets a texture used to add random noise to particle positions
  14427. */
  14428. get noiseTexture(): Nullable<ProceduralTexture>;
  14429. set noiseTexture(value: Nullable<ProceduralTexture>);
  14430. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  14431. noiseStrength: Vector3;
  14432. /**
  14433. * Callback triggered when the particle animation is ending.
  14434. */
  14435. onAnimationEnd: Nullable<() => void>;
  14436. /**
  14437. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  14438. */
  14439. blendMode: number;
  14440. /**
  14441. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  14442. * to override the particles.
  14443. */
  14444. forceDepthWrite: boolean;
  14445. /** 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 */
  14446. preWarmCycles: number;
  14447. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  14448. preWarmStepOffset: number;
  14449. /**
  14450. * 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)
  14451. */
  14452. spriteCellChangeSpeed: number;
  14453. /**
  14454. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  14455. */
  14456. startSpriteCellID: number;
  14457. /**
  14458. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  14459. */
  14460. endSpriteCellID: number;
  14461. /**
  14462. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  14463. */
  14464. spriteCellWidth: number;
  14465. /**
  14466. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  14467. */
  14468. spriteCellHeight: number;
  14469. /**
  14470. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  14471. */
  14472. spriteRandomStartCell: boolean;
  14473. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  14474. translationPivot: Vector2;
  14475. /** @hidden */
  14476. protected _isAnimationSheetEnabled: boolean;
  14477. /**
  14478. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  14479. */
  14480. beginAnimationOnStart: boolean;
  14481. /**
  14482. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  14483. */
  14484. beginAnimationFrom: number;
  14485. /**
  14486. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  14487. */
  14488. beginAnimationTo: number;
  14489. /**
  14490. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  14491. */
  14492. beginAnimationLoop: boolean;
  14493. /**
  14494. * Gets or sets a world offset applied to all particles
  14495. */
  14496. worldOffset: Vector3;
  14497. /**
  14498. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  14499. */
  14500. get isAnimationSheetEnabled(): boolean;
  14501. set isAnimationSheetEnabled(value: boolean);
  14502. /**
  14503. * Get hosting scene
  14504. * @returns the scene
  14505. */
  14506. getScene(): Nullable<Scene>;
  14507. /**
  14508. * You can use gravity if you want to give an orientation to your particles.
  14509. */
  14510. gravity: Vector3;
  14511. protected _colorGradients: Nullable<Array<ColorGradient>>;
  14512. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  14513. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  14514. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  14515. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  14516. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  14517. protected _dragGradients: Nullable<Array<FactorGradient>>;
  14518. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  14519. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  14520. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  14521. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  14522. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  14523. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  14524. /**
  14525. * Defines the delay in milliseconds before starting the system (0 by default)
  14526. */
  14527. startDelay: number;
  14528. /**
  14529. * Gets the current list of drag gradients.
  14530. * You must use addDragGradient and removeDragGradient to udpate this list
  14531. * @returns the list of drag gradients
  14532. */
  14533. getDragGradients(): Nullable<Array<FactorGradient>>;
  14534. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  14535. limitVelocityDamping: number;
  14536. /**
  14537. * Gets the current list of limit velocity gradients.
  14538. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  14539. * @returns the list of limit velocity gradients
  14540. */
  14541. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  14542. /**
  14543. * Gets the current list of color gradients.
  14544. * You must use addColorGradient and removeColorGradient to udpate this list
  14545. * @returns the list of color gradients
  14546. */
  14547. getColorGradients(): Nullable<Array<ColorGradient>>;
  14548. /**
  14549. * Gets the current list of size gradients.
  14550. * You must use addSizeGradient and removeSizeGradient to udpate this list
  14551. * @returns the list of size gradients
  14552. */
  14553. getSizeGradients(): Nullable<Array<FactorGradient>>;
  14554. /**
  14555. * Gets the current list of color remap gradients.
  14556. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  14557. * @returns the list of color remap gradients
  14558. */
  14559. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  14560. /**
  14561. * Gets the current list of alpha remap gradients.
  14562. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  14563. * @returns the list of alpha remap gradients
  14564. */
  14565. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  14566. /**
  14567. * Gets the current list of life time gradients.
  14568. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  14569. * @returns the list of life time gradients
  14570. */
  14571. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  14572. /**
  14573. * Gets the current list of angular speed gradients.
  14574. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  14575. * @returns the list of angular speed gradients
  14576. */
  14577. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  14578. /**
  14579. * Gets the current list of velocity gradients.
  14580. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  14581. * @returns the list of velocity gradients
  14582. */
  14583. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  14584. /**
  14585. * Gets the current list of start size gradients.
  14586. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  14587. * @returns the list of start size gradients
  14588. */
  14589. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  14590. /**
  14591. * Gets the current list of emit rate gradients.
  14592. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  14593. * @returns the list of emit rate gradients
  14594. */
  14595. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  14596. /**
  14597. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14598. * This only works when particleEmitterTyps is a BoxParticleEmitter
  14599. */
  14600. get direction1(): Vector3;
  14601. set direction1(value: Vector3);
  14602. /**
  14603. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14604. * This only works when particleEmitterTyps is a BoxParticleEmitter
  14605. */
  14606. get direction2(): Vector3;
  14607. set direction2(value: Vector3);
  14608. /**
  14609. * 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.
  14610. * This only works when particleEmitterTyps is a BoxParticleEmitter
  14611. */
  14612. get minEmitBox(): Vector3;
  14613. set minEmitBox(value: Vector3);
  14614. /**
  14615. * 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.
  14616. * This only works when particleEmitterTyps is a BoxParticleEmitter
  14617. */
  14618. get maxEmitBox(): Vector3;
  14619. set maxEmitBox(value: Vector3);
  14620. /**
  14621. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  14622. */
  14623. color1: Color4;
  14624. /**
  14625. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  14626. */
  14627. color2: Color4;
  14628. /**
  14629. * Color the particle will have at the end of its lifetime
  14630. */
  14631. colorDead: Color4;
  14632. /**
  14633. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  14634. */
  14635. textureMask: Color4;
  14636. /**
  14637. * The particle emitter type defines the emitter used by the particle system.
  14638. * It can be for example box, sphere, or cone...
  14639. */
  14640. particleEmitterType: IParticleEmitterType;
  14641. /** @hidden */
  14642. _isSubEmitter: boolean;
  14643. /**
  14644. * Gets or sets the billboard mode to use when isBillboardBased = true.
  14645. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  14646. */
  14647. billboardMode: number;
  14648. protected _isBillboardBased: boolean;
  14649. /**
  14650. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  14651. */
  14652. get isBillboardBased(): boolean;
  14653. set isBillboardBased(value: boolean);
  14654. /**
  14655. * The scene the particle system belongs to.
  14656. */
  14657. protected _scene: Nullable<Scene>;
  14658. /**
  14659. * The engine the particle system belongs to.
  14660. */
  14661. protected _engine: ThinEngine;
  14662. /**
  14663. * Local cache of defines for image processing.
  14664. */
  14665. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  14666. /**
  14667. * Default configuration related to image processing available in the standard Material.
  14668. */
  14669. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  14670. /**
  14671. * Gets the image processing configuration used either in this material.
  14672. */
  14673. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  14674. /**
  14675. * Sets the Default image processing configuration used either in the this material.
  14676. *
  14677. * If sets to null, the scene one is in use.
  14678. */
  14679. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  14680. /**
  14681. * Attaches a new image processing configuration to the Standard Material.
  14682. * @param configuration
  14683. */
  14684. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  14685. /** @hidden */
  14686. protected _reset(): void;
  14687. /** @hidden */
  14688. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  14689. /**
  14690. * Instantiates a particle system.
  14691. * 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.
  14692. * @param name The name of the particle system
  14693. */
  14694. constructor(name: string);
  14695. /**
  14696. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  14697. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14698. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14699. * @returns the emitter
  14700. */
  14701. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  14702. /**
  14703. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  14704. * @param radius The radius of the hemisphere to emit from
  14705. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14706. * @returns the emitter
  14707. */
  14708. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  14709. /**
  14710. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  14711. * @param radius The radius of the sphere to emit from
  14712. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14713. * @returns the emitter
  14714. */
  14715. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  14716. /**
  14717. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  14718. * @param radius The radius of the sphere to emit from
  14719. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  14720. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  14721. * @returns the emitter
  14722. */
  14723. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  14724. /**
  14725. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  14726. * @param radius The radius of the emission cylinder
  14727. * @param height The height of the emission cylinder
  14728. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  14729. * @param directionRandomizer How much to randomize the particle direction [0-1]
  14730. * @returns the emitter
  14731. */
  14732. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  14733. /**
  14734. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  14735. * @param radius The radius of the cylinder to emit from
  14736. * @param height The height of the emission cylinder
  14737. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14738. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  14739. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  14740. * @returns the emitter
  14741. */
  14742. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  14743. /**
  14744. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  14745. * @param radius The radius of the cone to emit from
  14746. * @param angle The base angle of the cone
  14747. * @returns the emitter
  14748. */
  14749. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  14750. /**
  14751. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  14752. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14753. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14754. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14755. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14756. * @returns the emitter
  14757. */
  14758. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  14759. }
  14760. }
  14761. declare module BABYLON {
  14762. /**
  14763. * Type of sub emitter
  14764. */
  14765. export enum SubEmitterType {
  14766. /**
  14767. * Attached to the particle over it's lifetime
  14768. */
  14769. ATTACHED = 0,
  14770. /**
  14771. * Created when the particle dies
  14772. */
  14773. END = 1
  14774. }
  14775. /**
  14776. * Sub emitter class used to emit particles from an existing particle
  14777. */
  14778. export class SubEmitter {
  14779. /**
  14780. * the particle system to be used by the sub emitter
  14781. */
  14782. particleSystem: ParticleSystem;
  14783. /**
  14784. * Type of the submitter (Default: END)
  14785. */
  14786. type: SubEmitterType;
  14787. /**
  14788. * 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)
  14789. * Note: This only is supported when using an emitter of type Mesh
  14790. */
  14791. inheritDirection: boolean;
  14792. /**
  14793. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  14794. */
  14795. inheritedVelocityAmount: number;
  14796. /**
  14797. * Creates a sub emitter
  14798. * @param particleSystem the particle system to be used by the sub emitter
  14799. */
  14800. constructor(
  14801. /**
  14802. * the particle system to be used by the sub emitter
  14803. */
  14804. particleSystem: ParticleSystem);
  14805. /**
  14806. * Clones the sub emitter
  14807. * @returns the cloned sub emitter
  14808. */
  14809. clone(): SubEmitter;
  14810. /**
  14811. * Serialize current object to a JSON object
  14812. * @returns the serialized object
  14813. */
  14814. serialize(): any;
  14815. /** @hidden */
  14816. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  14817. /**
  14818. * Creates a new SubEmitter from a serialized JSON version
  14819. * @param serializationObject defines the JSON object to read from
  14820. * @param sceneOrEngine defines the hosting scene or the hosting engine
  14821. * @param rootUrl defines the rootUrl for data loading
  14822. * @returns a new SubEmitter
  14823. */
  14824. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  14825. /** Release associated resources */
  14826. dispose(): void;
  14827. }
  14828. }
  14829. declare module BABYLON {
  14830. /** @hidden */
  14831. export var clipPlaneFragmentDeclaration: {
  14832. name: string;
  14833. shader: string;
  14834. };
  14835. }
  14836. declare module BABYLON {
  14837. /** @hidden */
  14838. export var imageProcessingDeclaration: {
  14839. name: string;
  14840. shader: string;
  14841. };
  14842. }
  14843. declare module BABYLON {
  14844. /** @hidden */
  14845. export var imageProcessingFunctions: {
  14846. name: string;
  14847. shader: string;
  14848. };
  14849. }
  14850. declare module BABYLON {
  14851. /** @hidden */
  14852. export var clipPlaneFragment: {
  14853. name: string;
  14854. shader: string;
  14855. };
  14856. }
  14857. declare module BABYLON {
  14858. /** @hidden */
  14859. export var particlesPixelShader: {
  14860. name: string;
  14861. shader: string;
  14862. };
  14863. }
  14864. declare module BABYLON {
  14865. /** @hidden */
  14866. export var clipPlaneVertexDeclaration: {
  14867. name: string;
  14868. shader: string;
  14869. };
  14870. }
  14871. declare module BABYLON {
  14872. /** @hidden */
  14873. export var clipPlaneVertex: {
  14874. name: string;
  14875. shader: string;
  14876. };
  14877. }
  14878. declare module BABYLON {
  14879. /** @hidden */
  14880. export var particlesVertexShader: {
  14881. name: string;
  14882. shader: string;
  14883. };
  14884. }
  14885. declare module BABYLON {
  14886. /**
  14887. * Interface used to define entities containing multiple clip planes
  14888. */
  14889. export interface IClipPlanesHolder {
  14890. /**
  14891. * Gets or sets the active clipplane 1
  14892. */
  14893. clipPlane: Nullable<Plane>;
  14894. /**
  14895. * Gets or sets the active clipplane 2
  14896. */
  14897. clipPlane2: Nullable<Plane>;
  14898. /**
  14899. * Gets or sets the active clipplane 3
  14900. */
  14901. clipPlane3: Nullable<Plane>;
  14902. /**
  14903. * Gets or sets the active clipplane 4
  14904. */
  14905. clipPlane4: Nullable<Plane>;
  14906. /**
  14907. * Gets or sets the active clipplane 5
  14908. */
  14909. clipPlane5: Nullable<Plane>;
  14910. /**
  14911. * Gets or sets the active clipplane 6
  14912. */
  14913. clipPlane6: Nullable<Plane>;
  14914. }
  14915. }
  14916. declare module BABYLON {
  14917. /**
  14918. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  14919. *
  14920. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  14921. *
  14922. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  14923. */
  14924. export class ThinMaterialHelper {
  14925. /**
  14926. * Binds the clip plane information from the holder to the effect.
  14927. * @param effect The effect we are binding the data to
  14928. * @param holder The entity containing the clip plane information
  14929. */
  14930. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  14931. }
  14932. }
  14933. declare module BABYLON {
  14934. interface ThinEngine {
  14935. /**
  14936. * Sets alpha constants used by some alpha blending modes
  14937. * @param r defines the red component
  14938. * @param g defines the green component
  14939. * @param b defines the blue component
  14940. * @param a defines the alpha component
  14941. */
  14942. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  14943. /**
  14944. * Sets the current alpha mode
  14945. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  14946. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  14947. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  14948. */
  14949. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  14950. /**
  14951. * Gets the current alpha mode
  14952. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  14953. * @returns the current alpha mode
  14954. */
  14955. getAlphaMode(): number;
  14956. /**
  14957. * Sets the current alpha equation
  14958. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  14959. */
  14960. setAlphaEquation(equation: number): void;
  14961. /**
  14962. * Gets the current alpha equation.
  14963. * @returns the current alpha equation
  14964. */
  14965. getAlphaEquation(): number;
  14966. }
  14967. }
  14968. declare module BABYLON {
  14969. /**
  14970. * This represents a particle system in Babylon.
  14971. * 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.
  14972. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  14973. * @example https://doc.babylonjs.com/babylon101/particles
  14974. */
  14975. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  14976. /**
  14977. * Billboard mode will only apply to Y axis
  14978. */
  14979. static readonly BILLBOARDMODE_Y: number;
  14980. /**
  14981. * Billboard mode will apply to all axes
  14982. */
  14983. static readonly BILLBOARDMODE_ALL: number;
  14984. /**
  14985. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  14986. */
  14987. static readonly BILLBOARDMODE_STRETCHED: number;
  14988. /**
  14989. * This function can be defined to provide custom update for active particles.
  14990. * This function will be called instead of regular update (age, position, color, etc.).
  14991. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  14992. */
  14993. updateFunction: (particles: Particle[]) => void;
  14994. private _emitterWorldMatrix;
  14995. /**
  14996. * This function can be defined to specify initial direction for every new particle.
  14997. * It by default use the emitterType defined function
  14998. */
  14999. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  15000. /**
  15001. * This function can be defined to specify initial position for every new particle.
  15002. * It by default use the emitterType defined function
  15003. */
  15004. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  15005. /**
  15006. * @hidden
  15007. */
  15008. _inheritedVelocityOffset: Vector3;
  15009. /**
  15010. * An event triggered when the system is disposed
  15011. */
  15012. onDisposeObservable: Observable<IParticleSystem>;
  15013. /**
  15014. * An event triggered when the system is stopped
  15015. */
  15016. onStoppedObservable: Observable<IParticleSystem>;
  15017. private _onDisposeObserver;
  15018. /**
  15019. * Sets a callback that will be triggered when the system is disposed
  15020. */
  15021. set onDispose(callback: () => void);
  15022. private _particles;
  15023. private _epsilon;
  15024. private _capacity;
  15025. private _stockParticles;
  15026. private _newPartsExcess;
  15027. private _vertexData;
  15028. private _vertexBuffer;
  15029. private _vertexBuffers;
  15030. private _spriteBuffer;
  15031. private _indexBuffer;
  15032. private _effect;
  15033. private _customEffect;
  15034. private _cachedDefines;
  15035. private _scaledColorStep;
  15036. private _colorDiff;
  15037. private _scaledDirection;
  15038. private _scaledGravity;
  15039. private _currentRenderId;
  15040. private _alive;
  15041. private _useInstancing;
  15042. private _vertexArrayObject;
  15043. private _started;
  15044. private _stopped;
  15045. private _actualFrame;
  15046. private _scaledUpdateSpeed;
  15047. private _vertexBufferSize;
  15048. /** @hidden */
  15049. _currentEmitRateGradient: Nullable<FactorGradient>;
  15050. /** @hidden */
  15051. _currentEmitRate1: number;
  15052. /** @hidden */
  15053. _currentEmitRate2: number;
  15054. /** @hidden */
  15055. _currentStartSizeGradient: Nullable<FactorGradient>;
  15056. /** @hidden */
  15057. _currentStartSize1: number;
  15058. /** @hidden */
  15059. _currentStartSize2: number;
  15060. private readonly _rawTextureWidth;
  15061. private _rampGradientsTexture;
  15062. private _useRampGradients;
  15063. /** Gets or sets a matrix to use to compute projection */
  15064. defaultProjectionMatrix: Matrix;
  15065. /** Gets or sets a matrix to use to compute view */
  15066. defaultViewMatrix: Matrix;
  15067. /** Gets or sets a boolean indicating that ramp gradients must be used
  15068. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  15069. */
  15070. get useRampGradients(): boolean;
  15071. set useRampGradients(value: boolean);
  15072. /**
  15073. * 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.
  15074. * 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: [])
  15075. */
  15076. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  15077. private _subEmitters;
  15078. /**
  15079. * @hidden
  15080. * If the particle systems emitter should be disposed when the particle system is disposed
  15081. */
  15082. _disposeEmitterOnDispose: boolean;
  15083. /**
  15084. * The current active Sub-systems, this property is used by the root particle system only.
  15085. */
  15086. activeSubSystems: Array<ParticleSystem>;
  15087. /**
  15088. * Specifies if the particles are updated in emitter local space or world space
  15089. */
  15090. isLocal: boolean;
  15091. private _rootParticleSystem;
  15092. /**
  15093. * Gets the current list of active particles
  15094. */
  15095. get particles(): Particle[];
  15096. /**
  15097. * Gets the number of particles active at the same time.
  15098. * @returns The number of active particles.
  15099. */
  15100. getActiveCount(): number;
  15101. /**
  15102. * Returns the string "ParticleSystem"
  15103. * @returns a string containing the class name
  15104. */
  15105. getClassName(): string;
  15106. /**
  15107. * Gets a boolean indicating that the system is stopping
  15108. * @returns true if the system is currently stopping
  15109. */
  15110. isStopping(): boolean;
  15111. /**
  15112. * Gets the custom effect used to render the particles
  15113. * @param blendMode Blend mode for which the effect should be retrieved
  15114. * @returns The effect
  15115. */
  15116. getCustomEffect(blendMode?: number): Nullable<Effect>;
  15117. /**
  15118. * Sets the custom effect used to render the particles
  15119. * @param effect The effect to set
  15120. * @param blendMode Blend mode for which the effect should be set
  15121. */
  15122. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  15123. /** @hidden */
  15124. private _onBeforeDrawParticlesObservable;
  15125. /**
  15126. * Observable that will be called just before the particles are drawn
  15127. */
  15128. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  15129. /**
  15130. * Gets the name of the particle vertex shader
  15131. */
  15132. get vertexShaderName(): string;
  15133. /**
  15134. * Instantiates a particle system.
  15135. * 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.
  15136. * @param name The name of the particle system
  15137. * @param capacity The max number of particles alive at the same time
  15138. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  15139. * @param customEffect a custom effect used to change the way particles are rendered by default
  15140. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  15141. * @param epsilon Offset used to render the particles
  15142. */
  15143. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  15144. private _addFactorGradient;
  15145. private _removeFactorGradient;
  15146. /**
  15147. * Adds a new life time gradient
  15148. * @param gradient defines the gradient to use (between 0 and 1)
  15149. * @param factor defines the life time factor to affect to the specified gradient
  15150. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  15151. * @returns the current particle system
  15152. */
  15153. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  15154. /**
  15155. * Remove a specific life time gradient
  15156. * @param gradient defines the gradient to remove
  15157. * @returns the current particle system
  15158. */
  15159. removeLifeTimeGradient(gradient: number): IParticleSystem;
  15160. /**
  15161. * Adds a new size gradient
  15162. * @param gradient defines the gradient to use (between 0 and 1)
  15163. * @param factor defines the size factor to affect to the specified gradient
  15164. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  15165. * @returns the current particle system
  15166. */
  15167. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  15168. /**
  15169. * Remove a specific size gradient
  15170. * @param gradient defines the gradient to remove
  15171. * @returns the current particle system
  15172. */
  15173. removeSizeGradient(gradient: number): IParticleSystem;
  15174. /**
  15175. * Adds a new color remap gradient
  15176. * @param gradient defines the gradient to use (between 0 and 1)
  15177. * @param min defines the color remap minimal range
  15178. * @param max defines the color remap maximal range
  15179. * @returns the current particle system
  15180. */
  15181. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  15182. /**
  15183. * Remove a specific color remap gradient
  15184. * @param gradient defines the gradient to remove
  15185. * @returns the current particle system
  15186. */
  15187. removeColorRemapGradient(gradient: number): IParticleSystem;
  15188. /**
  15189. * Adds a new alpha remap gradient
  15190. * @param gradient defines the gradient to use (between 0 and 1)
  15191. * @param min defines the alpha remap minimal range
  15192. * @param max defines the alpha remap maximal range
  15193. * @returns the current particle system
  15194. */
  15195. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  15196. /**
  15197. * Remove a specific alpha remap gradient
  15198. * @param gradient defines the gradient to remove
  15199. * @returns the current particle system
  15200. */
  15201. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  15202. /**
  15203. * Adds a new angular speed gradient
  15204. * @param gradient defines the gradient to use (between 0 and 1)
  15205. * @param factor defines the angular speed to affect to the specified gradient
  15206. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  15207. * @returns the current particle system
  15208. */
  15209. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  15210. /**
  15211. * Remove a specific angular speed gradient
  15212. * @param gradient defines the gradient to remove
  15213. * @returns the current particle system
  15214. */
  15215. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  15216. /**
  15217. * Adds a new velocity gradient
  15218. * @param gradient defines the gradient to use (between 0 and 1)
  15219. * @param factor defines the velocity to affect to the specified gradient
  15220. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  15221. * @returns the current particle system
  15222. */
  15223. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  15224. /**
  15225. * Remove a specific velocity gradient
  15226. * @param gradient defines the gradient to remove
  15227. * @returns the current particle system
  15228. */
  15229. removeVelocityGradient(gradient: number): IParticleSystem;
  15230. /**
  15231. * Adds a new limit velocity gradient
  15232. * @param gradient defines the gradient to use (between 0 and 1)
  15233. * @param factor defines the limit velocity value to affect to the specified gradient
  15234. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  15235. * @returns the current particle system
  15236. */
  15237. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  15238. /**
  15239. * Remove a specific limit velocity gradient
  15240. * @param gradient defines the gradient to remove
  15241. * @returns the current particle system
  15242. */
  15243. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  15244. /**
  15245. * Adds a new drag gradient
  15246. * @param gradient defines the gradient to use (between 0 and 1)
  15247. * @param factor defines the drag value to affect to the specified gradient
  15248. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  15249. * @returns the current particle system
  15250. */
  15251. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  15252. /**
  15253. * Remove a specific drag gradient
  15254. * @param gradient defines the gradient to remove
  15255. * @returns the current particle system
  15256. */
  15257. removeDragGradient(gradient: number): IParticleSystem;
  15258. /**
  15259. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  15260. * @param gradient defines the gradient to use (between 0 and 1)
  15261. * @param factor defines the emit rate value to affect to the specified gradient
  15262. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  15263. * @returns the current particle system
  15264. */
  15265. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  15266. /**
  15267. * Remove a specific emit rate gradient
  15268. * @param gradient defines the gradient to remove
  15269. * @returns the current particle system
  15270. */
  15271. removeEmitRateGradient(gradient: number): IParticleSystem;
  15272. /**
  15273. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  15274. * @param gradient defines the gradient to use (between 0 and 1)
  15275. * @param factor defines the start size value to affect to the specified gradient
  15276. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  15277. * @returns the current particle system
  15278. */
  15279. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  15280. /**
  15281. * Remove a specific start size gradient
  15282. * @param gradient defines the gradient to remove
  15283. * @returns the current particle system
  15284. */
  15285. removeStartSizeGradient(gradient: number): IParticleSystem;
  15286. private _createRampGradientTexture;
  15287. /**
  15288. * Gets the current list of ramp gradients.
  15289. * You must use addRampGradient and removeRampGradient to udpate this list
  15290. * @returns the list of ramp gradients
  15291. */
  15292. getRampGradients(): Nullable<Array<Color3Gradient>>;
  15293. /** Force the system to rebuild all gradients that need to be resync */
  15294. forceRefreshGradients(): void;
  15295. private _syncRampGradientTexture;
  15296. /**
  15297. * Adds a new ramp gradient used to remap particle colors
  15298. * @param gradient defines the gradient to use (between 0 and 1)
  15299. * @param color defines the color to affect to the specified gradient
  15300. * @returns the current particle system
  15301. */
  15302. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  15303. /**
  15304. * Remove a specific ramp gradient
  15305. * @param gradient defines the gradient to remove
  15306. * @returns the current particle system
  15307. */
  15308. removeRampGradient(gradient: number): ParticleSystem;
  15309. /**
  15310. * Adds a new color gradient
  15311. * @param gradient defines the gradient to use (between 0 and 1)
  15312. * @param color1 defines the color to affect to the specified gradient
  15313. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  15314. * @returns this particle system
  15315. */
  15316. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  15317. /**
  15318. * Remove a specific color gradient
  15319. * @param gradient defines the gradient to remove
  15320. * @returns this particle system
  15321. */
  15322. removeColorGradient(gradient: number): IParticleSystem;
  15323. private _fetchR;
  15324. protected _reset(): void;
  15325. private _resetEffect;
  15326. private _createVertexBuffers;
  15327. private _createIndexBuffer;
  15328. /**
  15329. * Gets the maximum number of particles active at the same time.
  15330. * @returns The max number of active particles.
  15331. */
  15332. getCapacity(): number;
  15333. /**
  15334. * Gets whether there are still active particles in the system.
  15335. * @returns True if it is alive, otherwise false.
  15336. */
  15337. isAlive(): boolean;
  15338. /**
  15339. * Gets if the system has been started. (Note: this will still be true after stop is called)
  15340. * @returns True if it has been started, otherwise false.
  15341. */
  15342. isStarted(): boolean;
  15343. private _prepareSubEmitterInternalArray;
  15344. /**
  15345. * Starts the particle system and begins to emit
  15346. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  15347. */
  15348. start(delay?: number): void;
  15349. /**
  15350. * Stops the particle system.
  15351. * @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.
  15352. */
  15353. stop(stopSubEmitters?: boolean): void;
  15354. /**
  15355. * Remove all active particles
  15356. */
  15357. reset(): void;
  15358. /**
  15359. * @hidden (for internal use only)
  15360. */
  15361. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  15362. /**
  15363. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  15364. * Its lifetime will start back at 0.
  15365. */
  15366. recycleParticle: (particle: Particle) => void;
  15367. private _stopSubEmitters;
  15368. private _createParticle;
  15369. private _removeFromRoot;
  15370. private _emitFromParticle;
  15371. private _update;
  15372. /** @hidden */
  15373. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  15374. /** @hidden */
  15375. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  15376. /**
  15377. * Fill the defines array according to the current settings of the particle system
  15378. * @param defines Array to be updated
  15379. * @param blendMode blend mode to take into account when updating the array
  15380. */
  15381. fillDefines(defines: Array<string>, blendMode: number): void;
  15382. /**
  15383. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  15384. * @param uniforms Uniforms array to fill
  15385. * @param attributes Attributes array to fill
  15386. * @param samplers Samplers array to fill
  15387. */
  15388. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  15389. /** @hidden */
  15390. private _getEffect;
  15391. /**
  15392. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  15393. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  15394. */
  15395. animate(preWarmOnly?: boolean): void;
  15396. private _appendParticleVertices;
  15397. /**
  15398. * Rebuilds the particle system.
  15399. */
  15400. rebuild(): void;
  15401. /**
  15402. * Is this system ready to be used/rendered
  15403. * @return true if the system is ready
  15404. */
  15405. isReady(): boolean;
  15406. private _render;
  15407. /**
  15408. * Renders the particle system in its current state.
  15409. * @returns the current number of particles
  15410. */
  15411. render(): number;
  15412. /**
  15413. * Disposes the particle system and free the associated resources
  15414. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  15415. */
  15416. dispose(disposeTexture?: boolean): void;
  15417. /**
  15418. * Clones the particle system.
  15419. * @param name The name of the cloned object
  15420. * @param newEmitter The new emitter to use
  15421. * @returns the cloned particle system
  15422. */
  15423. clone(name: string, newEmitter: any): ParticleSystem;
  15424. /**
  15425. * Serializes the particle system to a JSON object
  15426. * @param serializeTexture defines if the texture must be serialized as well
  15427. * @returns the JSON object
  15428. */
  15429. serialize(serializeTexture?: boolean): any;
  15430. /** @hidden */
  15431. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  15432. /** @hidden */
  15433. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  15434. /**
  15435. * Parses a JSON object to create a particle system.
  15436. * @param parsedParticleSystem The JSON object to parse
  15437. * @param sceneOrEngine The scene or the engine to create the particle system in
  15438. * @param rootUrl The root url to use to load external dependencies like texture
  15439. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  15440. * @returns the Parsed particle system
  15441. */
  15442. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  15443. }
  15444. }
  15445. declare module BABYLON {
  15446. /**
  15447. * A particle represents one of the element emitted by a particle system.
  15448. * This is mainly define by its coordinates, direction, velocity and age.
  15449. */
  15450. export class Particle {
  15451. /**
  15452. * The particle system the particle belongs to.
  15453. */
  15454. particleSystem: ParticleSystem;
  15455. private static _Count;
  15456. /**
  15457. * Unique ID of the particle
  15458. */
  15459. id: number;
  15460. /**
  15461. * The world position of the particle in the scene.
  15462. */
  15463. position: Vector3;
  15464. /**
  15465. * The world direction of the particle in the scene.
  15466. */
  15467. direction: Vector3;
  15468. /**
  15469. * The color of the particle.
  15470. */
  15471. color: Color4;
  15472. /**
  15473. * The color change of the particle per step.
  15474. */
  15475. colorStep: Color4;
  15476. /**
  15477. * Defines how long will the life of the particle be.
  15478. */
  15479. lifeTime: number;
  15480. /**
  15481. * The current age of the particle.
  15482. */
  15483. age: number;
  15484. /**
  15485. * The current size of the particle.
  15486. */
  15487. size: number;
  15488. /**
  15489. * The current scale of the particle.
  15490. */
  15491. scale: Vector2;
  15492. /**
  15493. * The current angle of the particle.
  15494. */
  15495. angle: number;
  15496. /**
  15497. * Defines how fast is the angle changing.
  15498. */
  15499. angularSpeed: number;
  15500. /**
  15501. * Defines the cell index used by the particle to be rendered from a sprite.
  15502. */
  15503. cellIndex: number;
  15504. /**
  15505. * The information required to support color remapping
  15506. */
  15507. remapData: Vector4;
  15508. /** @hidden */
  15509. _randomCellOffset?: number;
  15510. /** @hidden */
  15511. _initialDirection: Nullable<Vector3>;
  15512. /** @hidden */
  15513. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  15514. /** @hidden */
  15515. _initialStartSpriteCellID: number;
  15516. /** @hidden */
  15517. _initialEndSpriteCellID: number;
  15518. /** @hidden */
  15519. _currentColorGradient: Nullable<ColorGradient>;
  15520. /** @hidden */
  15521. _currentColor1: Color4;
  15522. /** @hidden */
  15523. _currentColor2: Color4;
  15524. /** @hidden */
  15525. _currentSizeGradient: Nullable<FactorGradient>;
  15526. /** @hidden */
  15527. _currentSize1: number;
  15528. /** @hidden */
  15529. _currentSize2: number;
  15530. /** @hidden */
  15531. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  15532. /** @hidden */
  15533. _currentAngularSpeed1: number;
  15534. /** @hidden */
  15535. _currentAngularSpeed2: number;
  15536. /** @hidden */
  15537. _currentVelocityGradient: Nullable<FactorGradient>;
  15538. /** @hidden */
  15539. _currentVelocity1: number;
  15540. /** @hidden */
  15541. _currentVelocity2: number;
  15542. /** @hidden */
  15543. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  15544. /** @hidden */
  15545. _currentLimitVelocity1: number;
  15546. /** @hidden */
  15547. _currentLimitVelocity2: number;
  15548. /** @hidden */
  15549. _currentDragGradient: Nullable<FactorGradient>;
  15550. /** @hidden */
  15551. _currentDrag1: number;
  15552. /** @hidden */
  15553. _currentDrag2: number;
  15554. /** @hidden */
  15555. _randomNoiseCoordinates1: Vector3;
  15556. /** @hidden */
  15557. _randomNoiseCoordinates2: Vector3;
  15558. /** @hidden */
  15559. _localPosition?: Vector3;
  15560. /**
  15561. * Creates a new instance Particle
  15562. * @param particleSystem the particle system the particle belongs to
  15563. */
  15564. constructor(
  15565. /**
  15566. * The particle system the particle belongs to.
  15567. */
  15568. particleSystem: ParticleSystem);
  15569. private updateCellInfoFromSystem;
  15570. /**
  15571. * Defines how the sprite cell index is updated for the particle
  15572. */
  15573. updateCellIndex(): void;
  15574. /** @hidden */
  15575. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  15576. /** @hidden */
  15577. _inheritParticleInfoToSubEmitters(): void;
  15578. /** @hidden */
  15579. _reset(): void;
  15580. /**
  15581. * Copy the properties of particle to another one.
  15582. * @param other the particle to copy the information to.
  15583. */
  15584. copyTo(other: Particle): void;
  15585. }
  15586. }
  15587. declare module BABYLON {
  15588. /**
  15589. * Particle emitter represents a volume emitting particles.
  15590. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  15591. */
  15592. export interface IParticleEmitterType {
  15593. /**
  15594. * Called by the particle System when the direction is computed for the created particle.
  15595. * @param worldMatrix is the world matrix of the particle system
  15596. * @param directionToUpdate is the direction vector to update with the result
  15597. * @param particle is the particle we are computed the direction for
  15598. * @param isLocal defines if the direction should be set in local space
  15599. */
  15600. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  15601. /**
  15602. * Called by the particle System when the position is computed for the created particle.
  15603. * @param worldMatrix is the world matrix of the particle system
  15604. * @param positionToUpdate is the position vector to update with the result
  15605. * @param particle is the particle we are computed the position for
  15606. * @param isLocal defines if the position should be set in local space
  15607. */
  15608. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  15609. /**
  15610. * Clones the current emitter and returns a copy of it
  15611. * @returns the new emitter
  15612. */
  15613. clone(): IParticleEmitterType;
  15614. /**
  15615. * Called by the GPUParticleSystem to setup the update shader
  15616. * @param effect defines the update shader
  15617. */
  15618. applyToShader(effect: Effect): void;
  15619. /**
  15620. * Returns a string to use to update the GPU particles update shader
  15621. * @returns the effect defines string
  15622. */
  15623. getEffectDefines(): string;
  15624. /**
  15625. * Returns a string representing the class name
  15626. * @returns a string containing the class name
  15627. */
  15628. getClassName(): string;
  15629. /**
  15630. * Serializes the particle system to a JSON object.
  15631. * @returns the JSON object
  15632. */
  15633. serialize(): any;
  15634. /**
  15635. * Parse properties from a JSON object
  15636. * @param serializationObject defines the JSON object
  15637. * @param scene defines the hosting scene
  15638. */
  15639. parse(serializationObject: any, scene: Nullable<Scene>): void;
  15640. }
  15641. }
  15642. declare module BABYLON {
  15643. /**
  15644. * Particle emitter emitting particles from the inside of a box.
  15645. * It emits the particles randomly between 2 given directions.
  15646. */
  15647. export class BoxParticleEmitter implements IParticleEmitterType {
  15648. /**
  15649. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  15650. */
  15651. direction1: Vector3;
  15652. /**
  15653. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  15654. */
  15655. direction2: Vector3;
  15656. /**
  15657. * 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.
  15658. */
  15659. minEmitBox: Vector3;
  15660. /**
  15661. * 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.
  15662. */
  15663. maxEmitBox: Vector3;
  15664. /**
  15665. * Creates a new instance BoxParticleEmitter
  15666. */
  15667. constructor();
  15668. /**
  15669. * Called by the particle System when the direction is computed for the created particle.
  15670. * @param worldMatrix is the world matrix of the particle system
  15671. * @param directionToUpdate is the direction vector to update with the result
  15672. * @param particle is the particle we are computed the direction for
  15673. * @param isLocal defines if the direction should be set in local space
  15674. */
  15675. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  15676. /**
  15677. * Called by the particle System when the position is computed for the created particle.
  15678. * @param worldMatrix is the world matrix of the particle system
  15679. * @param positionToUpdate is the position vector to update with the result
  15680. * @param particle is the particle we are computed the position for
  15681. * @param isLocal defines if the position should be set in local space
  15682. */
  15683. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  15684. /**
  15685. * Clones the current emitter and returns a copy of it
  15686. * @returns the new emitter
  15687. */
  15688. clone(): BoxParticleEmitter;
  15689. /**
  15690. * Called by the GPUParticleSystem to setup the update shader
  15691. * @param effect defines the update shader
  15692. */
  15693. applyToShader(effect: Effect): void;
  15694. /**
  15695. * Returns a string to use to update the GPU particles update shader
  15696. * @returns a string containng the defines string
  15697. */
  15698. getEffectDefines(): string;
  15699. /**
  15700. * Returns the string "BoxParticleEmitter"
  15701. * @returns a string containing the class name
  15702. */
  15703. getClassName(): string;
  15704. /**
  15705. * Serializes the particle system to a JSON object.
  15706. * @returns the JSON object
  15707. */
  15708. serialize(): any;
  15709. /**
  15710. * Parse properties from a JSON object
  15711. * @param serializationObject defines the JSON object
  15712. */
  15713. parse(serializationObject: any): void;
  15714. }
  15715. }
  15716. declare module BABYLON {
  15717. /**
  15718. * Particle emitter emitting particles from the inside of a cone.
  15719. * It emits the particles alongside the cone volume from the base to the particle.
  15720. * The emission direction might be randomized.
  15721. */
  15722. export class ConeParticleEmitter implements IParticleEmitterType {
  15723. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  15724. directionRandomizer: number;
  15725. private _radius;
  15726. private _angle;
  15727. private _height;
  15728. /**
  15729. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  15730. */
  15731. radiusRange: number;
  15732. /**
  15733. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  15734. */
  15735. heightRange: number;
  15736. /**
  15737. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  15738. */
  15739. emitFromSpawnPointOnly: boolean;
  15740. /**
  15741. * Gets or sets the radius of the emission cone
  15742. */
  15743. get radius(): number;
  15744. set radius(value: number);
  15745. /**
  15746. * Gets or sets the angle of the emission cone
  15747. */
  15748. get angle(): number;
  15749. set angle(value: number);
  15750. private _buildHeight;
  15751. /**
  15752. * Creates a new instance ConeParticleEmitter
  15753. * @param radius the radius of the emission cone (1 by default)
  15754. * @param angle the cone base angle (PI by default)
  15755. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  15756. */
  15757. constructor(radius?: number, angle?: number,
  15758. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  15759. directionRandomizer?: number);
  15760. /**
  15761. * Called by the particle System when the direction is computed for the created particle.
  15762. * @param worldMatrix is the world matrix of the particle system
  15763. * @param directionToUpdate is the direction vector to update with the result
  15764. * @param particle is the particle we are computed the direction for
  15765. * @param isLocal defines if the direction should be set in local space
  15766. */
  15767. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  15768. /**
  15769. * Called by the particle System when the position is computed for the created particle.
  15770. * @param worldMatrix is the world matrix of the particle system
  15771. * @param positionToUpdate is the position vector to update with the result
  15772. * @param particle is the particle we are computed the position for
  15773. * @param isLocal defines if the position should be set in local space
  15774. */
  15775. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  15776. /**
  15777. * Clones the current emitter and returns a copy of it
  15778. * @returns the new emitter
  15779. */
  15780. clone(): ConeParticleEmitter;
  15781. /**
  15782. * Called by the GPUParticleSystem to setup the update shader
  15783. * @param effect defines the update shader
  15784. */
  15785. applyToShader(effect: Effect): void;
  15786. /**
  15787. * Returns a string to use to update the GPU particles update shader
  15788. * @returns a string containng the defines string
  15789. */
  15790. getEffectDefines(): string;
  15791. /**
  15792. * Returns the string "ConeParticleEmitter"
  15793. * @returns a string containing the class name
  15794. */
  15795. getClassName(): string;
  15796. /**
  15797. * Serializes the particle system to a JSON object.
  15798. * @returns the JSON object
  15799. */
  15800. serialize(): any;
  15801. /**
  15802. * Parse properties from a JSON object
  15803. * @param serializationObject defines the JSON object
  15804. */
  15805. parse(serializationObject: any): void;
  15806. }
  15807. }
  15808. declare module BABYLON {
  15809. /**
  15810. * Particle emitter emitting particles from the inside of a cylinder.
  15811. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  15812. */
  15813. export class CylinderParticleEmitter implements IParticleEmitterType {
  15814. /**
  15815. * The radius of the emission cylinder.
  15816. */
  15817. radius: number;
  15818. /**
  15819. * The height of the emission cylinder.
  15820. */
  15821. height: number;
  15822. /**
  15823. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  15824. */
  15825. radiusRange: number;
  15826. /**
  15827. * How much to randomize the particle direction [0-1].
  15828. */
  15829. directionRandomizer: number;
  15830. /**
  15831. * Creates a new instance CylinderParticleEmitter
  15832. * @param radius the radius of the emission cylinder (1 by default)
  15833. * @param height the height of the emission cylinder (1 by default)
  15834. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  15835. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  15836. */
  15837. constructor(
  15838. /**
  15839. * The radius of the emission cylinder.
  15840. */
  15841. radius?: number,
  15842. /**
  15843. * The height of the emission cylinder.
  15844. */
  15845. height?: number,
  15846. /**
  15847. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  15848. */
  15849. radiusRange?: number,
  15850. /**
  15851. * How much to randomize the particle direction [0-1].
  15852. */
  15853. directionRandomizer?: number);
  15854. /**
  15855. * Called by the particle System when the direction is computed for the created particle.
  15856. * @param worldMatrix is the world matrix of the particle system
  15857. * @param directionToUpdate is the direction vector to update with the result
  15858. * @param particle is the particle we are computed the direction for
  15859. * @param isLocal defines if the direction should be set in local space
  15860. */
  15861. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  15862. /**
  15863. * Called by the particle System when the position is computed for the created particle.
  15864. * @param worldMatrix is the world matrix of the particle system
  15865. * @param positionToUpdate is the position vector to update with the result
  15866. * @param particle is the particle we are computed the position for
  15867. * @param isLocal defines if the position should be set in local space
  15868. */
  15869. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  15870. /**
  15871. * Clones the current emitter and returns a copy of it
  15872. * @returns the new emitter
  15873. */
  15874. clone(): CylinderParticleEmitter;
  15875. /**
  15876. * Called by the GPUParticleSystem to setup the update shader
  15877. * @param effect defines the update shader
  15878. */
  15879. applyToShader(effect: Effect): void;
  15880. /**
  15881. * Returns a string to use to update the GPU particles update shader
  15882. * @returns a string containng the defines string
  15883. */
  15884. getEffectDefines(): string;
  15885. /**
  15886. * Returns the string "CylinderParticleEmitter"
  15887. * @returns a string containing the class name
  15888. */
  15889. getClassName(): string;
  15890. /**
  15891. * Serializes the particle system to a JSON object.
  15892. * @returns the JSON object
  15893. */
  15894. serialize(): any;
  15895. /**
  15896. * Parse properties from a JSON object
  15897. * @param serializationObject defines the JSON object
  15898. */
  15899. parse(serializationObject: any): void;
  15900. }
  15901. /**
  15902. * Particle emitter emitting particles from the inside of a cylinder.
  15903. * It emits the particles randomly between two vectors.
  15904. */
  15905. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  15906. /**
  15907. * The min limit of the emission direction.
  15908. */
  15909. direction1: Vector3;
  15910. /**
  15911. * The max limit of the emission direction.
  15912. */
  15913. direction2: Vector3;
  15914. /**
  15915. * Creates a new instance CylinderDirectedParticleEmitter
  15916. * @param radius the radius of the emission cylinder (1 by default)
  15917. * @param height the height of the emission cylinder (1 by default)
  15918. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  15919. * @param direction1 the min limit of the emission direction (up vector by default)
  15920. * @param direction2 the max limit of the emission direction (up vector by default)
  15921. */
  15922. constructor(radius?: number, height?: number, radiusRange?: number,
  15923. /**
  15924. * The min limit of the emission direction.
  15925. */
  15926. direction1?: Vector3,
  15927. /**
  15928. * The max limit of the emission direction.
  15929. */
  15930. direction2?: Vector3);
  15931. /**
  15932. * Called by the particle System when the direction is computed for the created particle.
  15933. * @param worldMatrix is the world matrix of the particle system
  15934. * @param directionToUpdate is the direction vector to update with the result
  15935. * @param particle is the particle we are computed the direction for
  15936. */
  15937. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  15938. /**
  15939. * Clones the current emitter and returns a copy of it
  15940. * @returns the new emitter
  15941. */
  15942. clone(): CylinderDirectedParticleEmitter;
  15943. /**
  15944. * Called by the GPUParticleSystem to setup the update shader
  15945. * @param effect defines the update shader
  15946. */
  15947. applyToShader(effect: Effect): void;
  15948. /**
  15949. * Returns a string to use to update the GPU particles update shader
  15950. * @returns a string containng the defines string
  15951. */
  15952. getEffectDefines(): string;
  15953. /**
  15954. * Returns the string "CylinderDirectedParticleEmitter"
  15955. * @returns a string containing the class name
  15956. */
  15957. getClassName(): string;
  15958. /**
  15959. * Serializes the particle system to a JSON object.
  15960. * @returns the JSON object
  15961. */
  15962. serialize(): any;
  15963. /**
  15964. * Parse properties from a JSON object
  15965. * @param serializationObject defines the JSON object
  15966. */
  15967. parse(serializationObject: any): void;
  15968. }
  15969. }
  15970. declare module BABYLON {
  15971. /**
  15972. * Particle emitter emitting particles from the inside of a hemisphere.
  15973. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  15974. */
  15975. export class HemisphericParticleEmitter implements IParticleEmitterType {
  15976. /**
  15977. * The radius of the emission hemisphere.
  15978. */
  15979. radius: number;
  15980. /**
  15981. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  15982. */
  15983. radiusRange: number;
  15984. /**
  15985. * How much to randomize the particle direction [0-1].
  15986. */
  15987. directionRandomizer: number;
  15988. /**
  15989. * Creates a new instance HemisphericParticleEmitter
  15990. * @param radius the radius of the emission hemisphere (1 by default)
  15991. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  15992. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  15993. */
  15994. constructor(
  15995. /**
  15996. * The radius of the emission hemisphere.
  15997. */
  15998. radius?: number,
  15999. /**
  16000. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  16001. */
  16002. radiusRange?: number,
  16003. /**
  16004. * How much to randomize the particle direction [0-1].
  16005. */
  16006. directionRandomizer?: number);
  16007. /**
  16008. * Called by the particle System when the direction is computed for the created particle.
  16009. * @param worldMatrix is the world matrix of the particle system
  16010. * @param directionToUpdate is the direction vector to update with the result
  16011. * @param particle is the particle we are computed the direction for
  16012. * @param isLocal defines if the direction should be set in local space
  16013. */
  16014. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  16015. /**
  16016. * Called by the particle System when the position is computed for the created particle.
  16017. * @param worldMatrix is the world matrix of the particle system
  16018. * @param positionToUpdate is the position vector to update with the result
  16019. * @param particle is the particle we are computed the position for
  16020. * @param isLocal defines if the position should be set in local space
  16021. */
  16022. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  16023. /**
  16024. * Clones the current emitter and returns a copy of it
  16025. * @returns the new emitter
  16026. */
  16027. clone(): HemisphericParticleEmitter;
  16028. /**
  16029. * Called by the GPUParticleSystem to setup the update shader
  16030. * @param effect defines the update shader
  16031. */
  16032. applyToShader(effect: Effect): void;
  16033. /**
  16034. * Returns a string to use to update the GPU particles update shader
  16035. * @returns a string containng the defines string
  16036. */
  16037. getEffectDefines(): string;
  16038. /**
  16039. * Returns the string "HemisphericParticleEmitter"
  16040. * @returns a string containing the class name
  16041. */
  16042. getClassName(): string;
  16043. /**
  16044. * Serializes the particle system to a JSON object.
  16045. * @returns the JSON object
  16046. */
  16047. serialize(): any;
  16048. /**
  16049. * Parse properties from a JSON object
  16050. * @param serializationObject defines the JSON object
  16051. */
  16052. parse(serializationObject: any): void;
  16053. }
  16054. }
  16055. declare module BABYLON {
  16056. /**
  16057. * Particle emitter emitting particles from a point.
  16058. * It emits the particles randomly between 2 given directions.
  16059. */
  16060. export class PointParticleEmitter implements IParticleEmitterType {
  16061. /**
  16062. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  16063. */
  16064. direction1: Vector3;
  16065. /**
  16066. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  16067. */
  16068. direction2: Vector3;
  16069. /**
  16070. * Creates a new instance PointParticleEmitter
  16071. */
  16072. constructor();
  16073. /**
  16074. * Called by the particle System when the direction is computed for the created particle.
  16075. * @param worldMatrix is the world matrix of the particle system
  16076. * @param directionToUpdate is the direction vector to update with the result
  16077. * @param particle is the particle we are computed the direction for
  16078. * @param isLocal defines if the direction should be set in local space
  16079. */
  16080. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  16081. /**
  16082. * Called by the particle System when the position is computed for the created particle.
  16083. * @param worldMatrix is the world matrix of the particle system
  16084. * @param positionToUpdate is the position vector to update with the result
  16085. * @param particle is the particle we are computed the position for
  16086. * @param isLocal defines if the position should be set in local space
  16087. */
  16088. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  16089. /**
  16090. * Clones the current emitter and returns a copy of it
  16091. * @returns the new emitter
  16092. */
  16093. clone(): PointParticleEmitter;
  16094. /**
  16095. * Called by the GPUParticleSystem to setup the update shader
  16096. * @param effect defines the update shader
  16097. */
  16098. applyToShader(effect: Effect): void;
  16099. /**
  16100. * Returns a string to use to update the GPU particles update shader
  16101. * @returns a string containng the defines string
  16102. */
  16103. getEffectDefines(): string;
  16104. /**
  16105. * Returns the string "PointParticleEmitter"
  16106. * @returns a string containing the class name
  16107. */
  16108. getClassName(): string;
  16109. /**
  16110. * Serializes the particle system to a JSON object.
  16111. * @returns the JSON object
  16112. */
  16113. serialize(): any;
  16114. /**
  16115. * Parse properties from a JSON object
  16116. * @param serializationObject defines the JSON object
  16117. */
  16118. parse(serializationObject: any): void;
  16119. }
  16120. }
  16121. declare module BABYLON {
  16122. /**
  16123. * Particle emitter emitting particles from the inside of a sphere.
  16124. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  16125. */
  16126. export class SphereParticleEmitter implements IParticleEmitterType {
  16127. /**
  16128. * The radius of the emission sphere.
  16129. */
  16130. radius: number;
  16131. /**
  16132. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  16133. */
  16134. radiusRange: number;
  16135. /**
  16136. * How much to randomize the particle direction [0-1].
  16137. */
  16138. directionRandomizer: number;
  16139. /**
  16140. * Creates a new instance SphereParticleEmitter
  16141. * @param radius the radius of the emission sphere (1 by default)
  16142. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  16143. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  16144. */
  16145. constructor(
  16146. /**
  16147. * The radius of the emission sphere.
  16148. */
  16149. radius?: number,
  16150. /**
  16151. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  16152. */
  16153. radiusRange?: number,
  16154. /**
  16155. * How much to randomize the particle direction [0-1].
  16156. */
  16157. directionRandomizer?: number);
  16158. /**
  16159. * Called by the particle System when the direction is computed for the created particle.
  16160. * @param worldMatrix is the world matrix of the particle system
  16161. * @param directionToUpdate is the direction vector to update with the result
  16162. * @param particle is the particle we are computed the direction for
  16163. * @param isLocal defines if the direction should be set in local space
  16164. */
  16165. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  16166. /**
  16167. * Called by the particle System when the position is computed for the created particle.
  16168. * @param worldMatrix is the world matrix of the particle system
  16169. * @param positionToUpdate is the position vector to update with the result
  16170. * @param particle is the particle we are computed the position for
  16171. * @param isLocal defines if the position should be set in local space
  16172. */
  16173. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  16174. /**
  16175. * Clones the current emitter and returns a copy of it
  16176. * @returns the new emitter
  16177. */
  16178. clone(): SphereParticleEmitter;
  16179. /**
  16180. * Called by the GPUParticleSystem to setup the update shader
  16181. * @param effect defines the update shader
  16182. */
  16183. applyToShader(effect: Effect): void;
  16184. /**
  16185. * Returns a string to use to update the GPU particles update shader
  16186. * @returns a string containng the defines string
  16187. */
  16188. getEffectDefines(): string;
  16189. /**
  16190. * Returns the string "SphereParticleEmitter"
  16191. * @returns a string containing the class name
  16192. */
  16193. getClassName(): string;
  16194. /**
  16195. * Serializes the particle system to a JSON object.
  16196. * @returns the JSON object
  16197. */
  16198. serialize(): any;
  16199. /**
  16200. * Parse properties from a JSON object
  16201. * @param serializationObject defines the JSON object
  16202. */
  16203. parse(serializationObject: any): void;
  16204. }
  16205. /**
  16206. * Particle emitter emitting particles from the inside of a sphere.
  16207. * It emits the particles randomly between two vectors.
  16208. */
  16209. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  16210. /**
  16211. * The min limit of the emission direction.
  16212. */
  16213. direction1: Vector3;
  16214. /**
  16215. * The max limit of the emission direction.
  16216. */
  16217. direction2: Vector3;
  16218. /**
  16219. * Creates a new instance SphereDirectedParticleEmitter
  16220. * @param radius the radius of the emission sphere (1 by default)
  16221. * @param direction1 the min limit of the emission direction (up vector by default)
  16222. * @param direction2 the max limit of the emission direction (up vector by default)
  16223. */
  16224. constructor(radius?: number,
  16225. /**
  16226. * The min limit of the emission direction.
  16227. */
  16228. direction1?: Vector3,
  16229. /**
  16230. * The max limit of the emission direction.
  16231. */
  16232. direction2?: Vector3);
  16233. /**
  16234. * Called by the particle System when the direction is computed for the created particle.
  16235. * @param worldMatrix is the world matrix of the particle system
  16236. * @param directionToUpdate is the direction vector to update with the result
  16237. * @param particle is the particle we are computed the direction for
  16238. */
  16239. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  16240. /**
  16241. * Clones the current emitter and returns a copy of it
  16242. * @returns the new emitter
  16243. */
  16244. clone(): SphereDirectedParticleEmitter;
  16245. /**
  16246. * Called by the GPUParticleSystem to setup the update shader
  16247. * @param effect defines the update shader
  16248. */
  16249. applyToShader(effect: Effect): void;
  16250. /**
  16251. * Returns a string to use to update the GPU particles update shader
  16252. * @returns a string containng the defines string
  16253. */
  16254. getEffectDefines(): string;
  16255. /**
  16256. * Returns the string "SphereDirectedParticleEmitter"
  16257. * @returns a string containing the class name
  16258. */
  16259. getClassName(): string;
  16260. /**
  16261. * Serializes the particle system to a JSON object.
  16262. * @returns the JSON object
  16263. */
  16264. serialize(): any;
  16265. /**
  16266. * Parse properties from a JSON object
  16267. * @param serializationObject defines the JSON object
  16268. */
  16269. parse(serializationObject: any): void;
  16270. }
  16271. }
  16272. declare module BABYLON {
  16273. /**
  16274. * Particle emitter emitting particles from a custom list of positions.
  16275. */
  16276. export class CustomParticleEmitter implements IParticleEmitterType {
  16277. /**
  16278. * Gets or sets the position generator that will create the inital position of each particle.
  16279. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  16280. */
  16281. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  16282. /**
  16283. * Gets or sets the destination generator that will create the final destination of each particle.
  16284. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  16285. */
  16286. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  16287. /**
  16288. * Creates a new instance CustomParticleEmitter
  16289. */
  16290. constructor();
  16291. /**
  16292. * Called by the particle System when the direction is computed for the created particle.
  16293. * @param worldMatrix is the world matrix of the particle system
  16294. * @param directionToUpdate is the direction vector to update with the result
  16295. * @param particle is the particle we are computed the direction for
  16296. * @param isLocal defines if the direction should be set in local space
  16297. */
  16298. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  16299. /**
  16300. * Called by the particle System when the position is computed for the created particle.
  16301. * @param worldMatrix is the world matrix of the particle system
  16302. * @param positionToUpdate is the position vector to update with the result
  16303. * @param particle is the particle we are computed the position for
  16304. * @param isLocal defines if the position should be set in local space
  16305. */
  16306. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  16307. /**
  16308. * Clones the current emitter and returns a copy of it
  16309. * @returns the new emitter
  16310. */
  16311. clone(): CustomParticleEmitter;
  16312. /**
  16313. * Called by the GPUParticleSystem to setup the update shader
  16314. * @param effect defines the update shader
  16315. */
  16316. applyToShader(effect: Effect): void;
  16317. /**
  16318. * Returns a string to use to update the GPU particles update shader
  16319. * @returns a string containng the defines string
  16320. */
  16321. getEffectDefines(): string;
  16322. /**
  16323. * Returns the string "PointParticleEmitter"
  16324. * @returns a string containing the class name
  16325. */
  16326. getClassName(): string;
  16327. /**
  16328. * Serializes the particle system to a JSON object.
  16329. * @returns the JSON object
  16330. */
  16331. serialize(): any;
  16332. /**
  16333. * Parse properties from a JSON object
  16334. * @param serializationObject defines the JSON object
  16335. */
  16336. parse(serializationObject: any): void;
  16337. }
  16338. }
  16339. declare module BABYLON {
  16340. /**
  16341. * Particle emitter emitting particles from the inside of a box.
  16342. * It emits the particles randomly between 2 given directions.
  16343. */
  16344. export class MeshParticleEmitter implements IParticleEmitterType {
  16345. private _indices;
  16346. private _positions;
  16347. private _normals;
  16348. private _storedNormal;
  16349. private _mesh;
  16350. /**
  16351. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  16352. */
  16353. direction1: Vector3;
  16354. /**
  16355. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  16356. */
  16357. direction2: Vector3;
  16358. /**
  16359. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  16360. */
  16361. useMeshNormalsForDirection: boolean;
  16362. /** Defines the mesh to use as source */
  16363. get mesh(): Nullable<AbstractMesh>;
  16364. set mesh(value: Nullable<AbstractMesh>);
  16365. /**
  16366. * Creates a new instance MeshParticleEmitter
  16367. * @param mesh defines the mesh to use as source
  16368. */
  16369. constructor(mesh?: Nullable<AbstractMesh>);
  16370. /**
  16371. * Called by the particle System when the direction is computed for the created particle.
  16372. * @param worldMatrix is the world matrix of the particle system
  16373. * @param directionToUpdate is the direction vector to update with the result
  16374. * @param particle is the particle we are computed the direction for
  16375. * @param isLocal defines if the direction should be set in local space
  16376. */
  16377. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  16378. /**
  16379. * Called by the particle System when the position is computed for the created particle.
  16380. * @param worldMatrix is the world matrix of the particle system
  16381. * @param positionToUpdate is the position vector to update with the result
  16382. * @param particle is the particle we are computed the position for
  16383. * @param isLocal defines if the position should be set in local space
  16384. */
  16385. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  16386. /**
  16387. * Clones the current emitter and returns a copy of it
  16388. * @returns the new emitter
  16389. */
  16390. clone(): MeshParticleEmitter;
  16391. /**
  16392. * Called by the GPUParticleSystem to setup the update shader
  16393. * @param effect defines the update shader
  16394. */
  16395. applyToShader(effect: Effect): void;
  16396. /**
  16397. * Returns a string to use to update the GPU particles update shader
  16398. * @returns a string containng the defines string
  16399. */
  16400. getEffectDefines(): string;
  16401. /**
  16402. * Returns the string "BoxParticleEmitter"
  16403. * @returns a string containing the class name
  16404. */
  16405. getClassName(): string;
  16406. /**
  16407. * Serializes the particle system to a JSON object.
  16408. * @returns the JSON object
  16409. */
  16410. serialize(): any;
  16411. /**
  16412. * Parse properties from a JSON object
  16413. * @param serializationObject defines the JSON object
  16414. * @param scene defines the hosting scene
  16415. */
  16416. parse(serializationObject: any, scene: Nullable<Scene>): void;
  16417. }
  16418. }
  16419. declare module BABYLON {
  16420. /**
  16421. * Interface representing a particle system in Babylon.js.
  16422. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  16423. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  16424. */
  16425. export interface IParticleSystem {
  16426. /**
  16427. * List of animations used by the particle system.
  16428. */
  16429. animations: Animation[];
  16430. /**
  16431. * The id of the Particle system.
  16432. */
  16433. id: string;
  16434. /**
  16435. * The name of the Particle system.
  16436. */
  16437. name: string;
  16438. /**
  16439. * The emitter represents the Mesh or position we are attaching the particle system to.
  16440. */
  16441. emitter: Nullable<AbstractMesh | Vector3>;
  16442. /**
  16443. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  16444. */
  16445. isBillboardBased: boolean;
  16446. /**
  16447. * The rendering group used by the Particle system to chose when to render.
  16448. */
  16449. renderingGroupId: number;
  16450. /**
  16451. * The layer mask we are rendering the particles through.
  16452. */
  16453. layerMask: number;
  16454. /**
  16455. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  16456. */
  16457. updateSpeed: number;
  16458. /**
  16459. * The amount of time the particle system is running (depends of the overall update speed).
  16460. */
  16461. targetStopDuration: number;
  16462. /**
  16463. * The texture used to render each particle. (this can be a spritesheet)
  16464. */
  16465. particleTexture: Nullable<BaseTexture>;
  16466. /**
  16467. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  16468. */
  16469. blendMode: number;
  16470. /**
  16471. * Minimum life time of emitting particles.
  16472. */
  16473. minLifeTime: number;
  16474. /**
  16475. * Maximum life time of emitting particles.
  16476. */
  16477. maxLifeTime: number;
  16478. /**
  16479. * Minimum Size of emitting particles.
  16480. */
  16481. minSize: number;
  16482. /**
  16483. * Maximum Size of emitting particles.
  16484. */
  16485. maxSize: number;
  16486. /**
  16487. * Minimum scale of emitting particles on X axis.
  16488. */
  16489. minScaleX: number;
  16490. /**
  16491. * Maximum scale of emitting particles on X axis.
  16492. */
  16493. maxScaleX: number;
  16494. /**
  16495. * Minimum scale of emitting particles on Y axis.
  16496. */
  16497. minScaleY: number;
  16498. /**
  16499. * Maximum scale of emitting particles on Y axis.
  16500. */
  16501. maxScaleY: number;
  16502. /**
  16503. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  16504. */
  16505. color1: Color4;
  16506. /**
  16507. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  16508. */
  16509. color2: Color4;
  16510. /**
  16511. * Color the particle will have at the end of its lifetime.
  16512. */
  16513. colorDead: Color4;
  16514. /**
  16515. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  16516. */
  16517. emitRate: number;
  16518. /**
  16519. * You can use gravity if you want to give an orientation to your particles.
  16520. */
  16521. gravity: Vector3;
  16522. /**
  16523. * Minimum power of emitting particles.
  16524. */
  16525. minEmitPower: number;
  16526. /**
  16527. * Maximum power of emitting particles.
  16528. */
  16529. maxEmitPower: number;
  16530. /**
  16531. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  16532. */
  16533. minAngularSpeed: number;
  16534. /**
  16535. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  16536. */
  16537. maxAngularSpeed: number;
  16538. /**
  16539. * Gets or sets the minimal initial rotation in radians.
  16540. */
  16541. minInitialRotation: number;
  16542. /**
  16543. * Gets or sets the maximal initial rotation in radians.
  16544. */
  16545. maxInitialRotation: number;
  16546. /**
  16547. * The particle emitter type defines the emitter used by the particle system.
  16548. * It can be for example box, sphere, or cone...
  16549. */
  16550. particleEmitterType: Nullable<IParticleEmitterType>;
  16551. /**
  16552. * Defines the delay in milliseconds before starting the system (0 by default)
  16553. */
  16554. startDelay: number;
  16555. /**
  16556. * 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
  16557. */
  16558. preWarmCycles: number;
  16559. /**
  16560. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  16561. */
  16562. preWarmStepOffset: number;
  16563. /**
  16564. * 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)
  16565. */
  16566. spriteCellChangeSpeed: number;
  16567. /**
  16568. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  16569. */
  16570. startSpriteCellID: number;
  16571. /**
  16572. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  16573. */
  16574. endSpriteCellID: number;
  16575. /**
  16576. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  16577. */
  16578. spriteCellWidth: number;
  16579. /**
  16580. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  16581. */
  16582. spriteCellHeight: number;
  16583. /**
  16584. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  16585. */
  16586. spriteRandomStartCell: boolean;
  16587. /**
  16588. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  16589. */
  16590. isAnimationSheetEnabled: boolean;
  16591. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  16592. translationPivot: Vector2;
  16593. /**
  16594. * Gets or sets a texture used to add random noise to particle positions
  16595. */
  16596. noiseTexture: Nullable<BaseTexture>;
  16597. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  16598. noiseStrength: Vector3;
  16599. /**
  16600. * Gets or sets the billboard mode to use when isBillboardBased = true.
  16601. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  16602. */
  16603. billboardMode: number;
  16604. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  16605. limitVelocityDamping: number;
  16606. /**
  16607. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  16608. */
  16609. beginAnimationOnStart: boolean;
  16610. /**
  16611. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  16612. */
  16613. beginAnimationFrom: number;
  16614. /**
  16615. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  16616. */
  16617. beginAnimationTo: number;
  16618. /**
  16619. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  16620. */
  16621. beginAnimationLoop: boolean;
  16622. /**
  16623. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  16624. */
  16625. disposeOnStop: boolean;
  16626. /**
  16627. * Specifies if the particles are updated in emitter local space or world space
  16628. */
  16629. isLocal: boolean;
  16630. /** Snippet ID if the particle system was created from the snippet server */
  16631. snippetId: string;
  16632. /** Gets or sets a matrix to use to compute projection */
  16633. defaultProjectionMatrix: Matrix;
  16634. /**
  16635. * Gets the maximum number of particles active at the same time.
  16636. * @returns The max number of active particles.
  16637. */
  16638. getCapacity(): number;
  16639. /**
  16640. * Gets the number of particles active at the same time.
  16641. * @returns The number of active particles.
  16642. */
  16643. getActiveCount(): number;
  16644. /**
  16645. * Gets if the system has been started. (Note: this will still be true after stop is called)
  16646. * @returns True if it has been started, otherwise false.
  16647. */
  16648. isStarted(): boolean;
  16649. /**
  16650. * Animates the particle system for this frame.
  16651. */
  16652. animate(): void;
  16653. /**
  16654. * Renders the particle system in its current state.
  16655. * @returns the current number of particles
  16656. */
  16657. render(): number;
  16658. /**
  16659. * Dispose the particle system and frees its associated resources.
  16660. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  16661. */
  16662. dispose(disposeTexture?: boolean): void;
  16663. /**
  16664. * An event triggered when the system is disposed
  16665. */
  16666. onDisposeObservable: Observable<IParticleSystem>;
  16667. /**
  16668. * An event triggered when the system is stopped
  16669. */
  16670. onStoppedObservable: Observable<IParticleSystem>;
  16671. /**
  16672. * Clones the particle system.
  16673. * @param name The name of the cloned object
  16674. * @param newEmitter The new emitter to use
  16675. * @returns the cloned particle system
  16676. */
  16677. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  16678. /**
  16679. * Serializes the particle system to a JSON object
  16680. * @param serializeTexture defines if the texture must be serialized as well
  16681. * @returns the JSON object
  16682. */
  16683. serialize(serializeTexture: boolean): any;
  16684. /**
  16685. * Rebuild the particle system
  16686. */
  16687. rebuild(): void;
  16688. /** Force the system to rebuild all gradients that need to be resync */
  16689. forceRefreshGradients(): void;
  16690. /**
  16691. * Starts the particle system and begins to emit
  16692. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  16693. */
  16694. start(delay?: number): void;
  16695. /**
  16696. * Stops the particle system.
  16697. */
  16698. stop(): void;
  16699. /**
  16700. * Remove all active particles
  16701. */
  16702. reset(): void;
  16703. /**
  16704. * Gets a boolean indicating that the system is stopping
  16705. * @returns true if the system is currently stopping
  16706. */
  16707. isStopping(): boolean;
  16708. /**
  16709. * Is this system ready to be used/rendered
  16710. * @return true if the system is ready
  16711. */
  16712. isReady(): boolean;
  16713. /**
  16714. * Returns the string "ParticleSystem"
  16715. * @returns a string containing the class name
  16716. */
  16717. getClassName(): string;
  16718. /**
  16719. * Gets the custom effect used to render the particles
  16720. * @param blendMode Blend mode for which the effect should be retrieved
  16721. * @returns The effect
  16722. */
  16723. getCustomEffect(blendMode: number): Nullable<Effect>;
  16724. /**
  16725. * Sets the custom effect used to render the particles
  16726. * @param effect The effect to set
  16727. * @param blendMode Blend mode for which the effect should be set
  16728. */
  16729. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  16730. /**
  16731. * Fill the defines array according to the current settings of the particle system
  16732. * @param defines Array to be updated
  16733. * @param blendMode blend mode to take into account when updating the array
  16734. */
  16735. fillDefines(defines: Array<string>, blendMode: number): void;
  16736. /**
  16737. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  16738. * @param uniforms Uniforms array to fill
  16739. * @param attributes Attributes array to fill
  16740. * @param samplers Samplers array to fill
  16741. */
  16742. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  16743. /**
  16744. * Observable that will be called just before the particles are drawn
  16745. */
  16746. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  16747. /**
  16748. * Gets the name of the particle vertex shader
  16749. */
  16750. vertexShaderName: string;
  16751. /**
  16752. * Adds a new color gradient
  16753. * @param gradient defines the gradient to use (between 0 and 1)
  16754. * @param color1 defines the color to affect to the specified gradient
  16755. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  16756. * @returns the current particle system
  16757. */
  16758. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  16759. /**
  16760. * Remove a specific color gradient
  16761. * @param gradient defines the gradient to remove
  16762. * @returns the current particle system
  16763. */
  16764. removeColorGradient(gradient: number): IParticleSystem;
  16765. /**
  16766. * Adds a new size gradient
  16767. * @param gradient defines the gradient to use (between 0 and 1)
  16768. * @param factor defines the size factor to affect to the specified gradient
  16769. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  16770. * @returns the current particle system
  16771. */
  16772. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  16773. /**
  16774. * Remove a specific size gradient
  16775. * @param gradient defines the gradient to remove
  16776. * @returns the current particle system
  16777. */
  16778. removeSizeGradient(gradient: number): IParticleSystem;
  16779. /**
  16780. * Gets the current list of color gradients.
  16781. * You must use addColorGradient and removeColorGradient to udpate this list
  16782. * @returns the list of color gradients
  16783. */
  16784. getColorGradients(): Nullable<Array<ColorGradient>>;
  16785. /**
  16786. * Gets the current list of size gradients.
  16787. * You must use addSizeGradient and removeSizeGradient to udpate this list
  16788. * @returns the list of size gradients
  16789. */
  16790. getSizeGradients(): Nullable<Array<FactorGradient>>;
  16791. /**
  16792. * Gets the current list of angular speed gradients.
  16793. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  16794. * @returns the list of angular speed gradients
  16795. */
  16796. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  16797. /**
  16798. * Adds a new angular speed gradient
  16799. * @param gradient defines the gradient to use (between 0 and 1)
  16800. * @param factor defines the angular speed to affect to the specified gradient
  16801. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  16802. * @returns the current particle system
  16803. */
  16804. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  16805. /**
  16806. * Remove a specific angular speed gradient
  16807. * @param gradient defines the gradient to remove
  16808. * @returns the current particle system
  16809. */
  16810. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  16811. /**
  16812. * Gets the current list of velocity gradients.
  16813. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  16814. * @returns the list of velocity gradients
  16815. */
  16816. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  16817. /**
  16818. * Adds a new velocity gradient
  16819. * @param gradient defines the gradient to use (between 0 and 1)
  16820. * @param factor defines the velocity to affect to the specified gradient
  16821. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  16822. * @returns the current particle system
  16823. */
  16824. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  16825. /**
  16826. * Remove a specific velocity gradient
  16827. * @param gradient defines the gradient to remove
  16828. * @returns the current particle system
  16829. */
  16830. removeVelocityGradient(gradient: number): IParticleSystem;
  16831. /**
  16832. * Gets the current list of limit velocity gradients.
  16833. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  16834. * @returns the list of limit velocity gradients
  16835. */
  16836. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  16837. /**
  16838. * Adds a new limit velocity gradient
  16839. * @param gradient defines the gradient to use (between 0 and 1)
  16840. * @param factor defines the limit velocity to affect to the specified gradient
  16841. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  16842. * @returns the current particle system
  16843. */
  16844. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  16845. /**
  16846. * Remove a specific limit velocity gradient
  16847. * @param gradient defines the gradient to remove
  16848. * @returns the current particle system
  16849. */
  16850. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  16851. /**
  16852. * Adds a new drag gradient
  16853. * @param gradient defines the gradient to use (between 0 and 1)
  16854. * @param factor defines the drag to affect to the specified gradient
  16855. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  16856. * @returns the current particle system
  16857. */
  16858. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  16859. /**
  16860. * Remove a specific drag gradient
  16861. * @param gradient defines the gradient to remove
  16862. * @returns the current particle system
  16863. */
  16864. removeDragGradient(gradient: number): IParticleSystem;
  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. /**
  16872. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  16873. * @param gradient defines the gradient to use (between 0 and 1)
  16874. * @param factor defines the emit rate to affect to the specified gradient
  16875. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  16876. * @returns the current particle system
  16877. */
  16878. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  16879. /**
  16880. * Remove a specific emit rate gradient
  16881. * @param gradient defines the gradient to remove
  16882. * @returns the current particle system
  16883. */
  16884. removeEmitRateGradient(gradient: number): IParticleSystem;
  16885. /**
  16886. * Gets the current list of emit rate gradients.
  16887. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  16888. * @returns the list of emit rate gradients
  16889. */
  16890. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  16891. /**
  16892. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  16893. * @param gradient defines the gradient to use (between 0 and 1)
  16894. * @param factor defines the start size to affect to the specified gradient
  16895. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  16896. * @returns the current particle system
  16897. */
  16898. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  16899. /**
  16900. * Remove a specific start size gradient
  16901. * @param gradient defines the gradient to remove
  16902. * @returns the current particle system
  16903. */
  16904. removeStartSizeGradient(gradient: number): IParticleSystem;
  16905. /**
  16906. * Gets the current list of start size gradients.
  16907. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  16908. * @returns the list of start size gradients
  16909. */
  16910. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  16911. /**
  16912. * Adds a new life time gradient
  16913. * @param gradient defines the gradient to use (between 0 and 1)
  16914. * @param factor defines the life time factor to affect to the specified gradient
  16915. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  16916. * @returns the current particle system
  16917. */
  16918. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  16919. /**
  16920. * Remove a specific life time gradient
  16921. * @param gradient defines the gradient to remove
  16922. * @returns the current particle system
  16923. */
  16924. removeLifeTimeGradient(gradient: number): IParticleSystem;
  16925. /**
  16926. * Gets the current list of life time gradients.
  16927. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  16928. * @returns the list of life time gradients
  16929. */
  16930. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  16931. /**
  16932. * Gets the current list of color gradients.
  16933. * You must use addColorGradient and removeColorGradient to udpate this list
  16934. * @returns the list of color gradients
  16935. */
  16936. getColorGradients(): Nullable<Array<ColorGradient>>;
  16937. /**
  16938. * Adds a new ramp gradient used to remap particle colors
  16939. * @param gradient defines the gradient to use (between 0 and 1)
  16940. * @param color defines the color to affect to the specified gradient
  16941. * @returns the current particle system
  16942. */
  16943. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  16944. /**
  16945. * Gets the current list of ramp gradients.
  16946. * You must use addRampGradient and removeRampGradient to udpate this list
  16947. * @returns the list of ramp gradients
  16948. */
  16949. getRampGradients(): Nullable<Array<Color3Gradient>>;
  16950. /** Gets or sets a boolean indicating that ramp gradients must be used
  16951. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  16952. */
  16953. useRampGradients: boolean;
  16954. /**
  16955. * Adds a new color remap gradient
  16956. * @param gradient defines the gradient to use (between 0 and 1)
  16957. * @param min defines the color remap minimal range
  16958. * @param max defines the color remap maximal range
  16959. * @returns the current particle system
  16960. */
  16961. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  16962. /**
  16963. * Gets the current list of color remap gradients.
  16964. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  16965. * @returns the list of color remap gradients
  16966. */
  16967. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  16968. /**
  16969. * Adds a new alpha remap gradient
  16970. * @param gradient defines the gradient to use (between 0 and 1)
  16971. * @param min defines the alpha remap minimal range
  16972. * @param max defines the alpha remap maximal range
  16973. * @returns the current particle system
  16974. */
  16975. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  16976. /**
  16977. * Gets the current list of alpha remap gradients.
  16978. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  16979. * @returns the list of alpha remap gradients
  16980. */
  16981. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  16982. /**
  16983. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  16984. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  16985. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  16986. * @returns the emitter
  16987. */
  16988. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  16989. /**
  16990. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  16991. * @param radius The radius of the hemisphere to emit from
  16992. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  16993. * @returns the emitter
  16994. */
  16995. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  16996. /**
  16997. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  16998. * @param radius The radius of the sphere to emit from
  16999. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  17000. * @returns the emitter
  17001. */
  17002. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  17003. /**
  17004. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  17005. * @param radius The radius of the sphere to emit from
  17006. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  17007. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  17008. * @returns the emitter
  17009. */
  17010. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  17011. /**
  17012. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  17013. * @param radius The radius of the emission cylinder
  17014. * @param height The height of the emission cylinder
  17015. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  17016. * @param directionRandomizer How much to randomize the particle direction [0-1]
  17017. * @returns the emitter
  17018. */
  17019. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  17020. /**
  17021. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  17022. * @param radius The radius of the cylinder to emit from
  17023. * @param height The height of the emission cylinder
  17024. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  17025. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  17026. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  17027. * @returns the emitter
  17028. */
  17029. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  17030. /**
  17031. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  17032. * @param radius The radius of the cone to emit from
  17033. * @param angle The base angle of the cone
  17034. * @returns the emitter
  17035. */
  17036. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  17037. /**
  17038. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  17039. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  17040. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  17041. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17042. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17043. * @returns the emitter
  17044. */
  17045. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  17046. /**
  17047. * Get hosting scene
  17048. * @returns the scene
  17049. */
  17050. getScene(): Nullable<Scene>;
  17051. }
  17052. }
  17053. declare module BABYLON {
  17054. /**
  17055. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  17056. */
  17057. export class ColorSplitterBlock extends NodeMaterialBlock {
  17058. /**
  17059. * Create a new ColorSplitterBlock
  17060. * @param name defines the block name
  17061. */
  17062. constructor(name: string);
  17063. /**
  17064. * Gets the current class name
  17065. * @returns the class name
  17066. */
  17067. getClassName(): string;
  17068. /**
  17069. * Gets the rgba component (input)
  17070. */
  17071. get rgba(): NodeMaterialConnectionPoint;
  17072. /**
  17073. * Gets the rgb component (input)
  17074. */
  17075. get rgbIn(): NodeMaterialConnectionPoint;
  17076. /**
  17077. * Gets the rgb component (output)
  17078. */
  17079. get rgbOut(): NodeMaterialConnectionPoint;
  17080. /**
  17081. * Gets the r component (output)
  17082. */
  17083. get r(): NodeMaterialConnectionPoint;
  17084. /**
  17085. * Gets the g component (output)
  17086. */
  17087. get g(): NodeMaterialConnectionPoint;
  17088. /**
  17089. * Gets the b component (output)
  17090. */
  17091. get b(): NodeMaterialConnectionPoint;
  17092. /**
  17093. * Gets the a component (output)
  17094. */
  17095. get a(): NodeMaterialConnectionPoint;
  17096. protected _inputRename(name: string): string;
  17097. protected _outputRename(name: string): string;
  17098. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  17099. }
  17100. }
  17101. declare module BABYLON {
  17102. /**
  17103. * Operations supported by the Trigonometry block
  17104. */
  17105. export enum TrigonometryBlockOperations {
  17106. /** Cos */
  17107. Cos = 0,
  17108. /** Sin */
  17109. Sin = 1,
  17110. /** Abs */
  17111. Abs = 2,
  17112. /** Exp */
  17113. Exp = 3,
  17114. /** Exp2 */
  17115. Exp2 = 4,
  17116. /** Round */
  17117. Round = 5,
  17118. /** Floor */
  17119. Floor = 6,
  17120. /** Ceiling */
  17121. Ceiling = 7,
  17122. /** Square root */
  17123. Sqrt = 8,
  17124. /** Log */
  17125. Log = 9,
  17126. /** Tangent */
  17127. Tan = 10,
  17128. /** Arc tangent */
  17129. ArcTan = 11,
  17130. /** Arc cosinus */
  17131. ArcCos = 12,
  17132. /** Arc sinus */
  17133. ArcSin = 13,
  17134. /** Fraction */
  17135. Fract = 14,
  17136. /** Sign */
  17137. Sign = 15,
  17138. /** To radians (from degrees) */
  17139. Radians = 16,
  17140. /** To degrees (from radians) */
  17141. Degrees = 17
  17142. }
  17143. /**
  17144. * Block used to apply trigonometry operation to floats
  17145. */
  17146. export class TrigonometryBlock extends NodeMaterialBlock {
  17147. /**
  17148. * Gets or sets the operation applied by the block
  17149. */
  17150. operation: TrigonometryBlockOperations;
  17151. /**
  17152. * Creates a new TrigonometryBlock
  17153. * @param name defines the block name
  17154. */
  17155. constructor(name: string);
  17156. /**
  17157. * Gets the current class name
  17158. * @returns the class name
  17159. */
  17160. getClassName(): string;
  17161. /**
  17162. * Gets the input component
  17163. */
  17164. get input(): NodeMaterialConnectionPoint;
  17165. /**
  17166. * Gets the output component
  17167. */
  17168. get output(): NodeMaterialConnectionPoint;
  17169. protected _buildBlock(state: NodeMaterialBuildState): this;
  17170. serialize(): any;
  17171. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  17172. protected _dumpPropertiesCode(): string;
  17173. }
  17174. }
  17175. declare module BABYLON {
  17176. /**
  17177. * Interface used to configure the node material editor
  17178. */
  17179. export interface INodeMaterialEditorOptions {
  17180. /** Define the URl to load node editor script */
  17181. editorURL?: string;
  17182. }
  17183. /** @hidden */
  17184. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  17185. NORMAL: boolean;
  17186. TANGENT: boolean;
  17187. UV1: boolean;
  17188. /** BONES */
  17189. NUM_BONE_INFLUENCERS: number;
  17190. BonesPerMesh: number;
  17191. BONETEXTURE: boolean;
  17192. /** MORPH TARGETS */
  17193. MORPHTARGETS: boolean;
  17194. MORPHTARGETS_NORMAL: boolean;
  17195. MORPHTARGETS_TANGENT: boolean;
  17196. MORPHTARGETS_UV: boolean;
  17197. NUM_MORPH_INFLUENCERS: number;
  17198. /** IMAGE PROCESSING */
  17199. IMAGEPROCESSING: boolean;
  17200. VIGNETTE: boolean;
  17201. VIGNETTEBLENDMODEMULTIPLY: boolean;
  17202. VIGNETTEBLENDMODEOPAQUE: boolean;
  17203. TONEMAPPING: boolean;
  17204. TONEMAPPING_ACES: boolean;
  17205. CONTRAST: boolean;
  17206. EXPOSURE: boolean;
  17207. COLORCURVES: boolean;
  17208. COLORGRADING: boolean;
  17209. COLORGRADING3D: boolean;
  17210. SAMPLER3DGREENDEPTH: boolean;
  17211. SAMPLER3DBGRMAP: boolean;
  17212. IMAGEPROCESSINGPOSTPROCESS: boolean;
  17213. /** MISC. */
  17214. BUMPDIRECTUV: number;
  17215. constructor();
  17216. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  17217. }
  17218. /**
  17219. * Class used to configure NodeMaterial
  17220. */
  17221. export interface INodeMaterialOptions {
  17222. /**
  17223. * Defines if blocks should emit comments
  17224. */
  17225. emitComments: boolean;
  17226. }
  17227. /**
  17228. * Class used to create a node based material built by assembling shader blocks
  17229. */
  17230. export class NodeMaterial extends PushMaterial {
  17231. private static _BuildIdGenerator;
  17232. private _options;
  17233. private _vertexCompilationState;
  17234. private _fragmentCompilationState;
  17235. private _sharedData;
  17236. private _buildId;
  17237. private _buildWasSuccessful;
  17238. private _cachedWorldViewMatrix;
  17239. private _cachedWorldViewProjectionMatrix;
  17240. private _optimizers;
  17241. private _animationFrame;
  17242. /** Define the Url to load node editor script */
  17243. static EditorURL: string;
  17244. /** Define the Url to load snippets */
  17245. static SnippetUrl: string;
  17246. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  17247. static IgnoreTexturesAtLoadTime: boolean;
  17248. private BJSNODEMATERIALEDITOR;
  17249. /** Get the inspector from bundle or global */
  17250. private _getGlobalNodeMaterialEditor;
  17251. /**
  17252. * Snippet ID if the material was created from the snippet server
  17253. */
  17254. snippetId: string;
  17255. /**
  17256. * Gets or sets data used by visual editor
  17257. * @see https://nme.babylonjs.com
  17258. */
  17259. editorData: any;
  17260. /**
  17261. * 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)
  17262. */
  17263. ignoreAlpha: boolean;
  17264. /**
  17265. * Defines the maximum number of lights that can be used in the material
  17266. */
  17267. maxSimultaneousLights: number;
  17268. /**
  17269. * Observable raised when the material is built
  17270. */
  17271. onBuildObservable: Observable<NodeMaterial>;
  17272. /**
  17273. * Gets or sets the root nodes of the material vertex shader
  17274. */
  17275. _vertexOutputNodes: NodeMaterialBlock[];
  17276. /**
  17277. * Gets or sets the root nodes of the material fragment (pixel) shader
  17278. */
  17279. _fragmentOutputNodes: NodeMaterialBlock[];
  17280. /** Gets or sets options to control the node material overall behavior */
  17281. get options(): INodeMaterialOptions;
  17282. set options(options: INodeMaterialOptions);
  17283. /**
  17284. * Default configuration related to image processing available in the standard Material.
  17285. */
  17286. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  17287. /**
  17288. * Gets the image processing configuration used either in this material.
  17289. */
  17290. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  17291. /**
  17292. * Sets the Default image processing configuration used either in the this material.
  17293. *
  17294. * If sets to null, the scene one is in use.
  17295. */
  17296. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  17297. /**
  17298. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  17299. */
  17300. attachedBlocks: NodeMaterialBlock[];
  17301. /**
  17302. * Specifies the mode of the node material
  17303. * @hidden
  17304. */
  17305. _mode: NodeMaterialModes;
  17306. /**
  17307. * Gets the mode property
  17308. */
  17309. get mode(): NodeMaterialModes;
  17310. /**
  17311. * A free comment about the material
  17312. */
  17313. comment: string;
  17314. /**
  17315. * Create a new node based material
  17316. * @param name defines the material name
  17317. * @param scene defines the hosting scene
  17318. * @param options defines creation option
  17319. */
  17320. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  17321. /**
  17322. * Gets the current class name of the material e.g. "NodeMaterial"
  17323. * @returns the class name
  17324. */
  17325. getClassName(): string;
  17326. /**
  17327. * Keep track of the image processing observer to allow dispose and replace.
  17328. */
  17329. private _imageProcessingObserver;
  17330. /**
  17331. * Attaches a new image processing configuration to the Standard Material.
  17332. * @param configuration
  17333. */
  17334. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  17335. /**
  17336. * Get a block by its name
  17337. * @param name defines the name of the block to retrieve
  17338. * @returns the required block or null if not found
  17339. */
  17340. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  17341. /**
  17342. * Get a block by its name
  17343. * @param predicate defines the predicate used to find the good candidate
  17344. * @returns the required block or null if not found
  17345. */
  17346. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  17347. /**
  17348. * Get an input block by its name
  17349. * @param predicate defines the predicate used to find the good candidate
  17350. * @returns the required input block or null if not found
  17351. */
  17352. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  17353. /**
  17354. * Gets the list of input blocks attached to this material
  17355. * @returns an array of InputBlocks
  17356. */
  17357. getInputBlocks(): InputBlock[];
  17358. /**
  17359. * Adds a new optimizer to the list of optimizers
  17360. * @param optimizer defines the optimizers to add
  17361. * @returns the current material
  17362. */
  17363. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  17364. /**
  17365. * Remove an optimizer from the list of optimizers
  17366. * @param optimizer defines the optimizers to remove
  17367. * @returns the current material
  17368. */
  17369. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  17370. /**
  17371. * Add a new block to the list of output nodes
  17372. * @param node defines the node to add
  17373. * @returns the current material
  17374. */
  17375. addOutputNode(node: NodeMaterialBlock): this;
  17376. /**
  17377. * Remove a block from the list of root nodes
  17378. * @param node defines the node to remove
  17379. * @returns the current material
  17380. */
  17381. removeOutputNode(node: NodeMaterialBlock): this;
  17382. private _addVertexOutputNode;
  17383. private _removeVertexOutputNode;
  17384. private _addFragmentOutputNode;
  17385. private _removeFragmentOutputNode;
  17386. /**
  17387. * Specifies if the material will require alpha blending
  17388. * @returns a boolean specifying if alpha blending is needed
  17389. */
  17390. needAlphaBlending(): boolean;
  17391. /**
  17392. * Specifies if this material should be rendered in alpha test mode
  17393. * @returns a boolean specifying if an alpha test is needed.
  17394. */
  17395. needAlphaTesting(): boolean;
  17396. private _initializeBlock;
  17397. private _resetDualBlocks;
  17398. /**
  17399. * Remove a block from the current node material
  17400. * @param block defines the block to remove
  17401. */
  17402. removeBlock(block: NodeMaterialBlock): void;
  17403. /**
  17404. * Build the material and generates the inner effect
  17405. * @param verbose defines if the build should log activity
  17406. */
  17407. build(verbose?: boolean): void;
  17408. /**
  17409. * Runs an otpimization phase to try to improve the shader code
  17410. */
  17411. optimize(): void;
  17412. private _prepareDefinesForAttributes;
  17413. /**
  17414. * Create a post process from the material
  17415. * @param camera The camera to apply the render pass to.
  17416. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  17417. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  17418. * @param engine The engine which the post process will be applied. (default: current engine)
  17419. * @param reusable If the post process can be reused on the same frame. (default: false)
  17420. * @param textureType Type of textures used when performing the post process. (default: 0)
  17421. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  17422. * @returns the post process created
  17423. */
  17424. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): Nullable<PostProcess>;
  17425. /**
  17426. * Create the post process effect from the material
  17427. * @param postProcess The post process to create the effect for
  17428. */
  17429. createEffectForPostProcess(postProcess: PostProcess): void;
  17430. private _createEffectForPostProcess;
  17431. /**
  17432. * Create a new procedural texture based on this node material
  17433. * @param size defines the size of the texture
  17434. * @param scene defines the hosting scene
  17435. * @returns the new procedural texture attached to this node material
  17436. */
  17437. createProceduralTexture(size: number | {
  17438. width: number;
  17439. height: number;
  17440. layers?: number;
  17441. }, scene: Scene): Nullable<ProceduralTexture>;
  17442. private _createEffectForParticles;
  17443. private _checkInternals;
  17444. /**
  17445. * Create the effect to be used as the custom effect for a particle system
  17446. * @param particleSystem Particle system to create the effect for
  17447. * @param onCompiled defines a function to call when the effect creation is successful
  17448. * @param onError defines a function to call when the effect creation has failed
  17449. */
  17450. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  17451. private _processDefines;
  17452. /**
  17453. * Get if the submesh is ready to be used and all its information available.
  17454. * Child classes can use it to update shaders
  17455. * @param mesh defines the mesh to check
  17456. * @param subMesh defines which submesh to check
  17457. * @param useInstances specifies that instances should be used
  17458. * @returns a boolean indicating that the submesh is ready or not
  17459. */
  17460. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  17461. /**
  17462. * Get a string representing the shaders built by the current node graph
  17463. */
  17464. get compiledShaders(): string;
  17465. /**
  17466. * Binds the world matrix to the material
  17467. * @param world defines the world transformation matrix
  17468. */
  17469. bindOnlyWorldMatrix(world: Matrix): void;
  17470. /**
  17471. * Binds the submesh to this material by preparing the effect and shader to draw
  17472. * @param world defines the world transformation matrix
  17473. * @param mesh defines the mesh containing the submesh
  17474. * @param subMesh defines the submesh to bind the material to
  17475. */
  17476. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  17477. /**
  17478. * Gets the active textures from the material
  17479. * @returns an array of textures
  17480. */
  17481. getActiveTextures(): BaseTexture[];
  17482. /**
  17483. * Gets the list of texture blocks
  17484. * @returns an array of texture blocks
  17485. */
  17486. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  17487. /**
  17488. * Specifies if the material uses a texture
  17489. * @param texture defines the texture to check against the material
  17490. * @returns a boolean specifying if the material uses the texture
  17491. */
  17492. hasTexture(texture: BaseTexture): boolean;
  17493. /**
  17494. * Disposes the material
  17495. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  17496. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  17497. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  17498. */
  17499. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  17500. /** Creates the node editor window. */
  17501. private _createNodeEditor;
  17502. /**
  17503. * Launch the node material editor
  17504. * @param config Define the configuration of the editor
  17505. * @return a promise fulfilled when the node editor is visible
  17506. */
  17507. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  17508. /**
  17509. * Clear the current material
  17510. */
  17511. clear(): void;
  17512. /**
  17513. * Clear the current material and set it to a default state
  17514. */
  17515. setToDefault(): void;
  17516. /**
  17517. * Clear the current material and set it to a default state for post process
  17518. */
  17519. setToDefaultPostProcess(): void;
  17520. /**
  17521. * Clear the current material and set it to a default state for procedural texture
  17522. */
  17523. setToDefaultProceduralTexture(): void;
  17524. /**
  17525. * Clear the current material and set it to a default state for particle
  17526. */
  17527. setToDefaultParticle(): void;
  17528. /**
  17529. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  17530. * @param url defines the url to load from
  17531. * @returns a promise that will fullfil when the material is fully loaded
  17532. */
  17533. loadAsync(url: string): Promise<void>;
  17534. private _gatherBlocks;
  17535. /**
  17536. * Generate a string containing the code declaration required to create an equivalent of this material
  17537. * @returns a string
  17538. */
  17539. generateCode(): string;
  17540. /**
  17541. * Serializes this material in a JSON representation
  17542. * @returns the serialized material object
  17543. */
  17544. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  17545. private _restoreConnections;
  17546. /**
  17547. * Clear the current graph and load a new one from a serialization object
  17548. * @param source defines the JSON representation of the material
  17549. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17550. * @param merge defines whether or not the source must be merged or replace the current content
  17551. */
  17552. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  17553. /**
  17554. * Makes a duplicate of the current material.
  17555. * @param name - name to use for the new material.
  17556. */
  17557. clone(name: string): NodeMaterial;
  17558. /**
  17559. * Creates a node material from parsed material data
  17560. * @param source defines the JSON representation of the material
  17561. * @param scene defines the hosting scene
  17562. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17563. * @returns a new node material
  17564. */
  17565. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  17566. /**
  17567. * Creates a node material from a snippet saved in a remote file
  17568. * @param name defines the name of the material to create
  17569. * @param url defines the url to load from
  17570. * @param scene defines the hosting scene
  17571. * @returns a promise that will resolve to the new node material
  17572. */
  17573. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  17574. /**
  17575. * Creates a node material from a snippet saved by the node material editor
  17576. * @param snippetId defines the snippet to load
  17577. * @param scene defines the hosting scene
  17578. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17579. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  17580. * @returns a promise that will resolve to the new node material
  17581. */
  17582. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  17583. /**
  17584. * Creates a new node material set to default basic configuration
  17585. * @param name defines the name of the material
  17586. * @param scene defines the hosting scene
  17587. * @returns a new NodeMaterial
  17588. */
  17589. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  17590. }
  17591. }
  17592. declare module BABYLON {
  17593. interface ThinEngine {
  17594. /**
  17595. * Unbind a list of render target textures from the webGL context
  17596. * This is used only when drawBuffer extension or webGL2 are active
  17597. * @param textures defines the render target textures to unbind
  17598. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  17599. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  17600. */
  17601. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  17602. /**
  17603. * Create a multi render target texture
  17604. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  17605. * @param size defines the size of the texture
  17606. * @param options defines the creation options
  17607. * @returns the cube texture as an InternalTexture
  17608. */
  17609. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  17610. /**
  17611. * Update the sample count for a given multiple render target texture
  17612. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  17613. * @param textures defines the textures to update
  17614. * @param samples defines the sample count to set
  17615. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  17616. */
  17617. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  17618. /**
  17619. * Select a subsets of attachments to draw to.
  17620. * @param attachments gl attachments
  17621. */
  17622. bindAttachments(attachments: number[]): void;
  17623. /**
  17624. * Creates a layout object to draw/clear on specific textures in a MRT
  17625. * @param textureStatus textureStatus[i] indicates if the i-th is active
  17626. * @returns A layout to be fed to the engine, calling `bindAttachments`.
  17627. */
  17628. buildTextureLayout(textureStatus: boolean[]): number[];
  17629. /**
  17630. * Restores the webgl state to only draw on the main color attachment
  17631. */
  17632. restoreSingleAttachment(): void;
  17633. }
  17634. }
  17635. declare module BABYLON {
  17636. /**
  17637. * Creation options of the multi render target texture.
  17638. */
  17639. export interface IMultiRenderTargetOptions {
  17640. /**
  17641. * Define if the texture needs to create mip maps after render.
  17642. */
  17643. generateMipMaps?: boolean;
  17644. /**
  17645. * Define the types of all the draw buffers we want to create
  17646. */
  17647. types?: number[];
  17648. /**
  17649. * Define the sampling modes of all the draw buffers we want to create
  17650. */
  17651. samplingModes?: number[];
  17652. /**
  17653. * Define if a depth buffer is required
  17654. */
  17655. generateDepthBuffer?: boolean;
  17656. /**
  17657. * Define if a stencil buffer is required
  17658. */
  17659. generateStencilBuffer?: boolean;
  17660. /**
  17661. * Define if a depth texture is required instead of a depth buffer
  17662. */
  17663. generateDepthTexture?: boolean;
  17664. /**
  17665. * Define the number of desired draw buffers
  17666. */
  17667. textureCount?: number;
  17668. /**
  17669. * Define if aspect ratio should be adapted to the texture or stay the scene one
  17670. */
  17671. doNotChangeAspectRatio?: boolean;
  17672. /**
  17673. * Define the default type of the buffers we are creating
  17674. */
  17675. defaultType?: number;
  17676. }
  17677. /**
  17678. * A multi render target, like a render target provides the ability to render to a texture.
  17679. * Unlike the render target, it can render to several draw buffers in one draw.
  17680. * This is specially interesting in deferred rendering or for any effects requiring more than
  17681. * just one color from a single pass.
  17682. */
  17683. export class MultiRenderTarget extends RenderTargetTexture {
  17684. private _internalTextures;
  17685. private _textures;
  17686. private _multiRenderTargetOptions;
  17687. private _count;
  17688. /**
  17689. * Get if draw buffers are currently supported by the used hardware and browser.
  17690. */
  17691. get isSupported(): boolean;
  17692. /**
  17693. * Get the list of textures generated by the multi render target.
  17694. */
  17695. get textures(): Texture[];
  17696. /**
  17697. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  17698. */
  17699. get count(): number;
  17700. /**
  17701. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  17702. */
  17703. get depthTexture(): Texture;
  17704. /**
  17705. * Set the wrapping mode on U of all the textures we are rendering to.
  17706. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  17707. */
  17708. set wrapU(wrap: number);
  17709. /**
  17710. * Set the wrapping mode on V of all the textures we are rendering to.
  17711. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  17712. */
  17713. set wrapV(wrap: number);
  17714. /**
  17715. * Instantiate a new multi render target texture.
  17716. * A multi render target, like a render target provides the ability to render to a texture.
  17717. * Unlike the render target, it can render to several draw buffers in one draw.
  17718. * This is specially interesting in deferred rendering or for any effects requiring more than
  17719. * just one color from a single pass.
  17720. * @param name Define the name of the texture
  17721. * @param size Define the size of the buffers to render to
  17722. * @param count Define the number of target we are rendering into
  17723. * @param scene Define the scene the texture belongs to
  17724. * @param options Define the options used to create the multi render target
  17725. */
  17726. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  17727. private _initTypes;
  17728. /** @hidden */
  17729. _rebuild(forceFullRebuild?: boolean): void;
  17730. private _createInternalTextures;
  17731. private _createTextures;
  17732. /**
  17733. * Replaces a texture within the MRT.
  17734. * @param texture The new texture to insert in the MRT
  17735. * @param index The index of the texture to replace
  17736. */
  17737. replaceTexture(texture: Texture, index: number): void;
  17738. /**
  17739. * Define the number of samples used if MSAA is enabled.
  17740. */
  17741. get samples(): number;
  17742. set samples(value: number);
  17743. /**
  17744. * Resize all the textures in the multi render target.
  17745. * Be careful as it will recreate all the data in the new texture.
  17746. * @param size Define the new size
  17747. */
  17748. resize(size: any): void;
  17749. /**
  17750. * Changes the number of render targets in this MRT
  17751. * Be careful as it will recreate all the data in the new texture.
  17752. * @param count new texture count
  17753. * @param options Specifies texture types and sampling modes for new textures
  17754. */
  17755. updateCount(count: number, options?: IMultiRenderTargetOptions): void;
  17756. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  17757. /**
  17758. * Dispose the render targets and their associated resources
  17759. */
  17760. dispose(): void;
  17761. /**
  17762. * Release all the underlying texture used as draw buffers.
  17763. */
  17764. releaseInternalTextures(): void;
  17765. }
  17766. }
  17767. declare module BABYLON {
  17768. /** @hidden */
  17769. export var imageProcessingPixelShader: {
  17770. name: string;
  17771. shader: string;
  17772. };
  17773. }
  17774. declare module BABYLON {
  17775. /**
  17776. * ImageProcessingPostProcess
  17777. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  17778. */
  17779. export class ImageProcessingPostProcess extends PostProcess {
  17780. /**
  17781. * Default configuration related to image processing available in the PBR Material.
  17782. */
  17783. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  17784. /**
  17785. * Gets the image processing configuration used either in this material.
  17786. */
  17787. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  17788. /**
  17789. * Sets the Default image processing configuration used either in the this material.
  17790. *
  17791. * If sets to null, the scene one is in use.
  17792. */
  17793. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  17794. /**
  17795. * Keep track of the image processing observer to allow dispose and replace.
  17796. */
  17797. private _imageProcessingObserver;
  17798. /**
  17799. * Attaches a new image processing configuration to the PBR Material.
  17800. * @param configuration
  17801. */
  17802. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  17803. /**
  17804. * If the post process is supported.
  17805. */
  17806. get isSupported(): boolean;
  17807. /**
  17808. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  17809. */
  17810. get colorCurves(): Nullable<ColorCurves>;
  17811. /**
  17812. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  17813. */
  17814. set colorCurves(value: Nullable<ColorCurves>);
  17815. /**
  17816. * Gets wether the color curves effect is enabled.
  17817. */
  17818. get colorCurvesEnabled(): boolean;
  17819. /**
  17820. * Sets wether the color curves effect is enabled.
  17821. */
  17822. set colorCurvesEnabled(value: boolean);
  17823. /**
  17824. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  17825. */
  17826. get colorGradingTexture(): Nullable<BaseTexture>;
  17827. /**
  17828. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  17829. */
  17830. set colorGradingTexture(value: Nullable<BaseTexture>);
  17831. /**
  17832. * Gets wether the color grading effect is enabled.
  17833. */
  17834. get colorGradingEnabled(): boolean;
  17835. /**
  17836. * Gets wether the color grading effect is enabled.
  17837. */
  17838. set colorGradingEnabled(value: boolean);
  17839. /**
  17840. * Gets exposure used in the effect.
  17841. */
  17842. get exposure(): number;
  17843. /**
  17844. * Sets exposure used in the effect.
  17845. */
  17846. set exposure(value: number);
  17847. /**
  17848. * Gets wether tonemapping is enabled or not.
  17849. */
  17850. get toneMappingEnabled(): boolean;
  17851. /**
  17852. * Sets wether tonemapping is enabled or not
  17853. */
  17854. set toneMappingEnabled(value: boolean);
  17855. /**
  17856. * Gets the type of tone mapping effect.
  17857. */
  17858. get toneMappingType(): number;
  17859. /**
  17860. * Sets the type of tone mapping effect.
  17861. */
  17862. set toneMappingType(value: number);
  17863. /**
  17864. * Gets contrast used in the effect.
  17865. */
  17866. get contrast(): number;
  17867. /**
  17868. * Sets contrast used in the effect.
  17869. */
  17870. set contrast(value: number);
  17871. /**
  17872. * Gets Vignette stretch size.
  17873. */
  17874. get vignetteStretch(): number;
  17875. /**
  17876. * Sets Vignette stretch size.
  17877. */
  17878. set vignetteStretch(value: number);
  17879. /**
  17880. * Gets Vignette centre X Offset.
  17881. */
  17882. get vignetteCentreX(): number;
  17883. /**
  17884. * Sets Vignette centre X Offset.
  17885. */
  17886. set vignetteCentreX(value: number);
  17887. /**
  17888. * Gets Vignette centre Y Offset.
  17889. */
  17890. get vignetteCentreY(): number;
  17891. /**
  17892. * Sets Vignette centre Y Offset.
  17893. */
  17894. set vignetteCentreY(value: number);
  17895. /**
  17896. * Gets Vignette weight or intensity of the vignette effect.
  17897. */
  17898. get vignetteWeight(): number;
  17899. /**
  17900. * Sets Vignette weight or intensity of the vignette effect.
  17901. */
  17902. set vignetteWeight(value: number);
  17903. /**
  17904. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  17905. * if vignetteEnabled is set to true.
  17906. */
  17907. get vignetteColor(): Color4;
  17908. /**
  17909. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  17910. * if vignetteEnabled is set to true.
  17911. */
  17912. set vignetteColor(value: Color4);
  17913. /**
  17914. * Gets Camera field of view used by the Vignette effect.
  17915. */
  17916. get vignetteCameraFov(): number;
  17917. /**
  17918. * Sets Camera field of view used by the Vignette effect.
  17919. */
  17920. set vignetteCameraFov(value: number);
  17921. /**
  17922. * Gets the vignette blend mode allowing different kind of effect.
  17923. */
  17924. get vignetteBlendMode(): number;
  17925. /**
  17926. * Sets the vignette blend mode allowing different kind of effect.
  17927. */
  17928. set vignetteBlendMode(value: number);
  17929. /**
  17930. * Gets wether the vignette effect is enabled.
  17931. */
  17932. get vignetteEnabled(): boolean;
  17933. /**
  17934. * Sets wether the vignette effect is enabled.
  17935. */
  17936. set vignetteEnabled(value: boolean);
  17937. private _fromLinearSpace;
  17938. /**
  17939. * Gets wether the input of the processing is in Gamma or Linear Space.
  17940. */
  17941. get fromLinearSpace(): boolean;
  17942. /**
  17943. * Sets wether the input of the processing is in Gamma or Linear Space.
  17944. */
  17945. set fromLinearSpace(value: boolean);
  17946. /**
  17947. * Defines cache preventing GC.
  17948. */
  17949. private _defines;
  17950. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  17951. /**
  17952. * "ImageProcessingPostProcess"
  17953. * @returns "ImageProcessingPostProcess"
  17954. */
  17955. getClassName(): string;
  17956. /**
  17957. * @hidden
  17958. */
  17959. _updateParameters(): void;
  17960. dispose(camera?: Camera): void;
  17961. }
  17962. }
  17963. declare module BABYLON {
  17964. /**
  17965. * Interface for defining prepass effects in the prepass post-process pipeline
  17966. */
  17967. export interface PrePassEffectConfiguration {
  17968. /**
  17969. * Name of the effect
  17970. */
  17971. name: string;
  17972. /**
  17973. * Post process to attach for this effect
  17974. */
  17975. postProcess?: PostProcess;
  17976. /**
  17977. * Textures required in the MRT
  17978. */
  17979. texturesRequired: number[];
  17980. /**
  17981. * Is the effect enabled
  17982. */
  17983. enabled: boolean;
  17984. /**
  17985. * Disposes the effect configuration
  17986. */
  17987. dispose?: () => void;
  17988. /**
  17989. * Creates the associated post process
  17990. */
  17991. createPostProcess?: () => PostProcess;
  17992. }
  17993. }
  17994. declare module BABYLON {
  17995. /**
  17996. * Options to be used when creating a FresnelParameters.
  17997. */
  17998. export type IFresnelParametersCreationOptions = {
  17999. /**
  18000. * Define the color used on edges (grazing angle)
  18001. */
  18002. leftColor?: Color3;
  18003. /**
  18004. * Define the color used on center
  18005. */
  18006. rightColor?: Color3;
  18007. /**
  18008. * Define bias applied to computed fresnel term
  18009. */
  18010. bias?: number;
  18011. /**
  18012. * Defined the power exponent applied to fresnel term
  18013. */
  18014. power?: number;
  18015. /**
  18016. * Define if the fresnel effect is enable or not.
  18017. */
  18018. isEnabled?: boolean;
  18019. };
  18020. /**
  18021. * Serialized format for FresnelParameters.
  18022. */
  18023. export type IFresnelParametersSerialized = {
  18024. /**
  18025. * Define the color used on edges (grazing angle) [as an array]
  18026. */
  18027. leftColor: number[];
  18028. /**
  18029. * Define the color used on center [as an array]
  18030. */
  18031. rightColor: number[];
  18032. /**
  18033. * Define bias applied to computed fresnel term
  18034. */
  18035. bias: number;
  18036. /**
  18037. * Defined the power exponent applied to fresnel term
  18038. */
  18039. power?: number;
  18040. /**
  18041. * Define if the fresnel effect is enable or not.
  18042. */
  18043. isEnabled: boolean;
  18044. };
  18045. /**
  18046. * This represents all the required information to add a fresnel effect on a material:
  18047. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  18048. */
  18049. export class FresnelParameters {
  18050. private _isEnabled;
  18051. /**
  18052. * Define if the fresnel effect is enable or not.
  18053. */
  18054. get isEnabled(): boolean;
  18055. set isEnabled(value: boolean);
  18056. /**
  18057. * Define the color used on edges (grazing angle)
  18058. */
  18059. leftColor: Color3;
  18060. /**
  18061. * Define the color used on center
  18062. */
  18063. rightColor: Color3;
  18064. /**
  18065. * Define bias applied to computed fresnel term
  18066. */
  18067. bias: number;
  18068. /**
  18069. * Defined the power exponent applied to fresnel term
  18070. */
  18071. power: number;
  18072. /**
  18073. * Creates a new FresnelParameters object.
  18074. *
  18075. * @param options provide your own settings to optionally to override defaults
  18076. */
  18077. constructor(options?: IFresnelParametersCreationOptions);
  18078. /**
  18079. * Clones the current fresnel and its valuues
  18080. * @returns a clone fresnel configuration
  18081. */
  18082. clone(): FresnelParameters;
  18083. /**
  18084. * Determines equality between FresnelParameters objects
  18085. * @param otherFresnelParameters defines the second operand
  18086. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  18087. */
  18088. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  18089. /**
  18090. * Serializes the current fresnel parameters to a JSON representation.
  18091. * @return the JSON serialization
  18092. */
  18093. serialize(): IFresnelParametersSerialized;
  18094. /**
  18095. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  18096. * @param parsedFresnelParameters Define the JSON representation
  18097. * @returns the parsed parameters
  18098. */
  18099. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  18100. }
  18101. }
  18102. declare module BABYLON {
  18103. /**
  18104. * This groups all the flags used to control the materials channel.
  18105. */
  18106. export class MaterialFlags {
  18107. private static _DiffuseTextureEnabled;
  18108. /**
  18109. * Are diffuse textures enabled in the application.
  18110. */
  18111. static get DiffuseTextureEnabled(): boolean;
  18112. static set DiffuseTextureEnabled(value: boolean);
  18113. private static _DetailTextureEnabled;
  18114. /**
  18115. * Are detail textures enabled in the application.
  18116. */
  18117. static get DetailTextureEnabled(): boolean;
  18118. static set DetailTextureEnabled(value: boolean);
  18119. private static _AmbientTextureEnabled;
  18120. /**
  18121. * Are ambient textures enabled in the application.
  18122. */
  18123. static get AmbientTextureEnabled(): boolean;
  18124. static set AmbientTextureEnabled(value: boolean);
  18125. private static _OpacityTextureEnabled;
  18126. /**
  18127. * Are opacity textures enabled in the application.
  18128. */
  18129. static get OpacityTextureEnabled(): boolean;
  18130. static set OpacityTextureEnabled(value: boolean);
  18131. private static _ReflectionTextureEnabled;
  18132. /**
  18133. * Are reflection textures enabled in the application.
  18134. */
  18135. static get ReflectionTextureEnabled(): boolean;
  18136. static set ReflectionTextureEnabled(value: boolean);
  18137. private static _EmissiveTextureEnabled;
  18138. /**
  18139. * Are emissive textures enabled in the application.
  18140. */
  18141. static get EmissiveTextureEnabled(): boolean;
  18142. static set EmissiveTextureEnabled(value: boolean);
  18143. private static _SpecularTextureEnabled;
  18144. /**
  18145. * Are specular textures enabled in the application.
  18146. */
  18147. static get SpecularTextureEnabled(): boolean;
  18148. static set SpecularTextureEnabled(value: boolean);
  18149. private static _BumpTextureEnabled;
  18150. /**
  18151. * Are bump textures enabled in the application.
  18152. */
  18153. static get BumpTextureEnabled(): boolean;
  18154. static set BumpTextureEnabled(value: boolean);
  18155. private static _LightmapTextureEnabled;
  18156. /**
  18157. * Are lightmap textures enabled in the application.
  18158. */
  18159. static get LightmapTextureEnabled(): boolean;
  18160. static set LightmapTextureEnabled(value: boolean);
  18161. private static _RefractionTextureEnabled;
  18162. /**
  18163. * Are refraction textures enabled in the application.
  18164. */
  18165. static get RefractionTextureEnabled(): boolean;
  18166. static set RefractionTextureEnabled(value: boolean);
  18167. private static _ColorGradingTextureEnabled;
  18168. /**
  18169. * Are color grading textures enabled in the application.
  18170. */
  18171. static get ColorGradingTextureEnabled(): boolean;
  18172. static set ColorGradingTextureEnabled(value: boolean);
  18173. private static _FresnelEnabled;
  18174. /**
  18175. * Are fresnels enabled in the application.
  18176. */
  18177. static get FresnelEnabled(): boolean;
  18178. static set FresnelEnabled(value: boolean);
  18179. private static _ClearCoatTextureEnabled;
  18180. /**
  18181. * Are clear coat textures enabled in the application.
  18182. */
  18183. static get ClearCoatTextureEnabled(): boolean;
  18184. static set ClearCoatTextureEnabled(value: boolean);
  18185. private static _ClearCoatBumpTextureEnabled;
  18186. /**
  18187. * Are clear coat bump textures enabled in the application.
  18188. */
  18189. static get ClearCoatBumpTextureEnabled(): boolean;
  18190. static set ClearCoatBumpTextureEnabled(value: boolean);
  18191. private static _ClearCoatTintTextureEnabled;
  18192. /**
  18193. * Are clear coat tint textures enabled in the application.
  18194. */
  18195. static get ClearCoatTintTextureEnabled(): boolean;
  18196. static set ClearCoatTintTextureEnabled(value: boolean);
  18197. private static _SheenTextureEnabled;
  18198. /**
  18199. * Are sheen textures enabled in the application.
  18200. */
  18201. static get SheenTextureEnabled(): boolean;
  18202. static set SheenTextureEnabled(value: boolean);
  18203. private static _AnisotropicTextureEnabled;
  18204. /**
  18205. * Are anisotropic textures enabled in the application.
  18206. */
  18207. static get AnisotropicTextureEnabled(): boolean;
  18208. static set AnisotropicTextureEnabled(value: boolean);
  18209. private static _ThicknessTextureEnabled;
  18210. /**
  18211. * Are thickness textures enabled in the application.
  18212. */
  18213. static get ThicknessTextureEnabled(): boolean;
  18214. static set ThicknessTextureEnabled(value: boolean);
  18215. }
  18216. }
  18217. declare module BABYLON {
  18218. /** @hidden */
  18219. export var defaultFragmentDeclaration: {
  18220. name: string;
  18221. shader: string;
  18222. };
  18223. }
  18224. declare module BABYLON {
  18225. /** @hidden */
  18226. export var defaultUboDeclaration: {
  18227. name: string;
  18228. shader: string;
  18229. };
  18230. }
  18231. declare module BABYLON {
  18232. /** @hidden */
  18233. export var prePassDeclaration: {
  18234. name: string;
  18235. shader: string;
  18236. };
  18237. }
  18238. declare module BABYLON {
  18239. /** @hidden */
  18240. export var lightFragmentDeclaration: {
  18241. name: string;
  18242. shader: string;
  18243. };
  18244. }
  18245. declare module BABYLON {
  18246. /** @hidden */
  18247. export var lightUboDeclaration: {
  18248. name: string;
  18249. shader: string;
  18250. };
  18251. }
  18252. declare module BABYLON {
  18253. /** @hidden */
  18254. export var lightsFragmentFunctions: {
  18255. name: string;
  18256. shader: string;
  18257. };
  18258. }
  18259. declare module BABYLON {
  18260. /** @hidden */
  18261. export var shadowsFragmentFunctions: {
  18262. name: string;
  18263. shader: string;
  18264. };
  18265. }
  18266. declare module BABYLON {
  18267. /** @hidden */
  18268. export var fresnelFunction: {
  18269. name: string;
  18270. shader: string;
  18271. };
  18272. }
  18273. declare module BABYLON {
  18274. /** @hidden */
  18275. export var bumpFragmentMainFunctions: {
  18276. name: string;
  18277. shader: string;
  18278. };
  18279. }
  18280. declare module BABYLON {
  18281. /** @hidden */
  18282. export var bumpFragmentFunctions: {
  18283. name: string;
  18284. shader: string;
  18285. };
  18286. }
  18287. declare module BABYLON {
  18288. /** @hidden */
  18289. export var logDepthDeclaration: {
  18290. name: string;
  18291. shader: string;
  18292. };
  18293. }
  18294. declare module BABYLON {
  18295. /** @hidden */
  18296. export var fogFragmentDeclaration: {
  18297. name: string;
  18298. shader: string;
  18299. };
  18300. }
  18301. declare module BABYLON {
  18302. /** @hidden */
  18303. export var bumpFragment: {
  18304. name: string;
  18305. shader: string;
  18306. };
  18307. }
  18308. declare module BABYLON {
  18309. /** @hidden */
  18310. export var depthPrePass: {
  18311. name: string;
  18312. shader: string;
  18313. };
  18314. }
  18315. declare module BABYLON {
  18316. /** @hidden */
  18317. export var lightFragment: {
  18318. name: string;
  18319. shader: string;
  18320. };
  18321. }
  18322. declare module BABYLON {
  18323. /** @hidden */
  18324. export var logDepthFragment: {
  18325. name: string;
  18326. shader: string;
  18327. };
  18328. }
  18329. declare module BABYLON {
  18330. /** @hidden */
  18331. export var fogFragment: {
  18332. name: string;
  18333. shader: string;
  18334. };
  18335. }
  18336. declare module BABYLON {
  18337. /** @hidden */
  18338. export var defaultPixelShader: {
  18339. name: string;
  18340. shader: string;
  18341. };
  18342. }
  18343. declare module BABYLON {
  18344. /** @hidden */
  18345. export var defaultVertexDeclaration: {
  18346. name: string;
  18347. shader: string;
  18348. };
  18349. }
  18350. declare module BABYLON {
  18351. /** @hidden */
  18352. export var bonesDeclaration: {
  18353. name: string;
  18354. shader: string;
  18355. };
  18356. }
  18357. declare module BABYLON {
  18358. /** @hidden */
  18359. export var instancesDeclaration: {
  18360. name: string;
  18361. shader: string;
  18362. };
  18363. }
  18364. declare module BABYLON {
  18365. /** @hidden */
  18366. export var prePassVertexDeclaration: {
  18367. name: string;
  18368. shader: string;
  18369. };
  18370. }
  18371. declare module BABYLON {
  18372. /** @hidden */
  18373. export var bumpVertexDeclaration: {
  18374. name: string;
  18375. shader: string;
  18376. };
  18377. }
  18378. declare module BABYLON {
  18379. /** @hidden */
  18380. export var fogVertexDeclaration: {
  18381. name: string;
  18382. shader: string;
  18383. };
  18384. }
  18385. declare module BABYLON {
  18386. /** @hidden */
  18387. export var morphTargetsVertexGlobalDeclaration: {
  18388. name: string;
  18389. shader: string;
  18390. };
  18391. }
  18392. declare module BABYLON {
  18393. /** @hidden */
  18394. export var morphTargetsVertexDeclaration: {
  18395. name: string;
  18396. shader: string;
  18397. };
  18398. }
  18399. declare module BABYLON {
  18400. /** @hidden */
  18401. export var morphTargetsVertex: {
  18402. name: string;
  18403. shader: string;
  18404. };
  18405. }
  18406. declare module BABYLON {
  18407. /** @hidden */
  18408. export var instancesVertex: {
  18409. name: string;
  18410. shader: string;
  18411. };
  18412. }
  18413. declare module BABYLON {
  18414. /** @hidden */
  18415. export var bonesVertex: {
  18416. name: string;
  18417. shader: string;
  18418. };
  18419. }
  18420. declare module BABYLON {
  18421. /** @hidden */
  18422. export var prePassVertex: {
  18423. name: string;
  18424. shader: string;
  18425. };
  18426. }
  18427. declare module BABYLON {
  18428. /** @hidden */
  18429. export var bumpVertex: {
  18430. name: string;
  18431. shader: string;
  18432. };
  18433. }
  18434. declare module BABYLON {
  18435. /** @hidden */
  18436. export var fogVertex: {
  18437. name: string;
  18438. shader: string;
  18439. };
  18440. }
  18441. declare module BABYLON {
  18442. /** @hidden */
  18443. export var shadowsVertex: {
  18444. name: string;
  18445. shader: string;
  18446. };
  18447. }
  18448. declare module BABYLON {
  18449. /** @hidden */
  18450. export var pointCloudVertex: {
  18451. name: string;
  18452. shader: string;
  18453. };
  18454. }
  18455. declare module BABYLON {
  18456. /** @hidden */
  18457. export var logDepthVertex: {
  18458. name: string;
  18459. shader: string;
  18460. };
  18461. }
  18462. declare module BABYLON {
  18463. /** @hidden */
  18464. export var defaultVertexShader: {
  18465. name: string;
  18466. shader: string;
  18467. };
  18468. }
  18469. declare module BABYLON {
  18470. /**
  18471. * @hidden
  18472. */
  18473. export interface IMaterialDetailMapDefines {
  18474. DETAIL: boolean;
  18475. DETAILDIRECTUV: number;
  18476. DETAIL_NORMALBLENDMETHOD: number;
  18477. /** @hidden */
  18478. _areTexturesDirty: boolean;
  18479. }
  18480. /**
  18481. * Define the code related to the detail map parameters of a material
  18482. *
  18483. * Inspired from:
  18484. * Unity: https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@9.0/manual/Mask-Map-and-Detail-Map.html and https://docs.unity3d.com/Manual/StandardShaderMaterialParameterDetail.html
  18485. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  18486. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  18487. */
  18488. export class DetailMapConfiguration {
  18489. private _texture;
  18490. /**
  18491. * The detail texture of the material.
  18492. */
  18493. texture: Nullable<BaseTexture>;
  18494. /**
  18495. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  18496. * Bigger values mean stronger blending
  18497. */
  18498. diffuseBlendLevel: number;
  18499. /**
  18500. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  18501. * Bigger values mean stronger blending. Only used with PBR materials
  18502. */
  18503. roughnessBlendLevel: number;
  18504. /**
  18505. * Defines how strong the bump effect from the detail map is
  18506. * Bigger values mean stronger effect
  18507. */
  18508. bumpLevel: number;
  18509. private _normalBlendMethod;
  18510. /**
  18511. * The method used to blend the bump and detail normals together
  18512. */
  18513. normalBlendMethod: number;
  18514. private _isEnabled;
  18515. /**
  18516. * Enable or disable the detail map on this material
  18517. */
  18518. isEnabled: boolean;
  18519. /** @hidden */
  18520. private _internalMarkAllSubMeshesAsTexturesDirty;
  18521. /** @hidden */
  18522. _markAllSubMeshesAsTexturesDirty(): void;
  18523. /**
  18524. * Instantiate a new detail map
  18525. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  18526. */
  18527. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  18528. /**
  18529. * Gets whether the submesh is ready to be used or not.
  18530. * @param defines the list of "defines" to update.
  18531. * @param scene defines the scene the material belongs to.
  18532. * @returns - boolean indicating that the submesh is ready or not.
  18533. */
  18534. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  18535. /**
  18536. * Update the defines for detail map usage
  18537. * @param defines the list of "defines" to update.
  18538. * @param scene defines the scene the material belongs to.
  18539. */
  18540. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  18541. /**
  18542. * Binds the material data.
  18543. * @param uniformBuffer defines the Uniform buffer to fill in.
  18544. * @param scene defines the scene the material belongs to.
  18545. * @param isFrozen defines whether the material is frozen or not.
  18546. */
  18547. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  18548. /**
  18549. * Checks to see if a texture is used in the material.
  18550. * @param texture - Base texture to use.
  18551. * @returns - Boolean specifying if a texture is used in the material.
  18552. */
  18553. hasTexture(texture: BaseTexture): boolean;
  18554. /**
  18555. * Returns an array of the actively used textures.
  18556. * @param activeTextures Array of BaseTextures
  18557. */
  18558. getActiveTextures(activeTextures: BaseTexture[]): void;
  18559. /**
  18560. * Returns the animatable textures.
  18561. * @param animatables Array of animatable textures.
  18562. */
  18563. getAnimatables(animatables: IAnimatable[]): void;
  18564. /**
  18565. * Disposes the resources of the material.
  18566. * @param forceDisposeTextures - Forces the disposal of all textures.
  18567. */
  18568. dispose(forceDisposeTextures?: boolean): void;
  18569. /**
  18570. * Get the current class name useful for serialization or dynamic coding.
  18571. * @returns "DetailMap"
  18572. */
  18573. getClassName(): string;
  18574. /**
  18575. * Add the required uniforms to the current list.
  18576. * @param uniforms defines the current uniform list.
  18577. */
  18578. static AddUniforms(uniforms: string[]): void;
  18579. /**
  18580. * Add the required samplers to the current list.
  18581. * @param samplers defines the current sampler list.
  18582. */
  18583. static AddSamplers(samplers: string[]): void;
  18584. /**
  18585. * Add the required uniforms to the current buffer.
  18586. * @param uniformBuffer defines the current uniform buffer.
  18587. */
  18588. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  18589. /**
  18590. * Makes a duplicate of the current instance into another one.
  18591. * @param detailMap define the instance where to copy the info
  18592. */
  18593. copyTo(detailMap: DetailMapConfiguration): void;
  18594. /**
  18595. * Serializes this detail map instance
  18596. * @returns - An object with the serialized instance.
  18597. */
  18598. serialize(): any;
  18599. /**
  18600. * Parses a detail map setting from a serialized object.
  18601. * @param source - Serialized object.
  18602. * @param scene Defines the scene we are parsing for
  18603. * @param rootUrl Defines the rootUrl to load from
  18604. */
  18605. parse(source: any, scene: Scene, rootUrl: string): void;
  18606. }
  18607. }
  18608. declare module BABYLON {
  18609. /** @hidden */
  18610. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  18611. MAINUV1: boolean;
  18612. MAINUV2: boolean;
  18613. DIFFUSE: boolean;
  18614. DIFFUSEDIRECTUV: number;
  18615. DETAIL: boolean;
  18616. DETAILDIRECTUV: number;
  18617. DETAIL_NORMALBLENDMETHOD: number;
  18618. AMBIENT: boolean;
  18619. AMBIENTDIRECTUV: number;
  18620. OPACITY: boolean;
  18621. OPACITYDIRECTUV: number;
  18622. OPACITYRGB: boolean;
  18623. REFLECTION: boolean;
  18624. EMISSIVE: boolean;
  18625. EMISSIVEDIRECTUV: number;
  18626. SPECULAR: boolean;
  18627. SPECULARDIRECTUV: number;
  18628. BUMP: boolean;
  18629. BUMPDIRECTUV: number;
  18630. PARALLAX: boolean;
  18631. PARALLAXOCCLUSION: boolean;
  18632. SPECULAROVERALPHA: boolean;
  18633. CLIPPLANE: boolean;
  18634. CLIPPLANE2: boolean;
  18635. CLIPPLANE3: boolean;
  18636. CLIPPLANE4: boolean;
  18637. CLIPPLANE5: boolean;
  18638. CLIPPLANE6: boolean;
  18639. ALPHATEST: boolean;
  18640. DEPTHPREPASS: boolean;
  18641. ALPHAFROMDIFFUSE: boolean;
  18642. POINTSIZE: boolean;
  18643. FOG: boolean;
  18644. SPECULARTERM: boolean;
  18645. DIFFUSEFRESNEL: boolean;
  18646. OPACITYFRESNEL: boolean;
  18647. REFLECTIONFRESNEL: boolean;
  18648. REFRACTIONFRESNEL: boolean;
  18649. EMISSIVEFRESNEL: boolean;
  18650. FRESNEL: boolean;
  18651. NORMAL: boolean;
  18652. UV1: boolean;
  18653. UV2: boolean;
  18654. VERTEXCOLOR: boolean;
  18655. VERTEXALPHA: boolean;
  18656. NUM_BONE_INFLUENCERS: number;
  18657. BonesPerMesh: number;
  18658. BONETEXTURE: boolean;
  18659. BONES_VELOCITY_ENABLED: boolean;
  18660. INSTANCES: boolean;
  18661. THIN_INSTANCES: boolean;
  18662. GLOSSINESS: boolean;
  18663. ROUGHNESS: boolean;
  18664. EMISSIVEASILLUMINATION: boolean;
  18665. LINKEMISSIVEWITHDIFFUSE: boolean;
  18666. REFLECTIONFRESNELFROMSPECULAR: boolean;
  18667. LIGHTMAP: boolean;
  18668. LIGHTMAPDIRECTUV: number;
  18669. OBJECTSPACE_NORMALMAP: boolean;
  18670. USELIGHTMAPASSHADOWMAP: boolean;
  18671. REFLECTIONMAP_3D: boolean;
  18672. REFLECTIONMAP_SPHERICAL: boolean;
  18673. REFLECTIONMAP_PLANAR: boolean;
  18674. REFLECTIONMAP_CUBIC: boolean;
  18675. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  18676. REFLECTIONMAP_PROJECTION: boolean;
  18677. REFLECTIONMAP_SKYBOX: boolean;
  18678. REFLECTIONMAP_EXPLICIT: boolean;
  18679. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  18680. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  18681. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  18682. INVERTCUBICMAP: boolean;
  18683. LOGARITHMICDEPTH: boolean;
  18684. REFRACTION: boolean;
  18685. REFRACTIONMAP_3D: boolean;
  18686. REFLECTIONOVERALPHA: boolean;
  18687. TWOSIDEDLIGHTING: boolean;
  18688. SHADOWFLOAT: boolean;
  18689. MORPHTARGETS: boolean;
  18690. MORPHTARGETS_NORMAL: boolean;
  18691. MORPHTARGETS_TANGENT: boolean;
  18692. MORPHTARGETS_UV: boolean;
  18693. NUM_MORPH_INFLUENCERS: number;
  18694. NONUNIFORMSCALING: boolean;
  18695. PREMULTIPLYALPHA: boolean;
  18696. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  18697. ALPHABLEND: boolean;
  18698. PREPASS: boolean;
  18699. PREPASS_IRRADIANCE: boolean;
  18700. PREPASS_IRRADIANCE_INDEX: number;
  18701. PREPASS_ALBEDO: boolean;
  18702. PREPASS_ALBEDO_INDEX: number;
  18703. PREPASS_DEPTHNORMAL: boolean;
  18704. PREPASS_DEPTHNORMAL_INDEX: number;
  18705. PREPASS_POSITION: boolean;
  18706. PREPASS_POSITION_INDEX: number;
  18707. PREPASS_VELOCITY: boolean;
  18708. PREPASS_VELOCITY_INDEX: number;
  18709. PREPASS_REFLECTIVITY: boolean;
  18710. PREPASS_REFLECTIVITY_INDEX: number;
  18711. SCENE_MRT_COUNT: number;
  18712. RGBDLIGHTMAP: boolean;
  18713. RGBDREFLECTION: boolean;
  18714. RGBDREFRACTION: boolean;
  18715. IMAGEPROCESSING: boolean;
  18716. VIGNETTE: boolean;
  18717. VIGNETTEBLENDMODEMULTIPLY: boolean;
  18718. VIGNETTEBLENDMODEOPAQUE: boolean;
  18719. TONEMAPPING: boolean;
  18720. TONEMAPPING_ACES: boolean;
  18721. CONTRAST: boolean;
  18722. COLORCURVES: boolean;
  18723. COLORGRADING: boolean;
  18724. COLORGRADING3D: boolean;
  18725. SAMPLER3DGREENDEPTH: boolean;
  18726. SAMPLER3DBGRMAP: boolean;
  18727. IMAGEPROCESSINGPOSTPROCESS: boolean;
  18728. MULTIVIEW: boolean;
  18729. /**
  18730. * If the reflection texture on this material is in linear color space
  18731. * @hidden
  18732. */
  18733. IS_REFLECTION_LINEAR: boolean;
  18734. /**
  18735. * If the refraction texture on this material is in linear color space
  18736. * @hidden
  18737. */
  18738. IS_REFRACTION_LINEAR: boolean;
  18739. EXPOSURE: boolean;
  18740. constructor();
  18741. setReflectionMode(modeToEnable: string): void;
  18742. }
  18743. /**
  18744. * This is the default material used in Babylon. It is the best trade off between quality
  18745. * and performances.
  18746. * @see https://doc.babylonjs.com/babylon101/materials
  18747. */
  18748. export class StandardMaterial extends PushMaterial {
  18749. private _diffuseTexture;
  18750. /**
  18751. * The basic texture of the material as viewed under a light.
  18752. */
  18753. diffuseTexture: Nullable<BaseTexture>;
  18754. private _ambientTexture;
  18755. /**
  18756. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  18757. */
  18758. ambientTexture: Nullable<BaseTexture>;
  18759. private _opacityTexture;
  18760. /**
  18761. * Define the transparency of the material from a texture.
  18762. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  18763. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  18764. */
  18765. opacityTexture: Nullable<BaseTexture>;
  18766. private _reflectionTexture;
  18767. /**
  18768. * Define the texture used to display the reflection.
  18769. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  18770. */
  18771. reflectionTexture: Nullable<BaseTexture>;
  18772. private _emissiveTexture;
  18773. /**
  18774. * Define texture of the material as if self lit.
  18775. * This will be mixed in the final result even in the absence of light.
  18776. */
  18777. emissiveTexture: Nullable<BaseTexture>;
  18778. private _specularTexture;
  18779. /**
  18780. * Define how the color and intensity of the highlight given by the light in the material.
  18781. */
  18782. specularTexture: Nullable<BaseTexture>;
  18783. private _bumpTexture;
  18784. /**
  18785. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  18786. * 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.
  18787. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  18788. */
  18789. bumpTexture: Nullable<BaseTexture>;
  18790. private _lightmapTexture;
  18791. /**
  18792. * Complex lighting can be computationally expensive to compute at runtime.
  18793. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  18794. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  18795. */
  18796. lightmapTexture: Nullable<BaseTexture>;
  18797. private _refractionTexture;
  18798. /**
  18799. * Define the texture used to display the refraction.
  18800. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  18801. */
  18802. refractionTexture: Nullable<BaseTexture>;
  18803. /**
  18804. * The color of the material lit by the environmental background lighting.
  18805. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  18806. */
  18807. ambientColor: Color3;
  18808. /**
  18809. * The basic color of the material as viewed under a light.
  18810. */
  18811. diffuseColor: Color3;
  18812. /**
  18813. * Define how the color and intensity of the highlight given by the light in the material.
  18814. */
  18815. specularColor: Color3;
  18816. /**
  18817. * Define the color of the material as if self lit.
  18818. * This will be mixed in the final result even in the absence of light.
  18819. */
  18820. emissiveColor: Color3;
  18821. /**
  18822. * Defines how sharp are the highlights in the material.
  18823. * The bigger the value the sharper giving a more glossy feeling to the result.
  18824. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  18825. */
  18826. specularPower: number;
  18827. private _useAlphaFromDiffuseTexture;
  18828. /**
  18829. * Does the transparency come from the diffuse texture alpha channel.
  18830. */
  18831. useAlphaFromDiffuseTexture: boolean;
  18832. private _useEmissiveAsIllumination;
  18833. /**
  18834. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  18835. */
  18836. useEmissiveAsIllumination: boolean;
  18837. private _linkEmissiveWithDiffuse;
  18838. /**
  18839. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  18840. * the emissive level when the final color is close to one.
  18841. */
  18842. linkEmissiveWithDiffuse: boolean;
  18843. private _useSpecularOverAlpha;
  18844. /**
  18845. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  18846. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  18847. */
  18848. useSpecularOverAlpha: boolean;
  18849. private _useReflectionOverAlpha;
  18850. /**
  18851. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  18852. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  18853. */
  18854. useReflectionOverAlpha: boolean;
  18855. private _disableLighting;
  18856. /**
  18857. * Does lights from the scene impacts this material.
  18858. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  18859. */
  18860. disableLighting: boolean;
  18861. private _useObjectSpaceNormalMap;
  18862. /**
  18863. * Allows using an object space normal map (instead of tangent space).
  18864. */
  18865. useObjectSpaceNormalMap: boolean;
  18866. private _useParallax;
  18867. /**
  18868. * Is parallax enabled or not.
  18869. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  18870. */
  18871. useParallax: boolean;
  18872. private _useParallaxOcclusion;
  18873. /**
  18874. * Is parallax occlusion enabled or not.
  18875. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  18876. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  18877. */
  18878. useParallaxOcclusion: boolean;
  18879. /**
  18880. * 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.
  18881. */
  18882. parallaxScaleBias: number;
  18883. private _roughness;
  18884. /**
  18885. * Helps to define how blurry the reflections should appears in the material.
  18886. */
  18887. roughness: number;
  18888. /**
  18889. * In case of refraction, define the value of the index of refraction.
  18890. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  18891. */
  18892. indexOfRefraction: number;
  18893. /**
  18894. * Invert the refraction texture alongside the y axis.
  18895. * It can be useful with procedural textures or probe for instance.
  18896. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  18897. */
  18898. invertRefractionY: boolean;
  18899. /**
  18900. * Defines the alpha limits in alpha test mode.
  18901. */
  18902. alphaCutOff: number;
  18903. private _useLightmapAsShadowmap;
  18904. /**
  18905. * In case of light mapping, define whether the map contains light or shadow informations.
  18906. */
  18907. useLightmapAsShadowmap: boolean;
  18908. private _diffuseFresnelParameters;
  18909. /**
  18910. * Define the diffuse fresnel parameters of the material.
  18911. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  18912. */
  18913. diffuseFresnelParameters: FresnelParameters;
  18914. private _opacityFresnelParameters;
  18915. /**
  18916. * Define the opacity fresnel parameters of the material.
  18917. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  18918. */
  18919. opacityFresnelParameters: FresnelParameters;
  18920. private _reflectionFresnelParameters;
  18921. /**
  18922. * Define the reflection fresnel parameters of the material.
  18923. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  18924. */
  18925. reflectionFresnelParameters: FresnelParameters;
  18926. private _refractionFresnelParameters;
  18927. /**
  18928. * Define the refraction fresnel parameters of the material.
  18929. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  18930. */
  18931. refractionFresnelParameters: FresnelParameters;
  18932. private _emissiveFresnelParameters;
  18933. /**
  18934. * Define the emissive fresnel parameters of the material.
  18935. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  18936. */
  18937. emissiveFresnelParameters: FresnelParameters;
  18938. private _useReflectionFresnelFromSpecular;
  18939. /**
  18940. * If true automatically deducts the fresnels values from the material specularity.
  18941. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  18942. */
  18943. useReflectionFresnelFromSpecular: boolean;
  18944. private _useGlossinessFromSpecularMapAlpha;
  18945. /**
  18946. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  18947. */
  18948. useGlossinessFromSpecularMapAlpha: boolean;
  18949. private _maxSimultaneousLights;
  18950. /**
  18951. * Defines the maximum number of lights that can be used in the material
  18952. */
  18953. maxSimultaneousLights: number;
  18954. private _invertNormalMapX;
  18955. /**
  18956. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  18957. */
  18958. invertNormalMapX: boolean;
  18959. private _invertNormalMapY;
  18960. /**
  18961. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  18962. */
  18963. invertNormalMapY: boolean;
  18964. private _twoSidedLighting;
  18965. /**
  18966. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  18967. */
  18968. twoSidedLighting: boolean;
  18969. /**
  18970. * Default configuration related to image processing available in the standard Material.
  18971. */
  18972. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  18973. /**
  18974. * Gets the image processing configuration used either in this material.
  18975. */
  18976. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  18977. /**
  18978. * Sets the Default image processing configuration used either in the this material.
  18979. *
  18980. * If sets to null, the scene one is in use.
  18981. */
  18982. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  18983. /**
  18984. * Keep track of the image processing observer to allow dispose and replace.
  18985. */
  18986. private _imageProcessingObserver;
  18987. /**
  18988. * Attaches a new image processing configuration to the Standard Material.
  18989. * @param configuration
  18990. */
  18991. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  18992. /**
  18993. * Defines additionnal PrePass parameters for the material.
  18994. */
  18995. readonly prePassConfiguration: PrePassConfiguration;
  18996. /**
  18997. * Gets wether the color curves effect is enabled.
  18998. */
  18999. get cameraColorCurvesEnabled(): boolean;
  19000. /**
  19001. * Sets wether the color curves effect is enabled.
  19002. */
  19003. set cameraColorCurvesEnabled(value: boolean);
  19004. /**
  19005. * Gets wether the color grading effect is enabled.
  19006. */
  19007. get cameraColorGradingEnabled(): boolean;
  19008. /**
  19009. * Gets wether the color grading effect is enabled.
  19010. */
  19011. set cameraColorGradingEnabled(value: boolean);
  19012. /**
  19013. * Gets wether tonemapping is enabled or not.
  19014. */
  19015. get cameraToneMappingEnabled(): boolean;
  19016. /**
  19017. * Sets wether tonemapping is enabled or not
  19018. */
  19019. set cameraToneMappingEnabled(value: boolean);
  19020. /**
  19021. * The camera exposure used on this material.
  19022. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  19023. * This corresponds to a photographic exposure.
  19024. */
  19025. get cameraExposure(): number;
  19026. /**
  19027. * The camera exposure used on this material.
  19028. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  19029. * This corresponds to a photographic exposure.
  19030. */
  19031. set cameraExposure(value: number);
  19032. /**
  19033. * Gets The camera contrast used on this material.
  19034. */
  19035. get cameraContrast(): number;
  19036. /**
  19037. * Sets The camera contrast used on this material.
  19038. */
  19039. set cameraContrast(value: number);
  19040. /**
  19041. * Gets the Color Grading 2D Lookup Texture.
  19042. */
  19043. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  19044. /**
  19045. * Sets the Color Grading 2D Lookup Texture.
  19046. */
  19047. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  19048. /**
  19049. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  19050. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  19051. * 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;
  19052. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  19053. */
  19054. get cameraColorCurves(): Nullable<ColorCurves>;
  19055. /**
  19056. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  19057. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  19058. * 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;
  19059. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  19060. */
  19061. set cameraColorCurves(value: Nullable<ColorCurves>);
  19062. /**
  19063. * Can this material render to several textures at once
  19064. */
  19065. get canRenderToMRT(): boolean;
  19066. /**
  19067. * Defines the detail map parameters for the material.
  19068. */
  19069. readonly detailMap: DetailMapConfiguration;
  19070. protected _renderTargets: SmartArray<RenderTargetTexture>;
  19071. protected _worldViewProjectionMatrix: Matrix;
  19072. protected _globalAmbientColor: Color3;
  19073. protected _useLogarithmicDepth: boolean;
  19074. protected _rebuildInParallel: boolean;
  19075. /**
  19076. * Instantiates a new standard material.
  19077. * This is the default material used in Babylon. It is the best trade off between quality
  19078. * and performances.
  19079. * @see https://doc.babylonjs.com/babylon101/materials
  19080. * @param name Define the name of the material in the scene
  19081. * @param scene Define the scene the material belong to
  19082. */
  19083. constructor(name: string, scene: Scene);
  19084. /**
  19085. * Gets a boolean indicating that current material needs to register RTT
  19086. */
  19087. get hasRenderTargetTextures(): boolean;
  19088. /**
  19089. * Gets the current class name of the material e.g. "StandardMaterial"
  19090. * Mainly use in serialization.
  19091. * @returns the class name
  19092. */
  19093. getClassName(): string;
  19094. /**
  19095. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  19096. * You can try switching to logarithmic depth.
  19097. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  19098. */
  19099. get useLogarithmicDepth(): boolean;
  19100. set useLogarithmicDepth(value: boolean);
  19101. /**
  19102. * Specifies if the material will require alpha blending
  19103. * @returns a boolean specifying if alpha blending is needed
  19104. */
  19105. needAlphaBlending(): boolean;
  19106. /**
  19107. * Specifies if this material should be rendered in alpha test mode
  19108. * @returns a boolean specifying if an alpha test is needed.
  19109. */
  19110. needAlphaTesting(): boolean;
  19111. /**
  19112. * Specifies whether or not the alpha value of the diffuse texture should be used for alpha blending.
  19113. */
  19114. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  19115. /**
  19116. * Specifies whether or not there is a usable alpha channel for transparency.
  19117. */
  19118. protected _hasAlphaChannel(): boolean;
  19119. /**
  19120. * Get the texture used for alpha test purpose.
  19121. * @returns the diffuse texture in case of the standard material.
  19122. */
  19123. getAlphaTestTexture(): Nullable<BaseTexture>;
  19124. /**
  19125. * Get if the submesh is ready to be used and all its information available.
  19126. * Child classes can use it to update shaders
  19127. * @param mesh defines the mesh to check
  19128. * @param subMesh defines which submesh to check
  19129. * @param useInstances specifies that instances should be used
  19130. * @returns a boolean indicating that the submesh is ready or not
  19131. */
  19132. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  19133. /**
  19134. * Builds the material UBO layouts.
  19135. * Used internally during the effect preparation.
  19136. */
  19137. buildUniformLayout(): void;
  19138. /**
  19139. * Unbinds the material from the mesh
  19140. */
  19141. unbind(): void;
  19142. /**
  19143. * Binds the submesh to this material by preparing the effect and shader to draw
  19144. * @param world defines the world transformation matrix
  19145. * @param mesh defines the mesh containing the submesh
  19146. * @param subMesh defines the submesh to bind the material to
  19147. */
  19148. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  19149. /**
  19150. * Get the list of animatables in the material.
  19151. * @returns the list of animatables object used in the material
  19152. */
  19153. getAnimatables(): IAnimatable[];
  19154. /**
  19155. * Gets the active textures from the material
  19156. * @returns an array of textures
  19157. */
  19158. getActiveTextures(): BaseTexture[];
  19159. /**
  19160. * Specifies if the material uses a texture
  19161. * @param texture defines the texture to check against the material
  19162. * @returns a boolean specifying if the material uses the texture
  19163. */
  19164. hasTexture(texture: BaseTexture): boolean;
  19165. /**
  19166. * Disposes the material
  19167. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  19168. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  19169. */
  19170. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  19171. /**
  19172. * Makes a duplicate of the material, and gives it a new name
  19173. * @param name defines the new name for the duplicated material
  19174. * @returns the cloned material
  19175. */
  19176. clone(name: string): StandardMaterial;
  19177. /**
  19178. * Serializes this material in a JSON representation
  19179. * @returns the serialized material object
  19180. */
  19181. serialize(): any;
  19182. /**
  19183. * Creates a standard material from parsed material data
  19184. * @param source defines the JSON representation of the material
  19185. * @param scene defines the hosting scene
  19186. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  19187. * @returns a new standard material
  19188. */
  19189. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  19190. /**
  19191. * Are diffuse textures enabled in the application.
  19192. */
  19193. static get DiffuseTextureEnabled(): boolean;
  19194. static set DiffuseTextureEnabled(value: boolean);
  19195. /**
  19196. * Are detail textures enabled in the application.
  19197. */
  19198. static get DetailTextureEnabled(): boolean;
  19199. static set DetailTextureEnabled(value: boolean);
  19200. /**
  19201. * Are ambient textures enabled in the application.
  19202. */
  19203. static get AmbientTextureEnabled(): boolean;
  19204. static set AmbientTextureEnabled(value: boolean);
  19205. /**
  19206. * Are opacity textures enabled in the application.
  19207. */
  19208. static get OpacityTextureEnabled(): boolean;
  19209. static set OpacityTextureEnabled(value: boolean);
  19210. /**
  19211. * Are reflection textures enabled in the application.
  19212. */
  19213. static get ReflectionTextureEnabled(): boolean;
  19214. static set ReflectionTextureEnabled(value: boolean);
  19215. /**
  19216. * Are emissive textures enabled in the application.
  19217. */
  19218. static get EmissiveTextureEnabled(): boolean;
  19219. static set EmissiveTextureEnabled(value: boolean);
  19220. /**
  19221. * Are specular textures enabled in the application.
  19222. */
  19223. static get SpecularTextureEnabled(): boolean;
  19224. static set SpecularTextureEnabled(value: boolean);
  19225. /**
  19226. * Are bump textures enabled in the application.
  19227. */
  19228. static get BumpTextureEnabled(): boolean;
  19229. static set BumpTextureEnabled(value: boolean);
  19230. /**
  19231. * Are lightmap textures enabled in the application.
  19232. */
  19233. static get LightmapTextureEnabled(): boolean;
  19234. static set LightmapTextureEnabled(value: boolean);
  19235. /**
  19236. * Are refraction textures enabled in the application.
  19237. */
  19238. static get RefractionTextureEnabled(): boolean;
  19239. static set RefractionTextureEnabled(value: boolean);
  19240. /**
  19241. * Are color grading textures enabled in the application.
  19242. */
  19243. static get ColorGradingTextureEnabled(): boolean;
  19244. static set ColorGradingTextureEnabled(value: boolean);
  19245. /**
  19246. * Are fresnels enabled in the application.
  19247. */
  19248. static get FresnelEnabled(): boolean;
  19249. static set FresnelEnabled(value: boolean);
  19250. }
  19251. }
  19252. declare module BABYLON {
  19253. /** @hidden */
  19254. export var rgbdDecodePixelShader: {
  19255. name: string;
  19256. shader: string;
  19257. };
  19258. }
  19259. declare module BABYLON {
  19260. /**
  19261. * Class used to host RGBD texture specific utilities
  19262. */
  19263. export class RGBDTextureTools {
  19264. /**
  19265. * Expand the RGBD Texture from RGBD to Half Float if possible.
  19266. * @param texture the texture to expand.
  19267. */
  19268. static ExpandRGBDTexture(texture: Texture): void;
  19269. }
  19270. }
  19271. declare module BABYLON {
  19272. /**
  19273. * Class used to host texture specific utilities
  19274. */
  19275. export class BRDFTextureTools {
  19276. /**
  19277. * Prevents texture cache collision
  19278. */
  19279. private static _instanceNumber;
  19280. /**
  19281. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  19282. * @param scene defines the hosting scene
  19283. * @returns the environment BRDF texture
  19284. */
  19285. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  19286. private static _environmentBRDFBase64Texture;
  19287. }
  19288. }
  19289. declare module BABYLON {
  19290. /**
  19291. * @hidden
  19292. */
  19293. export interface IMaterialClearCoatDefines {
  19294. CLEARCOAT: boolean;
  19295. CLEARCOAT_DEFAULTIOR: boolean;
  19296. CLEARCOAT_TEXTURE: boolean;
  19297. CLEARCOAT_TEXTURE_ROUGHNESS: boolean;
  19298. CLEARCOAT_TEXTUREDIRECTUV: number;
  19299. CLEARCOAT_TEXTURE_ROUGHNESSDIRECTUV: number;
  19300. CLEARCOAT_BUMP: boolean;
  19301. CLEARCOAT_BUMPDIRECTUV: number;
  19302. CLEARCOAT_USE_ROUGHNESS_FROM_MAINTEXTURE: boolean;
  19303. CLEARCOAT_TEXTURE_ROUGHNESS_IDENTICAL: boolean;
  19304. CLEARCOAT_REMAP_F0: boolean;
  19305. CLEARCOAT_TINT: boolean;
  19306. CLEARCOAT_TINT_TEXTURE: boolean;
  19307. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  19308. /** @hidden */
  19309. _areTexturesDirty: boolean;
  19310. }
  19311. /**
  19312. * Define the code related to the clear coat parameters of the pbr material.
  19313. */
  19314. export class PBRClearCoatConfiguration {
  19315. /**
  19316. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  19317. * The default fits with a polyurethane material.
  19318. * @hidden
  19319. */
  19320. static readonly _DefaultIndexOfRefraction: number;
  19321. private _isEnabled;
  19322. /**
  19323. * Defines if the clear coat is enabled in the material.
  19324. */
  19325. isEnabled: boolean;
  19326. /**
  19327. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  19328. */
  19329. intensity: number;
  19330. /**
  19331. * Defines the clear coat layer roughness.
  19332. */
  19333. roughness: number;
  19334. private _indexOfRefraction;
  19335. /**
  19336. * Defines the index of refraction of the clear coat.
  19337. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  19338. * The default fits with a polyurethane material.
  19339. * Changing the default value is more performance intensive.
  19340. */
  19341. indexOfRefraction: number;
  19342. private _texture;
  19343. /**
  19344. * Stores the clear coat values in a texture (red channel is intensity and green channel is roughness)
  19345. * If useRoughnessFromMainTexture is false, the green channel of texture is not used and the green channel of textureRoughness is used instead
  19346. * if textureRoughness is not empty, else no texture roughness is used
  19347. */
  19348. texture: Nullable<BaseTexture>;
  19349. private _useRoughnessFromMainTexture;
  19350. /**
  19351. * Indicates that the green channel of the texture property will be used for roughness (default: true)
  19352. * If false, the green channel from textureRoughness is used for roughness
  19353. */
  19354. useRoughnessFromMainTexture: boolean;
  19355. private _textureRoughness;
  19356. /**
  19357. * Stores the clear coat roughness in a texture (green channel)
  19358. * Not used if useRoughnessFromMainTexture is true
  19359. */
  19360. textureRoughness: Nullable<BaseTexture>;
  19361. private _remapF0OnInterfaceChange;
  19362. /**
  19363. * Defines if the F0 value should be remapped to account for the interface change in the material.
  19364. */
  19365. remapF0OnInterfaceChange: boolean;
  19366. private _bumpTexture;
  19367. /**
  19368. * Define the clear coat specific bump texture.
  19369. */
  19370. bumpTexture: Nullable<BaseTexture>;
  19371. private _isTintEnabled;
  19372. /**
  19373. * Defines if the clear coat tint is enabled in the material.
  19374. */
  19375. isTintEnabled: boolean;
  19376. /**
  19377. * Defines the clear coat tint of the material.
  19378. * This is only use if tint is enabled
  19379. */
  19380. tintColor: Color3;
  19381. /**
  19382. * Defines the distance at which the tint color should be found in the
  19383. * clear coat media.
  19384. * This is only use if tint is enabled
  19385. */
  19386. tintColorAtDistance: number;
  19387. /**
  19388. * Defines the clear coat layer thickness.
  19389. * This is only use if tint is enabled
  19390. */
  19391. tintThickness: number;
  19392. private _tintTexture;
  19393. /**
  19394. * Stores the clear tint values in a texture.
  19395. * rgb is tint
  19396. * a is a thickness factor
  19397. */
  19398. tintTexture: Nullable<BaseTexture>;
  19399. /** @hidden */
  19400. private _internalMarkAllSubMeshesAsTexturesDirty;
  19401. /** @hidden */
  19402. _markAllSubMeshesAsTexturesDirty(): void;
  19403. /**
  19404. * Instantiate a new istance of clear coat configuration.
  19405. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  19406. */
  19407. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  19408. /**
  19409. * Gets wehter the submesh is ready to be used or not.
  19410. * @param defines the list of "defines" to update.
  19411. * @param scene defines the scene the material belongs to.
  19412. * @param engine defines the engine the material belongs to.
  19413. * @param disableBumpMap defines wether the material disables bump or not.
  19414. * @returns - boolean indicating that the submesh is ready or not.
  19415. */
  19416. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  19417. /**
  19418. * Checks to see if a texture is used in the material.
  19419. * @param defines the list of "defines" to update.
  19420. * @param scene defines the scene to the material belongs to.
  19421. */
  19422. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  19423. /**
  19424. * Binds the material data.
  19425. * @param uniformBuffer defines the Uniform buffer to fill in.
  19426. * @param scene defines the scene the material belongs to.
  19427. * @param engine defines the engine the material belongs to.
  19428. * @param disableBumpMap defines wether the material disables bump or not.
  19429. * @param isFrozen defines wether the material is frozen or not.
  19430. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  19431. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  19432. * @param subMesh the submesh to bind data for
  19433. */
  19434. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean, subMesh?: SubMesh): void;
  19435. /**
  19436. * Checks to see if a texture is used in the material.
  19437. * @param texture - Base texture to use.
  19438. * @returns - Boolean specifying if a texture is used in the material.
  19439. */
  19440. hasTexture(texture: BaseTexture): boolean;
  19441. /**
  19442. * Returns an array of the actively used textures.
  19443. * @param activeTextures Array of BaseTextures
  19444. */
  19445. getActiveTextures(activeTextures: BaseTexture[]): void;
  19446. /**
  19447. * Returns the animatable textures.
  19448. * @param animatables Array of animatable textures.
  19449. */
  19450. getAnimatables(animatables: IAnimatable[]): void;
  19451. /**
  19452. * Disposes the resources of the material.
  19453. * @param forceDisposeTextures - Forces the disposal of all textures.
  19454. */
  19455. dispose(forceDisposeTextures?: boolean): void;
  19456. /**
  19457. * Get the current class name of the texture useful for serialization or dynamic coding.
  19458. * @returns "PBRClearCoatConfiguration"
  19459. */
  19460. getClassName(): string;
  19461. /**
  19462. * Add fallbacks to the effect fallbacks list.
  19463. * @param defines defines the Base texture to use.
  19464. * @param fallbacks defines the current fallback list.
  19465. * @param currentRank defines the current fallback rank.
  19466. * @returns the new fallback rank.
  19467. */
  19468. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  19469. /**
  19470. * Add the required uniforms to the current list.
  19471. * @param uniforms defines the current uniform list.
  19472. */
  19473. static AddUniforms(uniforms: string[]): void;
  19474. /**
  19475. * Add the required samplers to the current list.
  19476. * @param samplers defines the current sampler list.
  19477. */
  19478. static AddSamplers(samplers: string[]): void;
  19479. /**
  19480. * Add the required uniforms to the current buffer.
  19481. * @param uniformBuffer defines the current uniform buffer.
  19482. */
  19483. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  19484. /**
  19485. * Makes a duplicate of the current configuration into another one.
  19486. * @param clearCoatConfiguration define the config where to copy the info
  19487. */
  19488. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  19489. /**
  19490. * Serializes this clear coat configuration.
  19491. * @returns - An object with the serialized config.
  19492. */
  19493. serialize(): any;
  19494. /**
  19495. * Parses a anisotropy Configuration from a serialized object.
  19496. * @param source - Serialized object.
  19497. * @param scene Defines the scene we are parsing for
  19498. * @param rootUrl Defines the rootUrl to load from
  19499. */
  19500. parse(source: any, scene: Scene, rootUrl: string): void;
  19501. }
  19502. }
  19503. declare module BABYLON {
  19504. /**
  19505. * @hidden
  19506. */
  19507. export interface IMaterialAnisotropicDefines {
  19508. ANISOTROPIC: boolean;
  19509. ANISOTROPIC_TEXTURE: boolean;
  19510. ANISOTROPIC_TEXTUREDIRECTUV: number;
  19511. MAINUV1: boolean;
  19512. _areTexturesDirty: boolean;
  19513. _needUVs: boolean;
  19514. }
  19515. /**
  19516. * Define the code related to the anisotropic parameters of the pbr material.
  19517. */
  19518. export class PBRAnisotropicConfiguration {
  19519. private _isEnabled;
  19520. /**
  19521. * Defines if the anisotropy is enabled in the material.
  19522. */
  19523. isEnabled: boolean;
  19524. /**
  19525. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  19526. */
  19527. intensity: number;
  19528. /**
  19529. * Defines if the effect is along the tangents, bitangents or in between.
  19530. * By default, the effect is "strectching" the highlights along the tangents.
  19531. */
  19532. direction: Vector2;
  19533. private _texture;
  19534. /**
  19535. * Stores the anisotropy values in a texture.
  19536. * rg is direction (like normal from -1 to 1)
  19537. * b is a intensity
  19538. */
  19539. texture: Nullable<BaseTexture>;
  19540. /** @hidden */
  19541. private _internalMarkAllSubMeshesAsTexturesDirty;
  19542. /** @hidden */
  19543. _markAllSubMeshesAsTexturesDirty(): void;
  19544. /**
  19545. * Instantiate a new istance of anisotropy configuration.
  19546. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  19547. */
  19548. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  19549. /**
  19550. * Specifies that the submesh is ready to be used.
  19551. * @param defines the list of "defines" to update.
  19552. * @param scene defines the scene the material belongs to.
  19553. * @returns - boolean indicating that the submesh is ready or not.
  19554. */
  19555. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  19556. /**
  19557. * Checks to see if a texture is used in the material.
  19558. * @param defines the list of "defines" to update.
  19559. * @param mesh the mesh we are preparing the defines for.
  19560. * @param scene defines the scene the material belongs to.
  19561. */
  19562. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  19563. /**
  19564. * Binds the material data.
  19565. * @param uniformBuffer defines the Uniform buffer to fill in.
  19566. * @param scene defines the scene the material belongs to.
  19567. * @param isFrozen defines wether the material is frozen or not.
  19568. */
  19569. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  19570. /**
  19571. * Checks to see if a texture is used in the material.
  19572. * @param texture - Base texture to use.
  19573. * @returns - Boolean specifying if a texture is used in the material.
  19574. */
  19575. hasTexture(texture: BaseTexture): boolean;
  19576. /**
  19577. * Returns an array of the actively used textures.
  19578. * @param activeTextures Array of BaseTextures
  19579. */
  19580. getActiveTextures(activeTextures: BaseTexture[]): void;
  19581. /**
  19582. * Returns the animatable textures.
  19583. * @param animatables Array of animatable textures.
  19584. */
  19585. getAnimatables(animatables: IAnimatable[]): void;
  19586. /**
  19587. * Disposes the resources of the material.
  19588. * @param forceDisposeTextures - Forces the disposal of all textures.
  19589. */
  19590. dispose(forceDisposeTextures?: boolean): void;
  19591. /**
  19592. * Get the current class name of the texture useful for serialization or dynamic coding.
  19593. * @returns "PBRAnisotropicConfiguration"
  19594. */
  19595. getClassName(): string;
  19596. /**
  19597. * Add fallbacks to the effect fallbacks list.
  19598. * @param defines defines the Base texture to use.
  19599. * @param fallbacks defines the current fallback list.
  19600. * @param currentRank defines the current fallback rank.
  19601. * @returns the new fallback rank.
  19602. */
  19603. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  19604. /**
  19605. * Add the required uniforms to the current list.
  19606. * @param uniforms defines the current uniform list.
  19607. */
  19608. static AddUniforms(uniforms: string[]): void;
  19609. /**
  19610. * Add the required uniforms to the current buffer.
  19611. * @param uniformBuffer defines the current uniform buffer.
  19612. */
  19613. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  19614. /**
  19615. * Add the required samplers to the current list.
  19616. * @param samplers defines the current sampler list.
  19617. */
  19618. static AddSamplers(samplers: string[]): void;
  19619. /**
  19620. * Makes a duplicate of the current configuration into another one.
  19621. * @param anisotropicConfiguration define the config where to copy the info
  19622. */
  19623. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  19624. /**
  19625. * Serializes this anisotropy configuration.
  19626. * @returns - An object with the serialized config.
  19627. */
  19628. serialize(): any;
  19629. /**
  19630. * Parses a anisotropy Configuration from a serialized object.
  19631. * @param source - Serialized object.
  19632. * @param scene Defines the scene we are parsing for
  19633. * @param rootUrl Defines the rootUrl to load from
  19634. */
  19635. parse(source: any, scene: Scene, rootUrl: string): void;
  19636. }
  19637. }
  19638. declare module BABYLON {
  19639. /**
  19640. * @hidden
  19641. */
  19642. export interface IMaterialBRDFDefines {
  19643. BRDF_V_HEIGHT_CORRELATED: boolean;
  19644. MS_BRDF_ENERGY_CONSERVATION: boolean;
  19645. SPHERICAL_HARMONICS: boolean;
  19646. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  19647. /** @hidden */
  19648. _areMiscDirty: boolean;
  19649. }
  19650. /**
  19651. * Define the code related to the BRDF parameters of the pbr material.
  19652. */
  19653. export class PBRBRDFConfiguration {
  19654. /**
  19655. * Default value used for the energy conservation.
  19656. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  19657. */
  19658. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  19659. /**
  19660. * Default value used for the Smith Visibility Height Correlated mode.
  19661. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  19662. */
  19663. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  19664. /**
  19665. * Default value used for the IBL diffuse part.
  19666. * This can help switching back to the polynomials mode globally which is a tiny bit
  19667. * less GPU intensive at the drawback of a lower quality.
  19668. */
  19669. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  19670. /**
  19671. * Default value used for activating energy conservation for the specular workflow.
  19672. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  19673. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  19674. */
  19675. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  19676. private _useEnergyConservation;
  19677. /**
  19678. * Defines if the material uses energy conservation.
  19679. */
  19680. useEnergyConservation: boolean;
  19681. private _useSmithVisibilityHeightCorrelated;
  19682. /**
  19683. * LEGACY Mode set to false
  19684. * Defines if the material uses height smith correlated visibility term.
  19685. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  19686. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  19687. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  19688. * Not relying on height correlated will also disable energy conservation.
  19689. */
  19690. useSmithVisibilityHeightCorrelated: boolean;
  19691. private _useSphericalHarmonics;
  19692. /**
  19693. * LEGACY Mode set to false
  19694. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  19695. * diffuse part of the IBL.
  19696. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  19697. * to the ground truth.
  19698. */
  19699. useSphericalHarmonics: boolean;
  19700. private _useSpecularGlossinessInputEnergyConservation;
  19701. /**
  19702. * Defines if the material uses energy conservation, when the specular workflow is active.
  19703. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  19704. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  19705. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  19706. */
  19707. useSpecularGlossinessInputEnergyConservation: boolean;
  19708. /** @hidden */
  19709. private _internalMarkAllSubMeshesAsMiscDirty;
  19710. /** @hidden */
  19711. _markAllSubMeshesAsMiscDirty(): void;
  19712. /**
  19713. * Instantiate a new istance of clear coat configuration.
  19714. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  19715. */
  19716. constructor(markAllSubMeshesAsMiscDirty: () => void);
  19717. /**
  19718. * Checks to see if a texture is used in the material.
  19719. * @param defines the list of "defines" to update.
  19720. */
  19721. prepareDefines(defines: IMaterialBRDFDefines): void;
  19722. /**
  19723. * Get the current class name of the texture useful for serialization or dynamic coding.
  19724. * @returns "PBRClearCoatConfiguration"
  19725. */
  19726. getClassName(): string;
  19727. /**
  19728. * Makes a duplicate of the current configuration into another one.
  19729. * @param brdfConfiguration define the config where to copy the info
  19730. */
  19731. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  19732. /**
  19733. * Serializes this BRDF configuration.
  19734. * @returns - An object with the serialized config.
  19735. */
  19736. serialize(): any;
  19737. /**
  19738. * Parses a anisotropy Configuration from a serialized object.
  19739. * @param source - Serialized object.
  19740. * @param scene Defines the scene we are parsing for
  19741. * @param rootUrl Defines the rootUrl to load from
  19742. */
  19743. parse(source: any, scene: Scene, rootUrl: string): void;
  19744. }
  19745. }
  19746. declare module BABYLON {
  19747. /**
  19748. * @hidden
  19749. */
  19750. export interface IMaterialSheenDefines {
  19751. SHEEN: boolean;
  19752. SHEEN_TEXTURE: boolean;
  19753. SHEEN_TEXTURE_ROUGHNESS: boolean;
  19754. SHEEN_TEXTUREDIRECTUV: number;
  19755. SHEEN_TEXTURE_ROUGHNESSDIRECTUV: number;
  19756. SHEEN_LINKWITHALBEDO: boolean;
  19757. SHEEN_ROUGHNESS: boolean;
  19758. SHEEN_ALBEDOSCALING: boolean;
  19759. SHEEN_USE_ROUGHNESS_FROM_MAINTEXTURE: boolean;
  19760. SHEEN_TEXTURE_ROUGHNESS_IDENTICAL: boolean;
  19761. /** @hidden */
  19762. _areTexturesDirty: boolean;
  19763. }
  19764. /**
  19765. * Define the code related to the Sheen parameters of the pbr material.
  19766. */
  19767. export class PBRSheenConfiguration {
  19768. private _isEnabled;
  19769. /**
  19770. * Defines if the material uses sheen.
  19771. */
  19772. isEnabled: boolean;
  19773. private _linkSheenWithAlbedo;
  19774. /**
  19775. * Defines if the sheen is linked to the sheen color.
  19776. */
  19777. linkSheenWithAlbedo: boolean;
  19778. /**
  19779. * Defines the sheen intensity.
  19780. */
  19781. intensity: number;
  19782. /**
  19783. * Defines the sheen color.
  19784. */
  19785. color: Color3;
  19786. private _texture;
  19787. /**
  19788. * Stores the sheen tint values in a texture.
  19789. * rgb is tint
  19790. * a is a intensity or roughness if the roughness property has been defined and useRoughnessFromTexture is true (in that case, textureRoughness won't be used)
  19791. * If the roughness property has been defined and useRoughnessFromTexture is false then the alpha channel is not used to modulate roughness
  19792. */
  19793. texture: Nullable<BaseTexture>;
  19794. private _useRoughnessFromMainTexture;
  19795. /**
  19796. * Indicates that the alpha channel of the texture property will be used for roughness.
  19797. * Has no effect if the roughness (and texture!) property is not defined
  19798. */
  19799. useRoughnessFromMainTexture: boolean;
  19800. private _roughness;
  19801. /**
  19802. * Defines the sheen roughness.
  19803. * It is not taken into account if linkSheenWithAlbedo is true.
  19804. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  19805. */
  19806. roughness: Nullable<number>;
  19807. private _textureRoughness;
  19808. /**
  19809. * Stores the sheen roughness in a texture.
  19810. * alpha channel is the roughness. This texture won't be used if the texture property is not empty and useRoughnessFromTexture is true
  19811. */
  19812. textureRoughness: Nullable<BaseTexture>;
  19813. private _albedoScaling;
  19814. /**
  19815. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  19816. * It allows the strength of the sheen effect to not depend on the base color of the material,
  19817. * making it easier to setup and tweak the effect
  19818. */
  19819. albedoScaling: boolean;
  19820. /** @hidden */
  19821. private _internalMarkAllSubMeshesAsTexturesDirty;
  19822. /** @hidden */
  19823. _markAllSubMeshesAsTexturesDirty(): void;
  19824. /**
  19825. * Instantiate a new istance of clear coat configuration.
  19826. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  19827. */
  19828. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  19829. /**
  19830. * Specifies that the submesh is ready to be used.
  19831. * @param defines the list of "defines" to update.
  19832. * @param scene defines the scene the material belongs to.
  19833. * @returns - boolean indicating that the submesh is ready or not.
  19834. */
  19835. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  19836. /**
  19837. * Checks to see if a texture is used in the material.
  19838. * @param defines the list of "defines" to update.
  19839. * @param scene defines the scene the material belongs to.
  19840. */
  19841. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  19842. /**
  19843. * Binds the material data.
  19844. * @param uniformBuffer defines the Uniform buffer to fill in.
  19845. * @param scene defines the scene the material belongs to.
  19846. * @param isFrozen defines wether the material is frozen or not.
  19847. * @param subMesh the submesh to bind data for
  19848. */
  19849. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean, subMesh?: SubMesh): void;
  19850. /**
  19851. * Checks to see if a texture is used in the material.
  19852. * @param texture - Base texture to use.
  19853. * @returns - Boolean specifying if a texture is used in the material.
  19854. */
  19855. hasTexture(texture: BaseTexture): boolean;
  19856. /**
  19857. * Returns an array of the actively used textures.
  19858. * @param activeTextures Array of BaseTextures
  19859. */
  19860. getActiveTextures(activeTextures: BaseTexture[]): void;
  19861. /**
  19862. * Returns the animatable textures.
  19863. * @param animatables Array of animatable textures.
  19864. */
  19865. getAnimatables(animatables: IAnimatable[]): void;
  19866. /**
  19867. * Disposes the resources of the material.
  19868. * @param forceDisposeTextures - Forces the disposal of all textures.
  19869. */
  19870. dispose(forceDisposeTextures?: boolean): void;
  19871. /**
  19872. * Get the current class name of the texture useful for serialization or dynamic coding.
  19873. * @returns "PBRSheenConfiguration"
  19874. */
  19875. getClassName(): string;
  19876. /**
  19877. * Add fallbacks to the effect fallbacks list.
  19878. * @param defines defines the Base texture to use.
  19879. * @param fallbacks defines the current fallback list.
  19880. * @param currentRank defines the current fallback rank.
  19881. * @returns the new fallback rank.
  19882. */
  19883. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  19884. /**
  19885. * Add the required uniforms to the current list.
  19886. * @param uniforms defines the current uniform list.
  19887. */
  19888. static AddUniforms(uniforms: string[]): void;
  19889. /**
  19890. * Add the required uniforms to the current buffer.
  19891. * @param uniformBuffer defines the current uniform buffer.
  19892. */
  19893. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  19894. /**
  19895. * Add the required samplers to the current list.
  19896. * @param samplers defines the current sampler list.
  19897. */
  19898. static AddSamplers(samplers: string[]): void;
  19899. /**
  19900. * Makes a duplicate of the current configuration into another one.
  19901. * @param sheenConfiguration define the config where to copy the info
  19902. */
  19903. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  19904. /**
  19905. * Serializes this BRDF configuration.
  19906. * @returns - An object with the serialized config.
  19907. */
  19908. serialize(): any;
  19909. /**
  19910. * Parses a anisotropy Configuration from a serialized object.
  19911. * @param source - Serialized object.
  19912. * @param scene Defines the scene we are parsing for
  19913. * @param rootUrl Defines the rootUrl to load from
  19914. */
  19915. parse(source: any, scene: Scene, rootUrl: string): void;
  19916. }
  19917. }
  19918. declare module BABYLON {
  19919. /**
  19920. * @hidden
  19921. */
  19922. export interface IMaterialSubSurfaceDefines {
  19923. SUBSURFACE: boolean;
  19924. SS_REFRACTION: boolean;
  19925. SS_TRANSLUCENCY: boolean;
  19926. SS_SCATTERING: boolean;
  19927. SS_THICKNESSANDMASK_TEXTURE: boolean;
  19928. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  19929. SS_REFRACTIONMAP_3D: boolean;
  19930. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  19931. SS_LODINREFRACTIONALPHA: boolean;
  19932. SS_GAMMAREFRACTION: boolean;
  19933. SS_RGBDREFRACTION: boolean;
  19934. SS_LINEARSPECULARREFRACTION: boolean;
  19935. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  19936. SS_ALBEDOFORREFRACTIONTINT: boolean;
  19937. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  19938. SS_MASK_FROM_THICKNESS_TEXTURE_GLTF: boolean;
  19939. /** @hidden */
  19940. _areTexturesDirty: boolean;
  19941. }
  19942. /**
  19943. * Define the code related to the sub surface parameters of the pbr material.
  19944. */
  19945. export class PBRSubSurfaceConfiguration {
  19946. private _isRefractionEnabled;
  19947. /**
  19948. * Defines if the refraction is enabled in the material.
  19949. */
  19950. isRefractionEnabled: boolean;
  19951. private _isTranslucencyEnabled;
  19952. /**
  19953. * Defines if the translucency is enabled in the material.
  19954. */
  19955. isTranslucencyEnabled: boolean;
  19956. private _isScatteringEnabled;
  19957. /**
  19958. * Defines if the sub surface scattering is enabled in the material.
  19959. */
  19960. isScatteringEnabled: boolean;
  19961. private _scatteringDiffusionProfileIndex;
  19962. /**
  19963. * Diffusion profile for subsurface scattering.
  19964. * Useful for better scattering in the skins or foliages.
  19965. */
  19966. get scatteringDiffusionProfile(): Nullable<Color3>;
  19967. set scatteringDiffusionProfile(c: Nullable<Color3>);
  19968. /**
  19969. * Defines the refraction intensity of the material.
  19970. * The refraction when enabled replaces the Diffuse part of the material.
  19971. * The intensity helps transitionning between diffuse and refraction.
  19972. */
  19973. refractionIntensity: number;
  19974. /**
  19975. * Defines the translucency intensity of the material.
  19976. * When translucency has been enabled, this defines how much of the "translucency"
  19977. * is addded to the diffuse part of the material.
  19978. */
  19979. translucencyIntensity: number;
  19980. /**
  19981. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  19982. */
  19983. useAlbedoToTintRefraction: boolean;
  19984. private _thicknessTexture;
  19985. /**
  19986. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  19987. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  19988. * 0 would mean minimumThickness
  19989. * 1 would mean maximumThickness
  19990. * The other channels might be use as a mask to vary the different effects intensity.
  19991. */
  19992. thicknessTexture: Nullable<BaseTexture>;
  19993. private _refractionTexture;
  19994. /**
  19995. * Defines the texture to use for refraction.
  19996. */
  19997. refractionTexture: Nullable<BaseTexture>;
  19998. private _indexOfRefraction;
  19999. /**
  20000. * Index of refraction of the material base layer.
  20001. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  20002. *
  20003. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  20004. *
  20005. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  20006. */
  20007. indexOfRefraction: number;
  20008. private _volumeIndexOfRefraction;
  20009. /**
  20010. * Index of refraction of the material's volume.
  20011. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  20012. *
  20013. * This ONLY impacts refraction. If not provided or given a non-valid value,
  20014. * the volume will use the same IOR as the surface.
  20015. */
  20016. get volumeIndexOfRefraction(): number;
  20017. set volumeIndexOfRefraction(value: number);
  20018. private _invertRefractionY;
  20019. /**
  20020. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  20021. */
  20022. invertRefractionY: boolean;
  20023. private _linkRefractionWithTransparency;
  20024. /**
  20025. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  20026. * Materials half opaque for instance using refraction could benefit from this control.
  20027. */
  20028. linkRefractionWithTransparency: boolean;
  20029. /**
  20030. * Defines the minimum thickness stored in the thickness map.
  20031. * If no thickness map is defined, this value will be used to simulate thickness.
  20032. */
  20033. minimumThickness: number;
  20034. /**
  20035. * Defines the maximum thickness stored in the thickness map.
  20036. */
  20037. maximumThickness: number;
  20038. /**
  20039. * Defines the volume tint of the material.
  20040. * This is used for both translucency and scattering.
  20041. */
  20042. tintColor: Color3;
  20043. /**
  20044. * Defines the distance at which the tint color should be found in the media.
  20045. * This is used for refraction only.
  20046. */
  20047. tintColorAtDistance: number;
  20048. /**
  20049. * Defines how far each channel transmit through the media.
  20050. * It is defined as a color to simplify it selection.
  20051. */
  20052. diffusionDistance: Color3;
  20053. private _useMaskFromThicknessTexture;
  20054. /**
  20055. * Stores the intensity of the different subsurface effects in the thickness texture.
  20056. * * the green channel is the translucency intensity.
  20057. * * the blue channel is the scattering intensity.
  20058. * * the alpha channel is the refraction intensity.
  20059. */
  20060. useMaskFromThicknessTexture: boolean;
  20061. private _scene;
  20062. private _useMaskFromThicknessTextureGltf;
  20063. /**
  20064. * Stores the intensity of the different subsurface effects in the thickness texture. This variation
  20065. * matches the channel-packing that is used by glTF.
  20066. * * the red channel is the transmission/translucency intensity.
  20067. * * the green channel is the thickness.
  20068. */
  20069. useMaskFromThicknessTextureGltf: boolean;
  20070. /** @hidden */
  20071. private _internalMarkAllSubMeshesAsTexturesDirty;
  20072. private _internalMarkScenePrePassDirty;
  20073. /** @hidden */
  20074. _markAllSubMeshesAsTexturesDirty(): void;
  20075. /** @hidden */
  20076. _markScenePrePassDirty(): void;
  20077. /**
  20078. * Instantiate a new istance of sub surface configuration.
  20079. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  20080. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  20081. * @param scene The scene
  20082. */
  20083. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  20084. /**
  20085. * Gets wehter the submesh is ready to be used or not.
  20086. * @param defines the list of "defines" to update.
  20087. * @param scene defines the scene the material belongs to.
  20088. * @returns - boolean indicating that the submesh is ready or not.
  20089. */
  20090. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  20091. /**
  20092. * Checks to see if a texture is used in the material.
  20093. * @param defines the list of "defines" to update.
  20094. * @param scene defines the scene to the material belongs to.
  20095. */
  20096. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  20097. /**
  20098. * Binds the material data.
  20099. * @param uniformBuffer defines the Uniform buffer to fill in.
  20100. * @param scene defines the scene the material belongs to.
  20101. * @param engine defines the engine the material belongs to.
  20102. * @param isFrozen defines whether the material is frozen or not.
  20103. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  20104. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  20105. */
  20106. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  20107. /**
  20108. * Unbinds the material from the mesh.
  20109. * @param activeEffect defines the effect that should be unbound from.
  20110. * @returns true if unbound, otherwise false
  20111. */
  20112. unbind(activeEffect: Effect): boolean;
  20113. /**
  20114. * Returns the texture used for refraction or null if none is used.
  20115. * @param scene defines the scene the material belongs to.
  20116. * @returns - Refraction texture if present. If no refraction texture and refraction
  20117. * is linked with transparency, returns environment texture. Otherwise, returns null.
  20118. */
  20119. private _getRefractionTexture;
  20120. /**
  20121. * Returns true if alpha blending should be disabled.
  20122. */
  20123. get disableAlphaBlending(): boolean;
  20124. /**
  20125. * Fills the list of render target textures.
  20126. * @param renderTargets the list of render targets to update
  20127. */
  20128. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  20129. /**
  20130. * Checks to see if a texture is used in the material.
  20131. * @param texture - Base texture to use.
  20132. * @returns - Boolean specifying if a texture is used in the material.
  20133. */
  20134. hasTexture(texture: BaseTexture): boolean;
  20135. /**
  20136. * Gets a boolean indicating that current material needs to register RTT
  20137. * @returns true if this uses a render target otherwise false.
  20138. */
  20139. hasRenderTargetTextures(): boolean;
  20140. /**
  20141. * Returns an array of the actively used textures.
  20142. * @param activeTextures Array of BaseTextures
  20143. */
  20144. getActiveTextures(activeTextures: BaseTexture[]): void;
  20145. /**
  20146. * Returns the animatable textures.
  20147. * @param animatables Array of animatable textures.
  20148. */
  20149. getAnimatables(animatables: IAnimatable[]): void;
  20150. /**
  20151. * Disposes the resources of the material.
  20152. * @param forceDisposeTextures - Forces the disposal of all textures.
  20153. */
  20154. dispose(forceDisposeTextures?: boolean): void;
  20155. /**
  20156. * Get the current class name of the texture useful for serialization or dynamic coding.
  20157. * @returns "PBRSubSurfaceConfiguration"
  20158. */
  20159. getClassName(): string;
  20160. /**
  20161. * Add fallbacks to the effect fallbacks list.
  20162. * @param defines defines the Base texture to use.
  20163. * @param fallbacks defines the current fallback list.
  20164. * @param currentRank defines the current fallback rank.
  20165. * @returns the new fallback rank.
  20166. */
  20167. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  20168. /**
  20169. * Add the required uniforms to the current list.
  20170. * @param uniforms defines the current uniform list.
  20171. */
  20172. static AddUniforms(uniforms: string[]): void;
  20173. /**
  20174. * Add the required samplers to the current list.
  20175. * @param samplers defines the current sampler list.
  20176. */
  20177. static AddSamplers(samplers: string[]): void;
  20178. /**
  20179. * Add the required uniforms to the current buffer.
  20180. * @param uniformBuffer defines the current uniform buffer.
  20181. */
  20182. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  20183. /**
  20184. * Makes a duplicate of the current configuration into another one.
  20185. * @param configuration define the config where to copy the info
  20186. */
  20187. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  20188. /**
  20189. * Serializes this Sub Surface configuration.
  20190. * @returns - An object with the serialized config.
  20191. */
  20192. serialize(): any;
  20193. /**
  20194. * Parses a anisotropy Configuration from a serialized object.
  20195. * @param source - Serialized object.
  20196. * @param scene Defines the scene we are parsing for
  20197. * @param rootUrl Defines the rootUrl to load from
  20198. */
  20199. parse(source: any, scene: Scene, rootUrl: string): void;
  20200. }
  20201. }
  20202. declare module BABYLON {
  20203. /**
  20204. * Class representing spherical harmonics coefficients to the 3rd degree
  20205. */
  20206. export class SphericalHarmonics {
  20207. /**
  20208. * Defines whether or not the harmonics have been prescaled for rendering.
  20209. */
  20210. preScaled: boolean;
  20211. /**
  20212. * The l0,0 coefficients of the spherical harmonics
  20213. */
  20214. l00: Vector3;
  20215. /**
  20216. * The l1,-1 coefficients of the spherical harmonics
  20217. */
  20218. l1_1: Vector3;
  20219. /**
  20220. * The l1,0 coefficients of the spherical harmonics
  20221. */
  20222. l10: Vector3;
  20223. /**
  20224. * The l1,1 coefficients of the spherical harmonics
  20225. */
  20226. l11: Vector3;
  20227. /**
  20228. * The l2,-2 coefficients of the spherical harmonics
  20229. */
  20230. l2_2: Vector3;
  20231. /**
  20232. * The l2,-1 coefficients of the spherical harmonics
  20233. */
  20234. l2_1: Vector3;
  20235. /**
  20236. * The l2,0 coefficients of the spherical harmonics
  20237. */
  20238. l20: Vector3;
  20239. /**
  20240. * The l2,1 coefficients of the spherical harmonics
  20241. */
  20242. l21: Vector3;
  20243. /**
  20244. * The l2,2 coefficients of the spherical harmonics
  20245. */
  20246. l22: Vector3;
  20247. /**
  20248. * Adds a light to the spherical harmonics
  20249. * @param direction the direction of the light
  20250. * @param color the color of the light
  20251. * @param deltaSolidAngle the delta solid angle of the light
  20252. */
  20253. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  20254. /**
  20255. * Scales the spherical harmonics by the given amount
  20256. * @param scale the amount to scale
  20257. */
  20258. scaleInPlace(scale: number): void;
  20259. /**
  20260. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  20261. *
  20262. * ```
  20263. * E_lm = A_l * L_lm
  20264. * ```
  20265. *
  20266. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  20267. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  20268. * the scaling factors are given in equation 9.
  20269. */
  20270. convertIncidentRadianceToIrradiance(): void;
  20271. /**
  20272. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  20273. *
  20274. * ```
  20275. * L = (1/pi) * E * rho
  20276. * ```
  20277. *
  20278. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  20279. */
  20280. convertIrradianceToLambertianRadiance(): void;
  20281. /**
  20282. * Integrates the reconstruction coefficients directly in to the SH preventing further
  20283. * required operations at run time.
  20284. *
  20285. * This is simply done by scaling back the SH with Ylm constants parameter.
  20286. * The trigonometric part being applied by the shader at run time.
  20287. */
  20288. preScaleForRendering(): void;
  20289. /**
  20290. * Constructs a spherical harmonics from an array.
  20291. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  20292. * @returns the spherical harmonics
  20293. */
  20294. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  20295. /**
  20296. * Gets the spherical harmonics from polynomial
  20297. * @param polynomial the spherical polynomial
  20298. * @returns the spherical harmonics
  20299. */
  20300. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  20301. }
  20302. /**
  20303. * Class representing spherical polynomial coefficients to the 3rd degree
  20304. */
  20305. export class SphericalPolynomial {
  20306. private _harmonics;
  20307. /**
  20308. * The spherical harmonics used to create the polynomials.
  20309. */
  20310. get preScaledHarmonics(): SphericalHarmonics;
  20311. /**
  20312. * The x coefficients of the spherical polynomial
  20313. */
  20314. x: Vector3;
  20315. /**
  20316. * The y coefficients of the spherical polynomial
  20317. */
  20318. y: Vector3;
  20319. /**
  20320. * The z coefficients of the spherical polynomial
  20321. */
  20322. z: Vector3;
  20323. /**
  20324. * The xx coefficients of the spherical polynomial
  20325. */
  20326. xx: Vector3;
  20327. /**
  20328. * The yy coefficients of the spherical polynomial
  20329. */
  20330. yy: Vector3;
  20331. /**
  20332. * The zz coefficients of the spherical polynomial
  20333. */
  20334. zz: Vector3;
  20335. /**
  20336. * The xy coefficients of the spherical polynomial
  20337. */
  20338. xy: Vector3;
  20339. /**
  20340. * The yz coefficients of the spherical polynomial
  20341. */
  20342. yz: Vector3;
  20343. /**
  20344. * The zx coefficients of the spherical polynomial
  20345. */
  20346. zx: Vector3;
  20347. /**
  20348. * Adds an ambient color to the spherical polynomial
  20349. * @param color the color to add
  20350. */
  20351. addAmbient(color: Color3): void;
  20352. /**
  20353. * Scales the spherical polynomial by the given amount
  20354. * @param scale the amount to scale
  20355. */
  20356. scaleInPlace(scale: number): void;
  20357. /**
  20358. * Gets the spherical polynomial from harmonics
  20359. * @param harmonics the spherical harmonics
  20360. * @returns the spherical polynomial
  20361. */
  20362. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  20363. /**
  20364. * Constructs a spherical polynomial from an array.
  20365. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  20366. * @returns the spherical polynomial
  20367. */
  20368. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  20369. }
  20370. }
  20371. declare module BABYLON {
  20372. /**
  20373. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  20374. */
  20375. export interface CubeMapInfo {
  20376. /**
  20377. * The pixel array for the front face.
  20378. * This is stored in format, left to right, up to down format.
  20379. */
  20380. front: Nullable<ArrayBufferView>;
  20381. /**
  20382. * The pixel array for the back face.
  20383. * This is stored in format, left to right, up to down format.
  20384. */
  20385. back: Nullable<ArrayBufferView>;
  20386. /**
  20387. * The pixel array for the left face.
  20388. * This is stored in format, left to right, up to down format.
  20389. */
  20390. left: Nullable<ArrayBufferView>;
  20391. /**
  20392. * The pixel array for the right face.
  20393. * This is stored in format, left to right, up to down format.
  20394. */
  20395. right: Nullable<ArrayBufferView>;
  20396. /**
  20397. * The pixel array for the up face.
  20398. * This is stored in format, left to right, up to down format.
  20399. */
  20400. up: Nullable<ArrayBufferView>;
  20401. /**
  20402. * The pixel array for the down face.
  20403. * This is stored in format, left to right, up to down format.
  20404. */
  20405. down: Nullable<ArrayBufferView>;
  20406. /**
  20407. * The size of the cubemap stored.
  20408. *
  20409. * Each faces will be size * size pixels.
  20410. */
  20411. size: number;
  20412. /**
  20413. * The format of the texture.
  20414. *
  20415. * RGBA, RGB.
  20416. */
  20417. format: number;
  20418. /**
  20419. * The type of the texture data.
  20420. *
  20421. * UNSIGNED_INT, FLOAT.
  20422. */
  20423. type: number;
  20424. /**
  20425. * Specifies whether the texture is in gamma space.
  20426. */
  20427. gammaSpace: boolean;
  20428. }
  20429. /**
  20430. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  20431. */
  20432. export class PanoramaToCubeMapTools {
  20433. private static FACE_LEFT;
  20434. private static FACE_RIGHT;
  20435. private static FACE_FRONT;
  20436. private static FACE_BACK;
  20437. private static FACE_DOWN;
  20438. private static FACE_UP;
  20439. /**
  20440. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  20441. *
  20442. * @param float32Array The source data.
  20443. * @param inputWidth The width of the input panorama.
  20444. * @param inputHeight The height of the input panorama.
  20445. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  20446. * @return The cubemap data
  20447. */
  20448. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  20449. private static CreateCubemapTexture;
  20450. private static CalcProjectionSpherical;
  20451. }
  20452. }
  20453. declare module BABYLON {
  20454. /**
  20455. * Helper class dealing with the extraction of spherical polynomial dataArray
  20456. * from a cube map.
  20457. */
  20458. export class CubeMapToSphericalPolynomialTools {
  20459. private static FileFaces;
  20460. /**
  20461. * Converts a texture to the according Spherical Polynomial data.
  20462. * This extracts the first 3 orders only as they are the only one used in the lighting.
  20463. *
  20464. * @param texture The texture to extract the information from.
  20465. * @return The Spherical Polynomial data.
  20466. */
  20467. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  20468. /**
  20469. * Converts a cubemap to the according Spherical Polynomial data.
  20470. * This extracts the first 3 orders only as they are the only one used in the lighting.
  20471. *
  20472. * @param cubeInfo The Cube map to extract the information from.
  20473. * @return The Spherical Polynomial data.
  20474. */
  20475. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  20476. }
  20477. }
  20478. declare module BABYLON {
  20479. interface BaseTexture {
  20480. /**
  20481. * Get the polynomial representation of the texture data.
  20482. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  20483. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  20484. */
  20485. sphericalPolynomial: Nullable<SphericalPolynomial>;
  20486. }
  20487. }
  20488. declare module BABYLON {
  20489. /** @hidden */
  20490. export var pbrFragmentDeclaration: {
  20491. name: string;
  20492. shader: string;
  20493. };
  20494. }
  20495. declare module BABYLON {
  20496. /** @hidden */
  20497. export var pbrUboDeclaration: {
  20498. name: string;
  20499. shader: string;
  20500. };
  20501. }
  20502. declare module BABYLON {
  20503. /** @hidden */
  20504. export var pbrFragmentExtraDeclaration: {
  20505. name: string;
  20506. shader: string;
  20507. };
  20508. }
  20509. declare module BABYLON {
  20510. /** @hidden */
  20511. export var pbrFragmentSamplersDeclaration: {
  20512. name: string;
  20513. shader: string;
  20514. };
  20515. }
  20516. declare module BABYLON {
  20517. /** @hidden */
  20518. export var subSurfaceScatteringFunctions: {
  20519. name: string;
  20520. shader: string;
  20521. };
  20522. }
  20523. declare module BABYLON {
  20524. /** @hidden */
  20525. export var importanceSampling: {
  20526. name: string;
  20527. shader: string;
  20528. };
  20529. }
  20530. declare module BABYLON {
  20531. /** @hidden */
  20532. export var pbrHelperFunctions: {
  20533. name: string;
  20534. shader: string;
  20535. };
  20536. }
  20537. declare module BABYLON {
  20538. /** @hidden */
  20539. export var harmonicsFunctions: {
  20540. name: string;
  20541. shader: string;
  20542. };
  20543. }
  20544. declare module BABYLON {
  20545. /** @hidden */
  20546. export var pbrDirectLightingSetupFunctions: {
  20547. name: string;
  20548. shader: string;
  20549. };
  20550. }
  20551. declare module BABYLON {
  20552. /** @hidden */
  20553. export var pbrDirectLightingFalloffFunctions: {
  20554. name: string;
  20555. shader: string;
  20556. };
  20557. }
  20558. declare module BABYLON {
  20559. /** @hidden */
  20560. export var pbrBRDFFunctions: {
  20561. name: string;
  20562. shader: string;
  20563. };
  20564. }
  20565. declare module BABYLON {
  20566. /** @hidden */
  20567. export var hdrFilteringFunctions: {
  20568. name: string;
  20569. shader: string;
  20570. };
  20571. }
  20572. declare module BABYLON {
  20573. /** @hidden */
  20574. export var pbrDirectLightingFunctions: {
  20575. name: string;
  20576. shader: string;
  20577. };
  20578. }
  20579. declare module BABYLON {
  20580. /** @hidden */
  20581. export var pbrIBLFunctions: {
  20582. name: string;
  20583. shader: string;
  20584. };
  20585. }
  20586. declare module BABYLON {
  20587. /** @hidden */
  20588. export var pbrBlockAlbedoOpacity: {
  20589. name: string;
  20590. shader: string;
  20591. };
  20592. }
  20593. declare module BABYLON {
  20594. /** @hidden */
  20595. export var pbrBlockReflectivity: {
  20596. name: string;
  20597. shader: string;
  20598. };
  20599. }
  20600. declare module BABYLON {
  20601. /** @hidden */
  20602. export var pbrBlockAmbientOcclusion: {
  20603. name: string;
  20604. shader: string;
  20605. };
  20606. }
  20607. declare module BABYLON {
  20608. /** @hidden */
  20609. export var pbrBlockAlphaFresnel: {
  20610. name: string;
  20611. shader: string;
  20612. };
  20613. }
  20614. declare module BABYLON {
  20615. /** @hidden */
  20616. export var pbrBlockAnisotropic: {
  20617. name: string;
  20618. shader: string;
  20619. };
  20620. }
  20621. declare module BABYLON {
  20622. /** @hidden */
  20623. export var pbrBlockReflection: {
  20624. name: string;
  20625. shader: string;
  20626. };
  20627. }
  20628. declare module BABYLON {
  20629. /** @hidden */
  20630. export var pbrBlockSheen: {
  20631. name: string;
  20632. shader: string;
  20633. };
  20634. }
  20635. declare module BABYLON {
  20636. /** @hidden */
  20637. export var pbrBlockClearcoat: {
  20638. name: string;
  20639. shader: string;
  20640. };
  20641. }
  20642. declare module BABYLON {
  20643. /** @hidden */
  20644. export var pbrBlockSubSurface: {
  20645. name: string;
  20646. shader: string;
  20647. };
  20648. }
  20649. declare module BABYLON {
  20650. /** @hidden */
  20651. export var pbrBlockNormalGeometric: {
  20652. name: string;
  20653. shader: string;
  20654. };
  20655. }
  20656. declare module BABYLON {
  20657. /** @hidden */
  20658. export var pbrBlockNormalFinal: {
  20659. name: string;
  20660. shader: string;
  20661. };
  20662. }
  20663. declare module BABYLON {
  20664. /** @hidden */
  20665. export var pbrBlockLightmapInit: {
  20666. name: string;
  20667. shader: string;
  20668. };
  20669. }
  20670. declare module BABYLON {
  20671. /** @hidden */
  20672. export var pbrBlockGeometryInfo: {
  20673. name: string;
  20674. shader: string;
  20675. };
  20676. }
  20677. declare module BABYLON {
  20678. /** @hidden */
  20679. export var pbrBlockReflectance0: {
  20680. name: string;
  20681. shader: string;
  20682. };
  20683. }
  20684. declare module BABYLON {
  20685. /** @hidden */
  20686. export var pbrBlockReflectance: {
  20687. name: string;
  20688. shader: string;
  20689. };
  20690. }
  20691. declare module BABYLON {
  20692. /** @hidden */
  20693. export var pbrBlockDirectLighting: {
  20694. name: string;
  20695. shader: string;
  20696. };
  20697. }
  20698. declare module BABYLON {
  20699. /** @hidden */
  20700. export var pbrBlockFinalLitComponents: {
  20701. name: string;
  20702. shader: string;
  20703. };
  20704. }
  20705. declare module BABYLON {
  20706. /** @hidden */
  20707. export var pbrBlockFinalUnlitComponents: {
  20708. name: string;
  20709. shader: string;
  20710. };
  20711. }
  20712. declare module BABYLON {
  20713. /** @hidden */
  20714. export var pbrBlockFinalColorComposition: {
  20715. name: string;
  20716. shader: string;
  20717. };
  20718. }
  20719. declare module BABYLON {
  20720. /** @hidden */
  20721. export var pbrBlockImageProcessing: {
  20722. name: string;
  20723. shader: string;
  20724. };
  20725. }
  20726. declare module BABYLON {
  20727. /** @hidden */
  20728. export var pbrDebug: {
  20729. name: string;
  20730. shader: string;
  20731. };
  20732. }
  20733. declare module BABYLON {
  20734. /** @hidden */
  20735. export var pbrPixelShader: {
  20736. name: string;
  20737. shader: string;
  20738. };
  20739. }
  20740. declare module BABYLON {
  20741. /** @hidden */
  20742. export var pbrVertexDeclaration: {
  20743. name: string;
  20744. shader: string;
  20745. };
  20746. }
  20747. declare module BABYLON {
  20748. /** @hidden */
  20749. export var pbrVertexShader: {
  20750. name: string;
  20751. shader: string;
  20752. };
  20753. }
  20754. declare module BABYLON {
  20755. /**
  20756. * Manages the defines for the PBR Material.
  20757. * @hidden
  20758. */
  20759. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  20760. PBR: boolean;
  20761. NUM_SAMPLES: string;
  20762. REALTIME_FILTERING: boolean;
  20763. MAINUV1: boolean;
  20764. MAINUV2: boolean;
  20765. UV1: boolean;
  20766. UV2: boolean;
  20767. ALBEDO: boolean;
  20768. GAMMAALBEDO: boolean;
  20769. ALBEDODIRECTUV: number;
  20770. VERTEXCOLOR: boolean;
  20771. DETAIL: boolean;
  20772. DETAILDIRECTUV: number;
  20773. DETAIL_NORMALBLENDMETHOD: number;
  20774. AMBIENT: boolean;
  20775. AMBIENTDIRECTUV: number;
  20776. AMBIENTINGRAYSCALE: boolean;
  20777. OPACITY: boolean;
  20778. VERTEXALPHA: boolean;
  20779. OPACITYDIRECTUV: number;
  20780. OPACITYRGB: boolean;
  20781. ALPHATEST: boolean;
  20782. DEPTHPREPASS: boolean;
  20783. ALPHABLEND: boolean;
  20784. ALPHAFROMALBEDO: boolean;
  20785. ALPHATESTVALUE: string;
  20786. SPECULAROVERALPHA: boolean;
  20787. RADIANCEOVERALPHA: boolean;
  20788. ALPHAFRESNEL: boolean;
  20789. LINEARALPHAFRESNEL: boolean;
  20790. PREMULTIPLYALPHA: boolean;
  20791. EMISSIVE: boolean;
  20792. EMISSIVEDIRECTUV: number;
  20793. REFLECTIVITY: boolean;
  20794. REFLECTIVITYDIRECTUV: number;
  20795. SPECULARTERM: boolean;
  20796. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  20797. MICROSURFACEAUTOMATIC: boolean;
  20798. LODBASEDMICROSFURACE: boolean;
  20799. MICROSURFACEMAP: boolean;
  20800. MICROSURFACEMAPDIRECTUV: number;
  20801. METALLICWORKFLOW: boolean;
  20802. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  20803. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  20804. METALLNESSSTOREINMETALMAPBLUE: boolean;
  20805. AOSTOREINMETALMAPRED: boolean;
  20806. METALLIC_REFLECTANCE: boolean;
  20807. METALLIC_REFLECTANCEDIRECTUV: number;
  20808. ENVIRONMENTBRDF: boolean;
  20809. ENVIRONMENTBRDF_RGBD: boolean;
  20810. NORMAL: boolean;
  20811. TANGENT: boolean;
  20812. BUMP: boolean;
  20813. BUMPDIRECTUV: number;
  20814. OBJECTSPACE_NORMALMAP: boolean;
  20815. PARALLAX: boolean;
  20816. PARALLAXOCCLUSION: boolean;
  20817. NORMALXYSCALE: boolean;
  20818. LIGHTMAP: boolean;
  20819. LIGHTMAPDIRECTUV: number;
  20820. USELIGHTMAPASSHADOWMAP: boolean;
  20821. GAMMALIGHTMAP: boolean;
  20822. RGBDLIGHTMAP: boolean;
  20823. REFLECTION: boolean;
  20824. REFLECTIONMAP_3D: boolean;
  20825. REFLECTIONMAP_SPHERICAL: boolean;
  20826. REFLECTIONMAP_PLANAR: boolean;
  20827. REFLECTIONMAP_CUBIC: boolean;
  20828. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  20829. REFLECTIONMAP_PROJECTION: boolean;
  20830. REFLECTIONMAP_SKYBOX: boolean;
  20831. REFLECTIONMAP_EXPLICIT: boolean;
  20832. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  20833. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  20834. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  20835. INVERTCUBICMAP: boolean;
  20836. USESPHERICALFROMREFLECTIONMAP: boolean;
  20837. USEIRRADIANCEMAP: boolean;
  20838. SPHERICAL_HARMONICS: boolean;
  20839. USESPHERICALINVERTEX: boolean;
  20840. REFLECTIONMAP_OPPOSITEZ: boolean;
  20841. LODINREFLECTIONALPHA: boolean;
  20842. GAMMAREFLECTION: boolean;
  20843. RGBDREFLECTION: boolean;
  20844. LINEARSPECULARREFLECTION: boolean;
  20845. RADIANCEOCCLUSION: boolean;
  20846. HORIZONOCCLUSION: boolean;
  20847. INSTANCES: boolean;
  20848. THIN_INSTANCES: boolean;
  20849. PREPASS: boolean;
  20850. PREPASS_IRRADIANCE: boolean;
  20851. PREPASS_IRRADIANCE_INDEX: number;
  20852. PREPASS_ALBEDO: boolean;
  20853. PREPASS_ALBEDO_INDEX: number;
  20854. PREPASS_DEPTHNORMAL: boolean;
  20855. PREPASS_DEPTHNORMAL_INDEX: number;
  20856. PREPASS_POSITION: boolean;
  20857. PREPASS_POSITION_INDEX: number;
  20858. PREPASS_VELOCITY: boolean;
  20859. PREPASS_VELOCITY_INDEX: number;
  20860. PREPASS_REFLECTIVITY: boolean;
  20861. PREPASS_REFLECTIVITY_INDEX: number;
  20862. SCENE_MRT_COUNT: number;
  20863. NUM_BONE_INFLUENCERS: number;
  20864. BonesPerMesh: number;
  20865. BONETEXTURE: boolean;
  20866. BONES_VELOCITY_ENABLED: boolean;
  20867. NONUNIFORMSCALING: boolean;
  20868. MORPHTARGETS: boolean;
  20869. MORPHTARGETS_NORMAL: boolean;
  20870. MORPHTARGETS_TANGENT: boolean;
  20871. MORPHTARGETS_UV: boolean;
  20872. NUM_MORPH_INFLUENCERS: number;
  20873. IMAGEPROCESSING: boolean;
  20874. VIGNETTE: boolean;
  20875. VIGNETTEBLENDMODEMULTIPLY: boolean;
  20876. VIGNETTEBLENDMODEOPAQUE: boolean;
  20877. TONEMAPPING: boolean;
  20878. TONEMAPPING_ACES: boolean;
  20879. CONTRAST: boolean;
  20880. COLORCURVES: boolean;
  20881. COLORGRADING: boolean;
  20882. COLORGRADING3D: boolean;
  20883. SAMPLER3DGREENDEPTH: boolean;
  20884. SAMPLER3DBGRMAP: boolean;
  20885. IMAGEPROCESSINGPOSTPROCESS: boolean;
  20886. EXPOSURE: boolean;
  20887. MULTIVIEW: boolean;
  20888. USEPHYSICALLIGHTFALLOFF: boolean;
  20889. USEGLTFLIGHTFALLOFF: boolean;
  20890. TWOSIDEDLIGHTING: boolean;
  20891. SHADOWFLOAT: boolean;
  20892. CLIPPLANE: boolean;
  20893. CLIPPLANE2: boolean;
  20894. CLIPPLANE3: boolean;
  20895. CLIPPLANE4: boolean;
  20896. CLIPPLANE5: boolean;
  20897. CLIPPLANE6: boolean;
  20898. POINTSIZE: boolean;
  20899. FOG: boolean;
  20900. LOGARITHMICDEPTH: boolean;
  20901. FORCENORMALFORWARD: boolean;
  20902. SPECULARAA: boolean;
  20903. CLEARCOAT: boolean;
  20904. CLEARCOAT_DEFAULTIOR: boolean;
  20905. CLEARCOAT_TEXTURE: boolean;
  20906. CLEARCOAT_TEXTURE_ROUGHNESS: boolean;
  20907. CLEARCOAT_TEXTUREDIRECTUV: number;
  20908. CLEARCOAT_TEXTURE_ROUGHNESSDIRECTUV: number;
  20909. CLEARCOAT_USE_ROUGHNESS_FROM_MAINTEXTURE: boolean;
  20910. CLEARCOAT_TEXTURE_ROUGHNESS_IDENTICAL: boolean;
  20911. CLEARCOAT_BUMP: boolean;
  20912. CLEARCOAT_BUMPDIRECTUV: number;
  20913. CLEARCOAT_REMAP_F0: boolean;
  20914. CLEARCOAT_TINT: boolean;
  20915. CLEARCOAT_TINT_TEXTURE: boolean;
  20916. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  20917. ANISOTROPIC: boolean;
  20918. ANISOTROPIC_TEXTURE: boolean;
  20919. ANISOTROPIC_TEXTUREDIRECTUV: number;
  20920. BRDF_V_HEIGHT_CORRELATED: boolean;
  20921. MS_BRDF_ENERGY_CONSERVATION: boolean;
  20922. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  20923. SHEEN: boolean;
  20924. SHEEN_TEXTURE: boolean;
  20925. SHEEN_TEXTURE_ROUGHNESS: boolean;
  20926. SHEEN_TEXTUREDIRECTUV: number;
  20927. SHEEN_TEXTURE_ROUGHNESSDIRECTUV: number;
  20928. SHEEN_LINKWITHALBEDO: boolean;
  20929. SHEEN_ROUGHNESS: boolean;
  20930. SHEEN_ALBEDOSCALING: boolean;
  20931. SHEEN_USE_ROUGHNESS_FROM_MAINTEXTURE: boolean;
  20932. SHEEN_TEXTURE_ROUGHNESS_IDENTICAL: boolean;
  20933. SUBSURFACE: boolean;
  20934. SS_REFRACTION: boolean;
  20935. SS_TRANSLUCENCY: boolean;
  20936. SS_SCATTERING: boolean;
  20937. SS_THICKNESSANDMASK_TEXTURE: boolean;
  20938. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  20939. SS_REFRACTIONMAP_3D: boolean;
  20940. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  20941. SS_LODINREFRACTIONALPHA: boolean;
  20942. SS_GAMMAREFRACTION: boolean;
  20943. SS_RGBDREFRACTION: boolean;
  20944. SS_LINEARSPECULARREFRACTION: boolean;
  20945. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  20946. SS_ALBEDOFORREFRACTIONTINT: boolean;
  20947. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  20948. SS_MASK_FROM_THICKNESS_TEXTURE_GLTF: boolean;
  20949. UNLIT: boolean;
  20950. DEBUGMODE: number;
  20951. /**
  20952. * Initializes the PBR Material defines.
  20953. */
  20954. constructor();
  20955. /**
  20956. * Resets the PBR Material defines.
  20957. */
  20958. reset(): void;
  20959. }
  20960. /**
  20961. * The Physically based material base class of BJS.
  20962. *
  20963. * This offers the main features of a standard PBR material.
  20964. * For more information, please refer to the documentation :
  20965. * https://doc.babylonjs.com/how_to/physically_based_rendering
  20966. */
  20967. export abstract class PBRBaseMaterial extends PushMaterial {
  20968. /**
  20969. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  20970. */
  20971. static readonly PBRMATERIAL_OPAQUE: number;
  20972. /**
  20973. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  20974. */
  20975. static readonly PBRMATERIAL_ALPHATEST: number;
  20976. /**
  20977. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  20978. */
  20979. static readonly PBRMATERIAL_ALPHABLEND: number;
  20980. /**
  20981. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  20982. * They are also discarded below the alpha cutoff threshold to improve performances.
  20983. */
  20984. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  20985. /**
  20986. * Defines the default value of how much AO map is occluding the analytical lights
  20987. * (point spot...).
  20988. */
  20989. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  20990. /**
  20991. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  20992. */
  20993. static readonly LIGHTFALLOFF_PHYSICAL: number;
  20994. /**
  20995. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  20996. * to enhance interoperability with other engines.
  20997. */
  20998. static readonly LIGHTFALLOFF_GLTF: number;
  20999. /**
  21000. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  21001. * to enhance interoperability with other materials.
  21002. */
  21003. static readonly LIGHTFALLOFF_STANDARD: number;
  21004. /**
  21005. * Intensity of the direct lights e.g. the four lights available in your scene.
  21006. * This impacts both the direct diffuse and specular highlights.
  21007. */
  21008. protected _directIntensity: number;
  21009. /**
  21010. * Intensity of the emissive part of the material.
  21011. * This helps controlling the emissive effect without modifying the emissive color.
  21012. */
  21013. protected _emissiveIntensity: number;
  21014. /**
  21015. * Intensity of the environment e.g. how much the environment will light the object
  21016. * either through harmonics for rough material or through the refelction for shiny ones.
  21017. */
  21018. protected _environmentIntensity: number;
  21019. /**
  21020. * This is a special control allowing the reduction of the specular highlights coming from the
  21021. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  21022. */
  21023. protected _specularIntensity: number;
  21024. /**
  21025. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  21026. */
  21027. private _lightingInfos;
  21028. /**
  21029. * Debug Control allowing disabling the bump map on this material.
  21030. */
  21031. protected _disableBumpMap: boolean;
  21032. /**
  21033. * AKA Diffuse Texture in standard nomenclature.
  21034. */
  21035. protected _albedoTexture: Nullable<BaseTexture>;
  21036. /**
  21037. * AKA Occlusion Texture in other nomenclature.
  21038. */
  21039. protected _ambientTexture: Nullable<BaseTexture>;
  21040. /**
  21041. * AKA Occlusion Texture Intensity in other nomenclature.
  21042. */
  21043. protected _ambientTextureStrength: number;
  21044. /**
  21045. * Defines how much the AO map is occluding the analytical lights (point spot...).
  21046. * 1 means it completely occludes it
  21047. * 0 mean it has no impact
  21048. */
  21049. protected _ambientTextureImpactOnAnalyticalLights: number;
  21050. /**
  21051. * Stores the alpha values in a texture.
  21052. */
  21053. protected _opacityTexture: Nullable<BaseTexture>;
  21054. /**
  21055. * Stores the reflection values in a texture.
  21056. */
  21057. protected _reflectionTexture: Nullable<BaseTexture>;
  21058. /**
  21059. * Stores the emissive values in a texture.
  21060. */
  21061. protected _emissiveTexture: Nullable<BaseTexture>;
  21062. /**
  21063. * AKA Specular texture in other nomenclature.
  21064. */
  21065. protected _reflectivityTexture: Nullable<BaseTexture>;
  21066. /**
  21067. * Used to switch from specular/glossiness to metallic/roughness workflow.
  21068. */
  21069. protected _metallicTexture: Nullable<BaseTexture>;
  21070. /**
  21071. * Specifies the metallic scalar of the metallic/roughness workflow.
  21072. * Can also be used to scale the metalness values of the metallic texture.
  21073. */
  21074. protected _metallic: Nullable<number>;
  21075. /**
  21076. * Specifies the roughness scalar of the metallic/roughness workflow.
  21077. * Can also be used to scale the roughness values of the metallic texture.
  21078. */
  21079. protected _roughness: Nullable<number>;
  21080. /**
  21081. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  21082. * By default the indexOfrefraction is used to compute F0;
  21083. *
  21084. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  21085. *
  21086. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  21087. * F90 = metallicReflectanceColor;
  21088. */
  21089. protected _metallicF0Factor: number;
  21090. /**
  21091. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  21092. * By default the F90 is always 1;
  21093. *
  21094. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  21095. *
  21096. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  21097. * F90 = metallicReflectanceColor;
  21098. */
  21099. protected _metallicReflectanceColor: Color3;
  21100. /**
  21101. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  21102. * This is multiply against the scalar values defined in the material.
  21103. */
  21104. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  21105. /**
  21106. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  21107. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  21108. */
  21109. protected _microSurfaceTexture: Nullable<BaseTexture>;
  21110. /**
  21111. * Stores surface normal data used to displace a mesh in a texture.
  21112. */
  21113. protected _bumpTexture: Nullable<BaseTexture>;
  21114. /**
  21115. * Stores the pre-calculated light information of a mesh in a texture.
  21116. */
  21117. protected _lightmapTexture: Nullable<BaseTexture>;
  21118. /**
  21119. * The color of a material in ambient lighting.
  21120. */
  21121. protected _ambientColor: Color3;
  21122. /**
  21123. * AKA Diffuse Color in other nomenclature.
  21124. */
  21125. protected _albedoColor: Color3;
  21126. /**
  21127. * AKA Specular Color in other nomenclature.
  21128. */
  21129. protected _reflectivityColor: Color3;
  21130. /**
  21131. * The color applied when light is reflected from a material.
  21132. */
  21133. protected _reflectionColor: Color3;
  21134. /**
  21135. * The color applied when light is emitted from a material.
  21136. */
  21137. protected _emissiveColor: Color3;
  21138. /**
  21139. * AKA Glossiness in other nomenclature.
  21140. */
  21141. protected _microSurface: number;
  21142. /**
  21143. * Specifies that the material will use the light map as a show map.
  21144. */
  21145. protected _useLightmapAsShadowmap: boolean;
  21146. /**
  21147. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  21148. * makes the reflect vector face the model (under horizon).
  21149. */
  21150. protected _useHorizonOcclusion: boolean;
  21151. /**
  21152. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  21153. * too much the area relying on ambient texture to define their ambient occlusion.
  21154. */
  21155. protected _useRadianceOcclusion: boolean;
  21156. /**
  21157. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  21158. */
  21159. protected _useAlphaFromAlbedoTexture: boolean;
  21160. /**
  21161. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  21162. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  21163. */
  21164. protected _useSpecularOverAlpha: boolean;
  21165. /**
  21166. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  21167. */
  21168. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  21169. /**
  21170. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  21171. */
  21172. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  21173. /**
  21174. * Specifies if the metallic texture contains the roughness information in its green channel.
  21175. */
  21176. protected _useRoughnessFromMetallicTextureGreen: boolean;
  21177. /**
  21178. * Specifies if the metallic texture contains the metallness information in its blue channel.
  21179. */
  21180. protected _useMetallnessFromMetallicTextureBlue: boolean;
  21181. /**
  21182. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  21183. */
  21184. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  21185. /**
  21186. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  21187. */
  21188. protected _useAmbientInGrayScale: boolean;
  21189. /**
  21190. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  21191. * The material will try to infer what glossiness each pixel should be.
  21192. */
  21193. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  21194. /**
  21195. * Defines the falloff type used in this material.
  21196. * It by default is Physical.
  21197. */
  21198. protected _lightFalloff: number;
  21199. /**
  21200. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  21201. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  21202. */
  21203. protected _useRadianceOverAlpha: boolean;
  21204. /**
  21205. * Allows using an object space normal map (instead of tangent space).
  21206. */
  21207. protected _useObjectSpaceNormalMap: boolean;
  21208. /**
  21209. * Allows using the bump map in parallax mode.
  21210. */
  21211. protected _useParallax: boolean;
  21212. /**
  21213. * Allows using the bump map in parallax occlusion mode.
  21214. */
  21215. protected _useParallaxOcclusion: boolean;
  21216. /**
  21217. * Controls the scale bias of the parallax mode.
  21218. */
  21219. protected _parallaxScaleBias: number;
  21220. /**
  21221. * If sets to true, disables all the lights affecting the material.
  21222. */
  21223. protected _disableLighting: boolean;
  21224. /**
  21225. * Number of Simultaneous lights allowed on the material.
  21226. */
  21227. protected _maxSimultaneousLights: number;
  21228. /**
  21229. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  21230. */
  21231. protected _invertNormalMapX: boolean;
  21232. /**
  21233. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  21234. */
  21235. protected _invertNormalMapY: boolean;
  21236. /**
  21237. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  21238. */
  21239. protected _twoSidedLighting: boolean;
  21240. /**
  21241. * Defines the alpha limits in alpha test mode.
  21242. */
  21243. protected _alphaCutOff: number;
  21244. /**
  21245. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  21246. */
  21247. protected _forceAlphaTest: boolean;
  21248. /**
  21249. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  21250. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  21251. */
  21252. protected _useAlphaFresnel: boolean;
  21253. /**
  21254. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  21255. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  21256. */
  21257. protected _useLinearAlphaFresnel: boolean;
  21258. /**
  21259. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  21260. * from cos thetav and roughness:
  21261. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  21262. */
  21263. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  21264. /**
  21265. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  21266. */
  21267. protected _forceIrradianceInFragment: boolean;
  21268. private _realTimeFiltering;
  21269. /**
  21270. * Enables realtime filtering on the texture.
  21271. */
  21272. get realTimeFiltering(): boolean;
  21273. set realTimeFiltering(b: boolean);
  21274. private _realTimeFilteringQuality;
  21275. /**
  21276. * Quality switch for realtime filtering
  21277. */
  21278. get realTimeFilteringQuality(): number;
  21279. set realTimeFilteringQuality(n: number);
  21280. /**
  21281. * Can this material render to several textures at once
  21282. */
  21283. get canRenderToMRT(): boolean;
  21284. /**
  21285. * Force normal to face away from face.
  21286. */
  21287. protected _forceNormalForward: boolean;
  21288. /**
  21289. * Enables specular anti aliasing in the PBR shader.
  21290. * It will both interacts on the Geometry for analytical and IBL lighting.
  21291. * It also prefilter the roughness map based on the bump values.
  21292. */
  21293. protected _enableSpecularAntiAliasing: boolean;
  21294. /**
  21295. * Default configuration related to image processing available in the PBR Material.
  21296. */
  21297. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  21298. /**
  21299. * Keep track of the image processing observer to allow dispose and replace.
  21300. */
  21301. private _imageProcessingObserver;
  21302. /**
  21303. * Attaches a new image processing configuration to the PBR Material.
  21304. * @param configuration
  21305. */
  21306. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  21307. /**
  21308. * Stores the available render targets.
  21309. */
  21310. private _renderTargets;
  21311. /**
  21312. * Sets the global ambient color for the material used in lighting calculations.
  21313. */
  21314. private _globalAmbientColor;
  21315. /**
  21316. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  21317. */
  21318. private _useLogarithmicDepth;
  21319. /**
  21320. * If set to true, no lighting calculations will be applied.
  21321. */
  21322. private _unlit;
  21323. private _debugMode;
  21324. /**
  21325. * @hidden
  21326. * This is reserved for the inspector.
  21327. * Defines the material debug mode.
  21328. * It helps seeing only some components of the material while troubleshooting.
  21329. */
  21330. debugMode: number;
  21331. /**
  21332. * @hidden
  21333. * This is reserved for the inspector.
  21334. * Specify from where on screen the debug mode should start.
  21335. * The value goes from -1 (full screen) to 1 (not visible)
  21336. * It helps with side by side comparison against the final render
  21337. * This defaults to -1
  21338. */
  21339. private debugLimit;
  21340. /**
  21341. * @hidden
  21342. * This is reserved for the inspector.
  21343. * As the default viewing range might not be enough (if the ambient is really small for instance)
  21344. * You can use the factor to better multiply the final value.
  21345. */
  21346. private debugFactor;
  21347. /**
  21348. * Defines the clear coat layer parameters for the material.
  21349. */
  21350. readonly clearCoat: PBRClearCoatConfiguration;
  21351. /**
  21352. * Defines the anisotropic parameters for the material.
  21353. */
  21354. readonly anisotropy: PBRAnisotropicConfiguration;
  21355. /**
  21356. * Defines the BRDF parameters for the material.
  21357. */
  21358. readonly brdf: PBRBRDFConfiguration;
  21359. /**
  21360. * Defines the Sheen parameters for the material.
  21361. */
  21362. readonly sheen: PBRSheenConfiguration;
  21363. /**
  21364. * Defines the SubSurface parameters for the material.
  21365. */
  21366. readonly subSurface: PBRSubSurfaceConfiguration;
  21367. /**
  21368. * Defines additionnal PrePass parameters for the material.
  21369. */
  21370. readonly prePassConfiguration: PrePassConfiguration;
  21371. /**
  21372. * Defines the detail map parameters for the material.
  21373. */
  21374. readonly detailMap: DetailMapConfiguration;
  21375. protected _rebuildInParallel: boolean;
  21376. /**
  21377. * Instantiates a new PBRMaterial instance.
  21378. *
  21379. * @param name The material name
  21380. * @param scene The scene the material will be use in.
  21381. */
  21382. constructor(name: string, scene: Scene);
  21383. /**
  21384. * Gets a boolean indicating that current material needs to register RTT
  21385. */
  21386. get hasRenderTargetTextures(): boolean;
  21387. /**
  21388. * Gets the name of the material class.
  21389. */
  21390. getClassName(): string;
  21391. /**
  21392. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  21393. */
  21394. get useLogarithmicDepth(): boolean;
  21395. /**
  21396. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  21397. */
  21398. set useLogarithmicDepth(value: boolean);
  21399. /**
  21400. * Returns true if alpha blending should be disabled.
  21401. */
  21402. protected get _disableAlphaBlending(): boolean;
  21403. /**
  21404. * Specifies whether or not this material should be rendered in alpha blend mode.
  21405. */
  21406. needAlphaBlending(): boolean;
  21407. /**
  21408. * Specifies whether or not this material should be rendered in alpha test mode.
  21409. */
  21410. needAlphaTesting(): boolean;
  21411. /**
  21412. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  21413. */
  21414. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  21415. /**
  21416. * Specifies whether or not there is a usable alpha channel for transparency.
  21417. */
  21418. protected _hasAlphaChannel(): boolean;
  21419. /**
  21420. * Gets the texture used for the alpha test.
  21421. */
  21422. getAlphaTestTexture(): Nullable<BaseTexture>;
  21423. /**
  21424. * Specifies that the submesh is ready to be used.
  21425. * @param mesh - BJS mesh.
  21426. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  21427. * @param useInstances - Specifies that instances should be used.
  21428. * @returns - boolean indicating that the submesh is ready or not.
  21429. */
  21430. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  21431. /**
  21432. * Specifies if the material uses metallic roughness workflow.
  21433. * @returns boolean specifiying if the material uses metallic roughness workflow.
  21434. */
  21435. isMetallicWorkflow(): boolean;
  21436. private _prepareEffect;
  21437. private _prepareDefines;
  21438. /**
  21439. * Force shader compilation
  21440. */
  21441. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  21442. /**
  21443. * Initializes the uniform buffer layout for the shader.
  21444. */
  21445. buildUniformLayout(): void;
  21446. /**
  21447. * Unbinds the material from the mesh
  21448. */
  21449. unbind(): void;
  21450. /**
  21451. * Binds the submesh data.
  21452. * @param world - The world matrix.
  21453. * @param mesh - The BJS mesh.
  21454. * @param subMesh - A submesh of the BJS mesh.
  21455. */
  21456. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  21457. /**
  21458. * Returns the animatable textures.
  21459. * @returns - Array of animatable textures.
  21460. */
  21461. getAnimatables(): IAnimatable[];
  21462. /**
  21463. * Returns the texture used for reflections.
  21464. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  21465. */
  21466. private _getReflectionTexture;
  21467. /**
  21468. * Returns an array of the actively used textures.
  21469. * @returns - Array of BaseTextures
  21470. */
  21471. getActiveTextures(): BaseTexture[];
  21472. /**
  21473. * Checks to see if a texture is used in the material.
  21474. * @param texture - Base texture to use.
  21475. * @returns - Boolean specifying if a texture is used in the material.
  21476. */
  21477. hasTexture(texture: BaseTexture): boolean;
  21478. /**
  21479. * Sets the required values to the prepass renderer.
  21480. * @param prePassRenderer defines the prepass renderer to setup
  21481. */
  21482. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  21483. /**
  21484. * Disposes the resources of the material.
  21485. * @param forceDisposeEffect - Forces the disposal of effects.
  21486. * @param forceDisposeTextures - Forces the disposal of all textures.
  21487. */
  21488. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  21489. }
  21490. }
  21491. declare module BABYLON {
  21492. /**
  21493. * The Physically based material of BJS.
  21494. *
  21495. * This offers the main features of a standard PBR material.
  21496. * For more information, please refer to the documentation :
  21497. * https://doc.babylonjs.com/how_to/physically_based_rendering
  21498. */
  21499. export class PBRMaterial extends PBRBaseMaterial {
  21500. /**
  21501. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  21502. */
  21503. static readonly PBRMATERIAL_OPAQUE: number;
  21504. /**
  21505. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  21506. */
  21507. static readonly PBRMATERIAL_ALPHATEST: number;
  21508. /**
  21509. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  21510. */
  21511. static readonly PBRMATERIAL_ALPHABLEND: number;
  21512. /**
  21513. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  21514. * They are also discarded below the alpha cutoff threshold to improve performances.
  21515. */
  21516. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  21517. /**
  21518. * Defines the default value of how much AO map is occluding the analytical lights
  21519. * (point spot...).
  21520. */
  21521. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  21522. /**
  21523. * Intensity of the direct lights e.g. the four lights available in your scene.
  21524. * This impacts both the direct diffuse and specular highlights.
  21525. */
  21526. directIntensity: number;
  21527. /**
  21528. * Intensity of the emissive part of the material.
  21529. * This helps controlling the emissive effect without modifying the emissive color.
  21530. */
  21531. emissiveIntensity: number;
  21532. /**
  21533. * Intensity of the environment e.g. how much the environment will light the object
  21534. * either through harmonics for rough material or through the refelction for shiny ones.
  21535. */
  21536. environmentIntensity: number;
  21537. /**
  21538. * This is a special control allowing the reduction of the specular highlights coming from the
  21539. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  21540. */
  21541. specularIntensity: number;
  21542. /**
  21543. * Debug Control allowing disabling the bump map on this material.
  21544. */
  21545. disableBumpMap: boolean;
  21546. /**
  21547. * AKA Diffuse Texture in standard nomenclature.
  21548. */
  21549. albedoTexture: BaseTexture;
  21550. /**
  21551. * AKA Occlusion Texture in other nomenclature.
  21552. */
  21553. ambientTexture: BaseTexture;
  21554. /**
  21555. * AKA Occlusion Texture Intensity in other nomenclature.
  21556. */
  21557. ambientTextureStrength: number;
  21558. /**
  21559. * Defines how much the AO map is occluding the analytical lights (point spot...).
  21560. * 1 means it completely occludes it
  21561. * 0 mean it has no impact
  21562. */
  21563. ambientTextureImpactOnAnalyticalLights: number;
  21564. /**
  21565. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  21566. */
  21567. opacityTexture: BaseTexture;
  21568. /**
  21569. * Stores the reflection values in a texture.
  21570. */
  21571. reflectionTexture: Nullable<BaseTexture>;
  21572. /**
  21573. * Stores the emissive values in a texture.
  21574. */
  21575. emissiveTexture: BaseTexture;
  21576. /**
  21577. * AKA Specular texture in other nomenclature.
  21578. */
  21579. reflectivityTexture: BaseTexture;
  21580. /**
  21581. * Used to switch from specular/glossiness to metallic/roughness workflow.
  21582. */
  21583. metallicTexture: BaseTexture;
  21584. /**
  21585. * Specifies the metallic scalar of the metallic/roughness workflow.
  21586. * Can also be used to scale the metalness values of the metallic texture.
  21587. */
  21588. metallic: Nullable<number>;
  21589. /**
  21590. * Specifies the roughness scalar of the metallic/roughness workflow.
  21591. * Can also be used to scale the roughness values of the metallic texture.
  21592. */
  21593. roughness: Nullable<number>;
  21594. /**
  21595. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  21596. * By default the indexOfrefraction is used to compute F0;
  21597. *
  21598. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  21599. *
  21600. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  21601. * F90 = metallicReflectanceColor;
  21602. */
  21603. metallicF0Factor: number;
  21604. /**
  21605. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  21606. * By default the F90 is always 1;
  21607. *
  21608. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  21609. *
  21610. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  21611. * F90 = metallicReflectanceColor;
  21612. */
  21613. metallicReflectanceColor: Color3;
  21614. /**
  21615. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  21616. * This is multiply against the scalar values defined in the material.
  21617. */
  21618. metallicReflectanceTexture: Nullable<BaseTexture>;
  21619. /**
  21620. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  21621. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  21622. */
  21623. microSurfaceTexture: BaseTexture;
  21624. /**
  21625. * Stores surface normal data used to displace a mesh in a texture.
  21626. */
  21627. bumpTexture: BaseTexture;
  21628. /**
  21629. * Stores the pre-calculated light information of a mesh in a texture.
  21630. */
  21631. lightmapTexture: BaseTexture;
  21632. /**
  21633. * Stores the refracted light information in a texture.
  21634. */
  21635. get refractionTexture(): Nullable<BaseTexture>;
  21636. set refractionTexture(value: Nullable<BaseTexture>);
  21637. /**
  21638. * The color of a material in ambient lighting.
  21639. */
  21640. ambientColor: Color3;
  21641. /**
  21642. * AKA Diffuse Color in other nomenclature.
  21643. */
  21644. albedoColor: Color3;
  21645. /**
  21646. * AKA Specular Color in other nomenclature.
  21647. */
  21648. reflectivityColor: Color3;
  21649. /**
  21650. * The color reflected from the material.
  21651. */
  21652. reflectionColor: Color3;
  21653. /**
  21654. * The color emitted from the material.
  21655. */
  21656. emissiveColor: Color3;
  21657. /**
  21658. * AKA Glossiness in other nomenclature.
  21659. */
  21660. microSurface: number;
  21661. /**
  21662. * Index of refraction of the material base layer.
  21663. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  21664. *
  21665. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  21666. *
  21667. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  21668. */
  21669. get indexOfRefraction(): number;
  21670. set indexOfRefraction(value: number);
  21671. /**
  21672. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21673. */
  21674. get invertRefractionY(): boolean;
  21675. set invertRefractionY(value: boolean);
  21676. /**
  21677. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21678. * Materials half opaque for instance using refraction could benefit from this control.
  21679. */
  21680. get linkRefractionWithTransparency(): boolean;
  21681. set linkRefractionWithTransparency(value: boolean);
  21682. /**
  21683. * If true, the light map contains occlusion information instead of lighting info.
  21684. */
  21685. useLightmapAsShadowmap: boolean;
  21686. /**
  21687. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  21688. */
  21689. useAlphaFromAlbedoTexture: boolean;
  21690. /**
  21691. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  21692. */
  21693. forceAlphaTest: boolean;
  21694. /**
  21695. * Defines the alpha limits in alpha test mode.
  21696. */
  21697. alphaCutOff: number;
  21698. /**
  21699. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  21700. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  21701. */
  21702. useSpecularOverAlpha: boolean;
  21703. /**
  21704. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  21705. */
  21706. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  21707. /**
  21708. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  21709. */
  21710. useRoughnessFromMetallicTextureAlpha: boolean;
  21711. /**
  21712. * Specifies if the metallic texture contains the roughness information in its green channel.
  21713. */
  21714. useRoughnessFromMetallicTextureGreen: boolean;
  21715. /**
  21716. * Specifies if the metallic texture contains the metallness information in its blue channel.
  21717. */
  21718. useMetallnessFromMetallicTextureBlue: boolean;
  21719. /**
  21720. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  21721. */
  21722. useAmbientOcclusionFromMetallicTextureRed: boolean;
  21723. /**
  21724. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  21725. */
  21726. useAmbientInGrayScale: boolean;
  21727. /**
  21728. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  21729. * The material will try to infer what glossiness each pixel should be.
  21730. */
  21731. useAutoMicroSurfaceFromReflectivityMap: boolean;
  21732. /**
  21733. * BJS is using an harcoded light falloff based on a manually sets up range.
  21734. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  21735. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  21736. */
  21737. get usePhysicalLightFalloff(): boolean;
  21738. /**
  21739. * BJS is using an harcoded light falloff based on a manually sets up range.
  21740. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  21741. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  21742. */
  21743. set usePhysicalLightFalloff(value: boolean);
  21744. /**
  21745. * In order to support the falloff compatibility with gltf, a special mode has been added
  21746. * to reproduce the gltf light falloff.
  21747. */
  21748. get useGLTFLightFalloff(): boolean;
  21749. /**
  21750. * In order to support the falloff compatibility with gltf, a special mode has been added
  21751. * to reproduce the gltf light falloff.
  21752. */
  21753. set useGLTFLightFalloff(value: boolean);
  21754. /**
  21755. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  21756. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  21757. */
  21758. useRadianceOverAlpha: boolean;
  21759. /**
  21760. * Allows using an object space normal map (instead of tangent space).
  21761. */
  21762. useObjectSpaceNormalMap: boolean;
  21763. /**
  21764. * Allows using the bump map in parallax mode.
  21765. */
  21766. useParallax: boolean;
  21767. /**
  21768. * Allows using the bump map in parallax occlusion mode.
  21769. */
  21770. useParallaxOcclusion: boolean;
  21771. /**
  21772. * Controls the scale bias of the parallax mode.
  21773. */
  21774. parallaxScaleBias: number;
  21775. /**
  21776. * If sets to true, disables all the lights affecting the material.
  21777. */
  21778. disableLighting: boolean;
  21779. /**
  21780. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  21781. */
  21782. forceIrradianceInFragment: boolean;
  21783. /**
  21784. * Number of Simultaneous lights allowed on the material.
  21785. */
  21786. maxSimultaneousLights: number;
  21787. /**
  21788. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  21789. */
  21790. invertNormalMapX: boolean;
  21791. /**
  21792. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  21793. */
  21794. invertNormalMapY: boolean;
  21795. /**
  21796. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  21797. */
  21798. twoSidedLighting: boolean;
  21799. /**
  21800. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  21801. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  21802. */
  21803. useAlphaFresnel: boolean;
  21804. /**
  21805. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  21806. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  21807. */
  21808. useLinearAlphaFresnel: boolean;
  21809. /**
  21810. * Let user defines the brdf lookup texture used for IBL.
  21811. * A default 8bit version is embedded but you could point at :
  21812. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  21813. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  21814. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  21815. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  21816. */
  21817. environmentBRDFTexture: Nullable<BaseTexture>;
  21818. /**
  21819. * Force normal to face away from face.
  21820. */
  21821. forceNormalForward: boolean;
  21822. /**
  21823. * Enables specular anti aliasing in the PBR shader.
  21824. * It will both interacts on the Geometry for analytical and IBL lighting.
  21825. * It also prefilter the roughness map based on the bump values.
  21826. */
  21827. enableSpecularAntiAliasing: boolean;
  21828. /**
  21829. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  21830. * makes the reflect vector face the model (under horizon).
  21831. */
  21832. useHorizonOcclusion: boolean;
  21833. /**
  21834. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  21835. * too much the area relying on ambient texture to define their ambient occlusion.
  21836. */
  21837. useRadianceOcclusion: boolean;
  21838. /**
  21839. * If set to true, no lighting calculations will be applied.
  21840. */
  21841. unlit: boolean;
  21842. /**
  21843. * Gets the image processing configuration used either in this material.
  21844. */
  21845. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  21846. /**
  21847. * Sets the Default image processing configuration used either in the this material.
  21848. *
  21849. * If sets to null, the scene one is in use.
  21850. */
  21851. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  21852. /**
  21853. * Gets wether the color curves effect is enabled.
  21854. */
  21855. get cameraColorCurvesEnabled(): boolean;
  21856. /**
  21857. * Sets wether the color curves effect is enabled.
  21858. */
  21859. set cameraColorCurvesEnabled(value: boolean);
  21860. /**
  21861. * Gets wether the color grading effect is enabled.
  21862. */
  21863. get cameraColorGradingEnabled(): boolean;
  21864. /**
  21865. * Gets wether the color grading effect is enabled.
  21866. */
  21867. set cameraColorGradingEnabled(value: boolean);
  21868. /**
  21869. * Gets wether tonemapping is enabled or not.
  21870. */
  21871. get cameraToneMappingEnabled(): boolean;
  21872. /**
  21873. * Sets wether tonemapping is enabled or not
  21874. */
  21875. set cameraToneMappingEnabled(value: boolean);
  21876. /**
  21877. * The camera exposure used on this material.
  21878. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  21879. * This corresponds to a photographic exposure.
  21880. */
  21881. get cameraExposure(): number;
  21882. /**
  21883. * The camera exposure used on this material.
  21884. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  21885. * This corresponds to a photographic exposure.
  21886. */
  21887. set cameraExposure(value: number);
  21888. /**
  21889. * Gets The camera contrast used on this material.
  21890. */
  21891. get cameraContrast(): number;
  21892. /**
  21893. * Sets The camera contrast used on this material.
  21894. */
  21895. set cameraContrast(value: number);
  21896. /**
  21897. * Gets the Color Grading 2D Lookup Texture.
  21898. */
  21899. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  21900. /**
  21901. * Sets the Color Grading 2D Lookup Texture.
  21902. */
  21903. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  21904. /**
  21905. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  21906. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  21907. * 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;
  21908. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  21909. */
  21910. get cameraColorCurves(): Nullable<ColorCurves>;
  21911. /**
  21912. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  21913. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  21914. * 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;
  21915. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  21916. */
  21917. set cameraColorCurves(value: Nullable<ColorCurves>);
  21918. /**
  21919. * Instantiates a new PBRMaterial instance.
  21920. *
  21921. * @param name The material name
  21922. * @param scene The scene the material will be use in.
  21923. */
  21924. constructor(name: string, scene: Scene);
  21925. /**
  21926. * Returns the name of this material class.
  21927. */
  21928. getClassName(): string;
  21929. /**
  21930. * Makes a duplicate of the current material.
  21931. * @param name - name to use for the new material.
  21932. */
  21933. clone(name: string): PBRMaterial;
  21934. /**
  21935. * Serializes this PBR Material.
  21936. * @returns - An object with the serialized material.
  21937. */
  21938. serialize(): any;
  21939. /**
  21940. * Parses a PBR Material from a serialized object.
  21941. * @param source - Serialized object.
  21942. * @param scene - BJS scene instance.
  21943. * @param rootUrl - url for the scene object
  21944. * @returns - PBRMaterial
  21945. */
  21946. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  21947. }
  21948. }
  21949. declare module BABYLON {
  21950. /** @hidden */
  21951. export var mrtFragmentDeclaration: {
  21952. name: string;
  21953. shader: string;
  21954. };
  21955. }
  21956. declare module BABYLON {
  21957. /** @hidden */
  21958. export var geometryPixelShader: {
  21959. name: string;
  21960. shader: string;
  21961. };
  21962. }
  21963. declare module BABYLON {
  21964. /** @hidden */
  21965. export var geometryVertexShader: {
  21966. name: string;
  21967. shader: string;
  21968. };
  21969. }
  21970. declare module BABYLON {
  21971. /** @hidden */
  21972. interface ISavedTransformationMatrix {
  21973. world: Matrix;
  21974. viewProjection: Matrix;
  21975. }
  21976. /**
  21977. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  21978. */
  21979. export class GeometryBufferRenderer {
  21980. /**
  21981. * Constant used to retrieve the depth + normal texture index in the G-Buffer textures array
  21982. * using getIndex(GeometryBufferRenderer.DEPTHNORMAL_TEXTURE_INDEX)
  21983. */
  21984. static readonly DEPTHNORMAL_TEXTURE_TYPE: number;
  21985. /**
  21986. * Constant used to retrieve the position texture index in the G-Buffer textures array
  21987. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  21988. */
  21989. static readonly POSITION_TEXTURE_TYPE: number;
  21990. /**
  21991. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  21992. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  21993. */
  21994. static readonly VELOCITY_TEXTURE_TYPE: number;
  21995. /**
  21996. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  21997. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  21998. */
  21999. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  22000. /**
  22001. * Dictionary used to store the previous transformation matrices of each rendered mesh
  22002. * in order to compute objects velocities when enableVelocity is set to "true"
  22003. * @hidden
  22004. */
  22005. _previousTransformationMatrices: {
  22006. [index: number]: ISavedTransformationMatrix;
  22007. };
  22008. /**
  22009. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  22010. * in order to compute objects velocities when enableVelocity is set to "true"
  22011. * @hidden
  22012. */
  22013. _previousBonesTransformationMatrices: {
  22014. [index: number]: Float32Array;
  22015. };
  22016. /**
  22017. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  22018. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  22019. */
  22020. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  22021. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  22022. renderTransparentMeshes: boolean;
  22023. private _scene;
  22024. private _resizeObserver;
  22025. private _multiRenderTarget;
  22026. private _ratio;
  22027. private _enablePosition;
  22028. private _enableVelocity;
  22029. private _enableReflectivity;
  22030. private _positionIndex;
  22031. private _velocityIndex;
  22032. private _reflectivityIndex;
  22033. private _depthNormalIndex;
  22034. private _linkedWithPrePass;
  22035. private _prePassRenderer;
  22036. private _attachments;
  22037. protected _effect: Effect;
  22038. protected _cachedDefines: string;
  22039. /**
  22040. * @hidden
  22041. * Sets up internal structures to share outputs with PrePassRenderer
  22042. * This method should only be called by the PrePassRenderer itself
  22043. */
  22044. _linkPrePassRenderer(prePassRenderer: PrePassRenderer): void;
  22045. /**
  22046. * @hidden
  22047. * Separates internal structures from PrePassRenderer so the geometry buffer can now operate by itself.
  22048. * This method should only be called by the PrePassRenderer itself
  22049. */
  22050. _unlinkPrePassRenderer(): void;
  22051. /**
  22052. * @hidden
  22053. * Resets the geometry buffer layout
  22054. */
  22055. _resetLayout(): void;
  22056. /**
  22057. * @hidden
  22058. * Replaces a texture in the geometry buffer renderer
  22059. * Useful when linking textures of the prepass renderer
  22060. */
  22061. _forceTextureType(geometryBufferType: number, index: number): void;
  22062. /**
  22063. * @hidden
  22064. * Sets texture attachments
  22065. * Useful when linking textures of the prepass renderer
  22066. */
  22067. _setAttachments(attachments: number[]): void;
  22068. /**
  22069. * @hidden
  22070. * Replaces the first texture which is hard coded as a depth texture in the geometry buffer
  22071. * Useful when linking textures of the prepass renderer
  22072. */
  22073. _linkInternalTexture(internalTexture: InternalTexture): void;
  22074. /**
  22075. * Gets the render list (meshes to be rendered) used in the G buffer.
  22076. */
  22077. get renderList(): Nullable<AbstractMesh[]>;
  22078. /**
  22079. * Set the render list (meshes to be rendered) used in the G buffer.
  22080. */
  22081. set renderList(meshes: Nullable<AbstractMesh[]>);
  22082. /**
  22083. * Gets wether or not G buffer are supported by the running hardware.
  22084. * This requires draw buffer supports
  22085. */
  22086. get isSupported(): boolean;
  22087. /**
  22088. * Returns the index of the given texture type in the G-Buffer textures array
  22089. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  22090. * @returns the index of the given texture type in the G-Buffer textures array
  22091. */
  22092. getTextureIndex(textureType: number): number;
  22093. /**
  22094. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  22095. */
  22096. get enablePosition(): boolean;
  22097. /**
  22098. * Sets whether or not objects positions are enabled for the G buffer.
  22099. */
  22100. set enablePosition(enable: boolean);
  22101. /**
  22102. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  22103. */
  22104. get enableVelocity(): boolean;
  22105. /**
  22106. * Sets wether or not objects velocities are enabled for the G buffer.
  22107. */
  22108. set enableVelocity(enable: boolean);
  22109. /**
  22110. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  22111. */
  22112. get enableReflectivity(): boolean;
  22113. /**
  22114. * Sets wether or not objects roughness are enabled for the G buffer.
  22115. */
  22116. set enableReflectivity(enable: boolean);
  22117. /**
  22118. * Gets the scene associated with the buffer.
  22119. */
  22120. get scene(): Scene;
  22121. /**
  22122. * Gets the ratio used by the buffer during its creation.
  22123. * How big is the buffer related to the main canvas.
  22124. */
  22125. get ratio(): number;
  22126. /** @hidden */
  22127. static _SceneComponentInitialization: (scene: Scene) => void;
  22128. /**
  22129. * Creates a new G Buffer for the scene
  22130. * @param scene The scene the buffer belongs to
  22131. * @param ratio How big is the buffer related to the main canvas.
  22132. */
  22133. constructor(scene: Scene, ratio?: number);
  22134. /**
  22135. * Checks wether everything is ready to render a submesh to the G buffer.
  22136. * @param subMesh the submesh to check readiness for
  22137. * @param useInstances is the mesh drawn using instance or not
  22138. * @returns true if ready otherwise false
  22139. */
  22140. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  22141. /**
  22142. * Gets the current underlying G Buffer.
  22143. * @returns the buffer
  22144. */
  22145. getGBuffer(): MultiRenderTarget;
  22146. /**
  22147. * Gets the number of samples used to render the buffer (anti aliasing).
  22148. */
  22149. get samples(): number;
  22150. /**
  22151. * Sets the number of samples used to render the buffer (anti aliasing).
  22152. */
  22153. set samples(value: number);
  22154. /**
  22155. * Disposes the renderer and frees up associated resources.
  22156. */
  22157. dispose(): void;
  22158. private _assignRenderTargetIndices;
  22159. protected _createRenderTargets(): void;
  22160. private _copyBonesTransformationMatrices;
  22161. }
  22162. }
  22163. declare module BABYLON {
  22164. /**
  22165. * Renders a pre pass of the scene
  22166. * This means every mesh in the scene will be rendered to a render target texture
  22167. * And then this texture will be composited to the rendering canvas with post processes
  22168. * It is necessary for effects like subsurface scattering or deferred shading
  22169. */
  22170. export class PrePassRenderer {
  22171. /** @hidden */
  22172. static _SceneComponentInitialization: (scene: Scene) => void;
  22173. private _textureFormats;
  22174. /**
  22175. * To save performance, we can excluded skinned meshes from the prepass
  22176. */
  22177. excludedSkinnedMesh: AbstractMesh[];
  22178. /**
  22179. * Force material to be excluded from the prepass
  22180. * Can be useful when `useGeometryBufferFallback` is set to `true`
  22181. * and you don't want a material to show in the effect.
  22182. */
  22183. excludedMaterials: Material[];
  22184. private _textureIndices;
  22185. private _scene;
  22186. private _engine;
  22187. private _isDirty;
  22188. /**
  22189. * Number of textures in the multi render target texture where the scene is directly rendered
  22190. */
  22191. mrtCount: number;
  22192. /**
  22193. * The render target where the scene is directly rendered
  22194. */
  22195. prePassRT: MultiRenderTarget;
  22196. private _multiRenderAttachments;
  22197. private _defaultAttachments;
  22198. private _clearAttachments;
  22199. private _postProcesses;
  22200. private readonly _clearColor;
  22201. /**
  22202. * Image processing post process for composition
  22203. */
  22204. imageProcessingPostProcess: ImageProcessingPostProcess;
  22205. /**
  22206. * Configuration for prepass effects
  22207. */
  22208. private _effectConfigurations;
  22209. private _mrtFormats;
  22210. private _mrtLayout;
  22211. private _enabled;
  22212. /**
  22213. * Indicates if the prepass is enabled
  22214. */
  22215. get enabled(): boolean;
  22216. /**
  22217. * How many samples are used for MSAA of the scene render target
  22218. */
  22219. get samples(): number;
  22220. set samples(n: number);
  22221. private _geometryBuffer;
  22222. private _useGeometryBufferFallback;
  22223. /**
  22224. * Uses the geometry buffer renderer as a fallback for non prepass capable effects
  22225. */
  22226. get useGeometryBufferFallback(): boolean;
  22227. set useGeometryBufferFallback(value: boolean);
  22228. /**
  22229. * Instanciates a prepass renderer
  22230. * @param scene The scene
  22231. */
  22232. constructor(scene: Scene);
  22233. private _initializeAttachments;
  22234. private _createCompositionEffect;
  22235. /**
  22236. * Indicates if rendering a prepass is supported
  22237. */
  22238. get isSupported(): boolean;
  22239. /**
  22240. * Sets the proper output textures to draw in the engine.
  22241. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  22242. * @param subMesh Submesh on which the effect is applied
  22243. */
  22244. bindAttachmentsForEffect(effect: Effect, subMesh: SubMesh): void;
  22245. /**
  22246. * @hidden
  22247. */
  22248. _beforeCameraDraw(): void;
  22249. /**
  22250. * @hidden
  22251. */
  22252. _afterCameraDraw(): void;
  22253. private _checkRTSize;
  22254. private _bindFrameBuffer;
  22255. /**
  22256. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  22257. */
  22258. clear(): void;
  22259. private _setState;
  22260. private _updateGeometryBufferLayout;
  22261. /**
  22262. * Adds an effect configuration to the prepass.
  22263. * If an effect has already been added, it won't add it twice and will return the configuration
  22264. * already present.
  22265. * @param cfg the effect configuration
  22266. * @return the effect configuration now used by the prepass
  22267. */
  22268. addEffectConfiguration(cfg: PrePassEffectConfiguration): PrePassEffectConfiguration;
  22269. /**
  22270. * Returns the index of a texture in the multi render target texture array.
  22271. * @param type Texture type
  22272. * @return The index
  22273. */
  22274. getIndex(type: number): number;
  22275. private _enable;
  22276. private _disable;
  22277. private _resetLayout;
  22278. private _resetPostProcessChain;
  22279. private _bindPostProcessChain;
  22280. /**
  22281. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  22282. */
  22283. markAsDirty(): void;
  22284. /**
  22285. * Enables a texture on the MultiRenderTarget for prepass
  22286. */
  22287. private _enableTextures;
  22288. private _update;
  22289. private _markAllMaterialsAsPrePassDirty;
  22290. /**
  22291. * Disposes the prepass renderer.
  22292. */
  22293. dispose(): void;
  22294. }
  22295. }
  22296. declare module BABYLON {
  22297. /**
  22298. * Size options for a post process
  22299. */
  22300. export type PostProcessOptions = {
  22301. width: number;
  22302. height: number;
  22303. };
  22304. /**
  22305. * PostProcess can be used to apply a shader to a texture after it has been rendered
  22306. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  22307. */
  22308. export class PostProcess {
  22309. /**
  22310. * Gets or sets the unique id of the post process
  22311. */
  22312. uniqueId: number;
  22313. /** Name of the PostProcess. */
  22314. name: string;
  22315. /**
  22316. * Width of the texture to apply the post process on
  22317. */
  22318. width: number;
  22319. /**
  22320. * Height of the texture to apply the post process on
  22321. */
  22322. height: number;
  22323. /**
  22324. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  22325. */
  22326. nodeMaterialSource: Nullable<NodeMaterial>;
  22327. /**
  22328. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  22329. * @hidden
  22330. */
  22331. _outputTexture: Nullable<InternalTexture>;
  22332. /**
  22333. * Sampling mode used by the shader
  22334. * See https://doc.babylonjs.com/classes/3.1/texture
  22335. */
  22336. renderTargetSamplingMode: number;
  22337. /**
  22338. * Clear color to use when screen clearing
  22339. */
  22340. clearColor: Color4;
  22341. /**
  22342. * If the buffer needs to be cleared before applying the post process. (default: true)
  22343. * Should be set to false if shader will overwrite all previous pixels.
  22344. */
  22345. autoClear: boolean;
  22346. /**
  22347. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  22348. */
  22349. alphaMode: number;
  22350. /**
  22351. * Sets the setAlphaBlendConstants of the babylon engine
  22352. */
  22353. alphaConstants: Color4;
  22354. /**
  22355. * Animations to be used for the post processing
  22356. */
  22357. animations: Animation[];
  22358. /**
  22359. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  22360. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  22361. */
  22362. enablePixelPerfectMode: boolean;
  22363. /**
  22364. * Force the postprocess to be applied without taking in account viewport
  22365. */
  22366. forceFullscreenViewport: boolean;
  22367. /**
  22368. * List of inspectable custom properties (used by the Inspector)
  22369. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  22370. */
  22371. inspectableCustomProperties: IInspectable[];
  22372. /**
  22373. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  22374. *
  22375. * | Value | Type | Description |
  22376. * | ----- | ----------------------------------- | ----------- |
  22377. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  22378. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  22379. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  22380. *
  22381. */
  22382. scaleMode: number;
  22383. /**
  22384. * Force textures to be a power of two (default: false)
  22385. */
  22386. alwaysForcePOT: boolean;
  22387. private _samples;
  22388. /**
  22389. * Number of sample textures (default: 1)
  22390. */
  22391. get samples(): number;
  22392. set samples(n: number);
  22393. /**
  22394. * Modify the scale of the post process to be the same as the viewport (default: false)
  22395. */
  22396. adaptScaleToCurrentViewport: boolean;
  22397. private _camera;
  22398. protected _scene: Scene;
  22399. private _engine;
  22400. private _options;
  22401. private _reusable;
  22402. private _textureType;
  22403. private _textureFormat;
  22404. /**
  22405. * Smart array of input and output textures for the post process.
  22406. * @hidden
  22407. */
  22408. _textures: SmartArray<InternalTexture>;
  22409. /**
  22410. * The index in _textures that corresponds to the output texture.
  22411. * @hidden
  22412. */
  22413. _currentRenderTextureInd: number;
  22414. private _effect;
  22415. private _samplers;
  22416. private _fragmentUrl;
  22417. private _vertexUrl;
  22418. private _parameters;
  22419. private _scaleRatio;
  22420. protected _indexParameters: any;
  22421. private _shareOutputWithPostProcess;
  22422. private _texelSize;
  22423. private _forcedOutputTexture;
  22424. /**
  22425. * Prepass configuration in case this post process needs a texture from prepass
  22426. * @hidden
  22427. */
  22428. _prePassEffectConfiguration: PrePassEffectConfiguration;
  22429. /**
  22430. * Returns the fragment url or shader name used in the post process.
  22431. * @returns the fragment url or name in the shader store.
  22432. */
  22433. getEffectName(): string;
  22434. /**
  22435. * An event triggered when the postprocess is activated.
  22436. */
  22437. onActivateObservable: Observable<Camera>;
  22438. private _onActivateObserver;
  22439. /**
  22440. * A function that is added to the onActivateObservable
  22441. */
  22442. set onActivate(callback: Nullable<(camera: Camera) => void>);
  22443. /**
  22444. * An event triggered when the postprocess changes its size.
  22445. */
  22446. onSizeChangedObservable: Observable<PostProcess>;
  22447. private _onSizeChangedObserver;
  22448. /**
  22449. * A function that is added to the onSizeChangedObservable
  22450. */
  22451. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  22452. /**
  22453. * An event triggered when the postprocess applies its effect.
  22454. */
  22455. onApplyObservable: Observable<Effect>;
  22456. private _onApplyObserver;
  22457. /**
  22458. * A function that is added to the onApplyObservable
  22459. */
  22460. set onApply(callback: (effect: Effect) => void);
  22461. /**
  22462. * An event triggered before rendering the postprocess
  22463. */
  22464. onBeforeRenderObservable: Observable<Effect>;
  22465. private _onBeforeRenderObserver;
  22466. /**
  22467. * A function that is added to the onBeforeRenderObservable
  22468. */
  22469. set onBeforeRender(callback: (effect: Effect) => void);
  22470. /**
  22471. * An event triggered after rendering the postprocess
  22472. */
  22473. onAfterRenderObservable: Observable<Effect>;
  22474. private _onAfterRenderObserver;
  22475. /**
  22476. * A function that is added to the onAfterRenderObservable
  22477. */
  22478. set onAfterRender(callback: (efect: Effect) => void);
  22479. /**
  22480. * 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
  22481. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  22482. */
  22483. get inputTexture(): InternalTexture;
  22484. set inputTexture(value: InternalTexture);
  22485. /**
  22486. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  22487. * the only way to unset it is to use this function to restore its internal state
  22488. */
  22489. restoreDefaultInputTexture(): void;
  22490. /**
  22491. * Gets the camera which post process is applied to.
  22492. * @returns The camera the post process is applied to.
  22493. */
  22494. getCamera(): Camera;
  22495. /**
  22496. * Gets the texel size of the postprocess.
  22497. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  22498. */
  22499. get texelSize(): Vector2;
  22500. /**
  22501. * Creates a new instance PostProcess
  22502. * @param name The name of the PostProcess.
  22503. * @param fragmentUrl The url of the fragment shader to be used.
  22504. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  22505. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  22506. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  22507. * @param camera The camera to apply the render pass to.
  22508. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  22509. * @param engine The engine which the post process will be applied. (default: current engine)
  22510. * @param reusable If the post process can be reused on the same frame. (default: false)
  22511. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  22512. * @param textureType Type of textures used when performing the post process. (default: 0)
  22513. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  22514. * @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
  22515. * @param blockCompilation If the shader should not be compiled immediatly. (default: false)
  22516. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  22517. */
  22518. constructor(name: string, fragmentUrl: string, parameters: Nullable<string[]>, samplers: Nullable<string[]>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, defines?: Nullable<string>, textureType?: number, vertexUrl?: string, indexParameters?: any, blockCompilation?: boolean, textureFormat?: number);
  22519. /**
  22520. * Gets a string identifying the name of the class
  22521. * @returns "PostProcess" string
  22522. */
  22523. getClassName(): string;
  22524. /**
  22525. * Gets the engine which this post process belongs to.
  22526. * @returns The engine the post process was enabled with.
  22527. */
  22528. getEngine(): Engine;
  22529. /**
  22530. * The effect that is created when initializing the post process.
  22531. * @returns The created effect corresponding the the postprocess.
  22532. */
  22533. getEffect(): Effect;
  22534. /**
  22535. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  22536. * @param postProcess The post process to share the output with.
  22537. * @returns This post process.
  22538. */
  22539. shareOutputWith(postProcess: PostProcess): PostProcess;
  22540. /**
  22541. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  22542. * This should be called if the post process that shares output with this post process is disabled/disposed.
  22543. */
  22544. useOwnOutput(): void;
  22545. /**
  22546. * Updates the effect with the current post process compile time values and recompiles the shader.
  22547. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  22548. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  22549. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  22550. * @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
  22551. * @param onCompiled Called when the shader has been compiled.
  22552. * @param onError Called if there is an error when compiling a shader.
  22553. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  22554. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  22555. */
  22556. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, vertexUrl?: string, fragmentUrl?: string): void;
  22557. /**
  22558. * The post process is reusable if it can be used multiple times within one frame.
  22559. * @returns If the post process is reusable
  22560. */
  22561. isReusable(): boolean;
  22562. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  22563. markTextureDirty(): void;
  22564. /**
  22565. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  22566. * 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.
  22567. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  22568. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  22569. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  22570. * @returns The target texture that was bound to be written to.
  22571. */
  22572. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  22573. /**
  22574. * If the post process is supported.
  22575. */
  22576. get isSupported(): boolean;
  22577. /**
  22578. * The aspect ratio of the output texture.
  22579. */
  22580. get aspectRatio(): number;
  22581. /**
  22582. * Get a value indicating if the post-process is ready to be used
  22583. * @returns true if the post-process is ready (shader is compiled)
  22584. */
  22585. isReady(): boolean;
  22586. /**
  22587. * Binds all textures and uniforms to the shader, this will be run on every pass.
  22588. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  22589. */
  22590. apply(): Nullable<Effect>;
  22591. private _disposeTextures;
  22592. /**
  22593. * Sets the required values to the prepass renderer.
  22594. * @param prePassRenderer defines the prepass renderer to setup.
  22595. * @returns true if the pre pass is needed.
  22596. */
  22597. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  22598. /**
  22599. * Disposes the post process.
  22600. * @param camera The camera to dispose the post process on.
  22601. */
  22602. dispose(camera?: Camera): void;
  22603. /**
  22604. * Serializes the particle system to a JSON object
  22605. * @returns the JSON object
  22606. */
  22607. serialize(): any;
  22608. /**
  22609. * Creates a material from parsed material data
  22610. * @param parsedPostProcess defines parsed post process data
  22611. * @param scene defines the hosting scene
  22612. * @param rootUrl defines the root URL to use to load textures
  22613. * @returns a new post process
  22614. */
  22615. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  22616. }
  22617. }
  22618. declare module BABYLON {
  22619. /** @hidden */
  22620. export var kernelBlurVaryingDeclaration: {
  22621. name: string;
  22622. shader: string;
  22623. };
  22624. }
  22625. declare module BABYLON {
  22626. /** @hidden */
  22627. export var packingFunctions: {
  22628. name: string;
  22629. shader: string;
  22630. };
  22631. }
  22632. declare module BABYLON {
  22633. /** @hidden */
  22634. export var kernelBlurFragment: {
  22635. name: string;
  22636. shader: string;
  22637. };
  22638. }
  22639. declare module BABYLON {
  22640. /** @hidden */
  22641. export var kernelBlurFragment2: {
  22642. name: string;
  22643. shader: string;
  22644. };
  22645. }
  22646. declare module BABYLON {
  22647. /** @hidden */
  22648. export var kernelBlurPixelShader: {
  22649. name: string;
  22650. shader: string;
  22651. };
  22652. }
  22653. declare module BABYLON {
  22654. /** @hidden */
  22655. export var kernelBlurVertex: {
  22656. name: string;
  22657. shader: string;
  22658. };
  22659. }
  22660. declare module BABYLON {
  22661. /** @hidden */
  22662. export var kernelBlurVertexShader: {
  22663. name: string;
  22664. shader: string;
  22665. };
  22666. }
  22667. declare module BABYLON {
  22668. /**
  22669. * The Blur Post Process which blurs an image based on a kernel and direction.
  22670. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  22671. */
  22672. export class BlurPostProcess extends PostProcess {
  22673. private blockCompilation;
  22674. protected _kernel: number;
  22675. protected _idealKernel: number;
  22676. protected _packedFloat: boolean;
  22677. private _staticDefines;
  22678. /** The direction in which to blur the image. */
  22679. direction: Vector2;
  22680. /**
  22681. * Sets the length in pixels of the blur sample region
  22682. */
  22683. set kernel(v: number);
  22684. /**
  22685. * Gets the length in pixels of the blur sample region
  22686. */
  22687. get kernel(): number;
  22688. /**
  22689. * Sets wether or not the blur needs to unpack/repack floats
  22690. */
  22691. set packedFloat(v: boolean);
  22692. /**
  22693. * Gets wether or not the blur is unpacking/repacking floats
  22694. */
  22695. get packedFloat(): boolean;
  22696. /**
  22697. * Gets a string identifying the name of the class
  22698. * @returns "BlurPostProcess" string
  22699. */
  22700. getClassName(): string;
  22701. /**
  22702. * Creates a new instance BlurPostProcess
  22703. * @param name The name of the effect.
  22704. * @param direction The direction in which to blur the image.
  22705. * @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.
  22706. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  22707. * @param camera The camera to apply the render pass to.
  22708. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  22709. * @param engine The engine which the post process will be applied. (default: current engine)
  22710. * @param reusable If the post process can be reused on the same frame. (default: false)
  22711. * @param textureType Type of textures used when performing the post process. (default: 0)
  22712. * @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)
  22713. */
  22714. constructor(name: string, direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  22715. /**
  22716. * Updates the effect with the current post process compile time values and recompiles the shader.
  22717. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  22718. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  22719. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  22720. * @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
  22721. * @param onCompiled Called when the shader has been compiled.
  22722. * @param onError Called if there is an error when compiling a shader.
  22723. */
  22724. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  22725. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  22726. /**
  22727. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  22728. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  22729. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  22730. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  22731. * The gaps between physical kernels are compensated for in the weighting of the samples
  22732. * @param idealKernel Ideal blur kernel.
  22733. * @return Nearest best kernel.
  22734. */
  22735. protected _nearestBestKernel(idealKernel: number): number;
  22736. /**
  22737. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  22738. * @param x The point on the Gaussian distribution to sample.
  22739. * @return the value of the Gaussian function at x.
  22740. */
  22741. protected _gaussianWeight(x: number): number;
  22742. /**
  22743. * Generates a string that can be used as a floating point number in GLSL.
  22744. * @param x Value to print.
  22745. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  22746. * @return GLSL float string.
  22747. */
  22748. protected _glslFloat(x: number, decimalFigures?: number): string;
  22749. /** @hidden */
  22750. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  22751. }
  22752. }
  22753. declare module BABYLON {
  22754. /**
  22755. * Mirror texture can be used to simulate the view from a mirror in a scene.
  22756. * It will dynamically be rendered every frame to adapt to the camera point of view.
  22757. * You can then easily use it as a reflectionTexture on a flat surface.
  22758. * In case the surface is not a plane, please consider relying on reflection probes.
  22759. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  22760. */
  22761. export class MirrorTexture extends RenderTargetTexture {
  22762. private scene;
  22763. /**
  22764. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  22765. * 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.
  22766. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  22767. */
  22768. mirrorPlane: Plane;
  22769. /**
  22770. * Define the blur ratio used to blur the reflection if needed.
  22771. */
  22772. set blurRatio(value: number);
  22773. get blurRatio(): number;
  22774. /**
  22775. * Define the adaptive blur kernel used to blur the reflection if needed.
  22776. * This will autocompute the closest best match for the `blurKernel`
  22777. */
  22778. set adaptiveBlurKernel(value: number);
  22779. /**
  22780. * Define the blur kernel used to blur the reflection if needed.
  22781. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  22782. */
  22783. set blurKernel(value: number);
  22784. /**
  22785. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  22786. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  22787. */
  22788. set blurKernelX(value: number);
  22789. get blurKernelX(): number;
  22790. /**
  22791. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  22792. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  22793. */
  22794. set blurKernelY(value: number);
  22795. get blurKernelY(): number;
  22796. private _autoComputeBlurKernel;
  22797. protected _onRatioRescale(): void;
  22798. private _updateGammaSpace;
  22799. private _imageProcessingConfigChangeObserver;
  22800. private _transformMatrix;
  22801. private _mirrorMatrix;
  22802. private _savedViewMatrix;
  22803. private _blurX;
  22804. private _blurY;
  22805. private _adaptiveBlurKernel;
  22806. private _blurKernelX;
  22807. private _blurKernelY;
  22808. private _blurRatio;
  22809. /**
  22810. * Instantiates a Mirror Texture.
  22811. * Mirror texture can be used to simulate the view from a mirror in a scene.
  22812. * It will dynamically be rendered every frame to adapt to the camera point of view.
  22813. * You can then easily use it as a reflectionTexture on a flat surface.
  22814. * In case the surface is not a plane, please consider relying on reflection probes.
  22815. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  22816. * @param name
  22817. * @param size
  22818. * @param scene
  22819. * @param generateMipMaps
  22820. * @param type
  22821. * @param samplingMode
  22822. * @param generateDepthBuffer
  22823. */
  22824. constructor(name: string, size: number | {
  22825. width: number;
  22826. height: number;
  22827. } | {
  22828. ratio: number;
  22829. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  22830. private _preparePostProcesses;
  22831. /**
  22832. * Clone the mirror texture.
  22833. * @returns the cloned texture
  22834. */
  22835. clone(): MirrorTexture;
  22836. /**
  22837. * Serialize the texture to a JSON representation you could use in Parse later on
  22838. * @returns the serialized JSON representation
  22839. */
  22840. serialize(): any;
  22841. /**
  22842. * Dispose the texture and release its associated resources.
  22843. */
  22844. dispose(): void;
  22845. }
  22846. }
  22847. declare module BABYLON {
  22848. /**
  22849. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  22850. * @see https://doc.babylonjs.com/babylon101/materials#texture
  22851. */
  22852. export class Texture extends BaseTexture {
  22853. /**
  22854. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  22855. */
  22856. static SerializeBuffers: boolean;
  22857. /**
  22858. * Gets or sets a general boolean used to indicate that texture buffers must be saved as part of the serialization process.
  22859. * If no buffer exists, one will be created as base64 string from the internal webgl data.
  22860. */
  22861. static ForceSerializeBuffers: boolean;
  22862. /** @hidden */
  22863. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  22864. /** @hidden */
  22865. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  22866. /** @hidden */
  22867. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  22868. /** nearest is mag = nearest and min = nearest and mip = linear */
  22869. static readonly NEAREST_SAMPLINGMODE: number;
  22870. /** nearest is mag = nearest and min = nearest and mip = linear */
  22871. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  22872. /** Bilinear is mag = linear and min = linear and mip = nearest */
  22873. static readonly BILINEAR_SAMPLINGMODE: number;
  22874. /** Bilinear is mag = linear and min = linear and mip = nearest */
  22875. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  22876. /** Trilinear is mag = linear and min = linear and mip = linear */
  22877. static readonly TRILINEAR_SAMPLINGMODE: number;
  22878. /** Trilinear is mag = linear and min = linear and mip = linear */
  22879. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  22880. /** mag = nearest and min = nearest and mip = nearest */
  22881. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  22882. /** mag = nearest and min = linear and mip = nearest */
  22883. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  22884. /** mag = nearest and min = linear and mip = linear */
  22885. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  22886. /** mag = nearest and min = linear and mip = none */
  22887. static readonly NEAREST_LINEAR: number;
  22888. /** mag = nearest and min = nearest and mip = none */
  22889. static readonly NEAREST_NEAREST: number;
  22890. /** mag = linear and min = nearest and mip = nearest */
  22891. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  22892. /** mag = linear and min = nearest and mip = linear */
  22893. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  22894. /** mag = linear and min = linear and mip = none */
  22895. static readonly LINEAR_LINEAR: number;
  22896. /** mag = linear and min = nearest and mip = none */
  22897. static readonly LINEAR_NEAREST: number;
  22898. /** Explicit coordinates mode */
  22899. static readonly EXPLICIT_MODE: number;
  22900. /** Spherical coordinates mode */
  22901. static readonly SPHERICAL_MODE: number;
  22902. /** Planar coordinates mode */
  22903. static readonly PLANAR_MODE: number;
  22904. /** Cubic coordinates mode */
  22905. static readonly CUBIC_MODE: number;
  22906. /** Projection coordinates mode */
  22907. static readonly PROJECTION_MODE: number;
  22908. /** Inverse Cubic coordinates mode */
  22909. static readonly SKYBOX_MODE: number;
  22910. /** Inverse Cubic coordinates mode */
  22911. static readonly INVCUBIC_MODE: number;
  22912. /** Equirectangular coordinates mode */
  22913. static readonly EQUIRECTANGULAR_MODE: number;
  22914. /** Equirectangular Fixed coordinates mode */
  22915. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  22916. /** Equirectangular Fixed Mirrored coordinates mode */
  22917. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  22918. /** Texture is not repeating outside of 0..1 UVs */
  22919. static readonly CLAMP_ADDRESSMODE: number;
  22920. /** Texture is repeating outside of 0..1 UVs */
  22921. static readonly WRAP_ADDRESSMODE: number;
  22922. /** Texture is repeating and mirrored */
  22923. static readonly MIRROR_ADDRESSMODE: number;
  22924. /**
  22925. * 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
  22926. */
  22927. static UseSerializedUrlIfAny: boolean;
  22928. /**
  22929. * Define the url of the texture.
  22930. */
  22931. url: Nullable<string>;
  22932. /**
  22933. * Define an offset on the texture to offset the u coordinates of the UVs
  22934. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  22935. */
  22936. uOffset: number;
  22937. /**
  22938. * Define an offset on the texture to offset the v coordinates of the UVs
  22939. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  22940. */
  22941. vOffset: number;
  22942. /**
  22943. * Define an offset on the texture to scale the u coordinates of the UVs
  22944. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  22945. */
  22946. uScale: number;
  22947. /**
  22948. * Define an offset on the texture to scale the v coordinates of the UVs
  22949. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  22950. */
  22951. vScale: number;
  22952. /**
  22953. * Define an offset on the texture to rotate around the u coordinates of the UVs
  22954. * @see https://doc.babylonjs.com/how_to/more_materials
  22955. */
  22956. uAng: number;
  22957. /**
  22958. * Define an offset on the texture to rotate around the v coordinates of the UVs
  22959. * @see https://doc.babylonjs.com/how_to/more_materials
  22960. */
  22961. vAng: number;
  22962. /**
  22963. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  22964. * @see https://doc.babylonjs.com/how_to/more_materials
  22965. */
  22966. wAng: number;
  22967. /**
  22968. * Defines the center of rotation (U)
  22969. */
  22970. uRotationCenter: number;
  22971. /**
  22972. * Defines the center of rotation (V)
  22973. */
  22974. vRotationCenter: number;
  22975. /**
  22976. * Defines the center of rotation (W)
  22977. */
  22978. wRotationCenter: number;
  22979. /**
  22980. * Sets this property to true to avoid deformations when rotating the texture with non-uniform scaling
  22981. */
  22982. homogeneousRotationInUVTransform: boolean;
  22983. /**
  22984. * Are mip maps generated for this texture or not.
  22985. */
  22986. get noMipmap(): boolean;
  22987. /**
  22988. * List of inspectable custom properties (used by the Inspector)
  22989. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  22990. */
  22991. inspectableCustomProperties: Nullable<IInspectable[]>;
  22992. private _noMipmap;
  22993. /** @hidden */
  22994. _invertY: boolean;
  22995. private _rowGenerationMatrix;
  22996. private _cachedTextureMatrix;
  22997. private _projectionModeMatrix;
  22998. private _t0;
  22999. private _t1;
  23000. private _t2;
  23001. private _cachedUOffset;
  23002. private _cachedVOffset;
  23003. private _cachedUScale;
  23004. private _cachedVScale;
  23005. private _cachedUAng;
  23006. private _cachedVAng;
  23007. private _cachedWAng;
  23008. private _cachedProjectionMatrixId;
  23009. private _cachedURotationCenter;
  23010. private _cachedVRotationCenter;
  23011. private _cachedWRotationCenter;
  23012. private _cachedHomogeneousRotationInUVTransform;
  23013. private _cachedCoordinatesMode;
  23014. /** @hidden */
  23015. protected _initialSamplingMode: number;
  23016. /** @hidden */
  23017. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  23018. private _deleteBuffer;
  23019. protected _format: Nullable<number>;
  23020. private _delayedOnLoad;
  23021. private _delayedOnError;
  23022. private _mimeType?;
  23023. private _loaderOptions?;
  23024. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  23025. get mimeType(): string | undefined;
  23026. /**
  23027. * Observable triggered once the texture has been loaded.
  23028. */
  23029. onLoadObservable: Observable<Texture>;
  23030. protected _isBlocking: boolean;
  23031. /**
  23032. * Is the texture preventing material to render while loading.
  23033. * If false, a default texture will be used instead of the loading one during the preparation step.
  23034. */
  23035. set isBlocking(value: boolean);
  23036. get isBlocking(): boolean;
  23037. /**
  23038. * Get the current sampling mode associated with the texture.
  23039. */
  23040. get samplingMode(): number;
  23041. /**
  23042. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  23043. */
  23044. get invertY(): boolean;
  23045. /**
  23046. * Instantiates a new texture.
  23047. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23048. * @see https://doc.babylonjs.com/babylon101/materials#texture
  23049. * @param url defines the url of the picture to load as a texture
  23050. * @param sceneOrEngine defines the scene or engine the texture will belong to
  23051. * @param noMipmap defines if the texture will require mip maps or not
  23052. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  23053. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  23054. * @param onLoad defines a callback triggered when the texture has been loaded
  23055. * @param onError defines a callback triggered when an error occurred during the loading session
  23056. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  23057. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  23058. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  23059. * @param mimeType defines an optional mime type information
  23060. * @param loaderOptions options to be passed to the loader
  23061. */
  23062. constructor(url: Nullable<string>, sceneOrEngine: Nullable<Scene | ThinEngine>, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, deleteBuffer?: boolean, format?: number, mimeType?: string, loaderOptions?: any);
  23063. /**
  23064. * Update the url (and optional buffer) of this texture if url was null during construction.
  23065. * @param url the url of the texture
  23066. * @param buffer the buffer of the texture (defaults to null)
  23067. * @param onLoad callback called when the texture is loaded (defaults to null)
  23068. */
  23069. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  23070. /**
  23071. * Finish the loading sequence of a texture flagged as delayed load.
  23072. * @hidden
  23073. */
  23074. delayLoad(): void;
  23075. private _prepareRowForTextureGeneration;
  23076. /**
  23077. * Checks if the texture has the same transform matrix than another texture
  23078. * @param texture texture to check against
  23079. * @returns true if the transforms are the same, else false
  23080. */
  23081. checkTransformsAreIdentical(texture: Nullable<Texture>): boolean;
  23082. /**
  23083. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  23084. * @returns the transform matrix of the texture.
  23085. */
  23086. getTextureMatrix(uBase?: number): Matrix;
  23087. /**
  23088. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  23089. * @returns The reflection texture transform
  23090. */
  23091. getReflectionTextureMatrix(): Matrix;
  23092. /**
  23093. * Clones the texture.
  23094. * @returns the cloned texture
  23095. */
  23096. clone(): Texture;
  23097. /**
  23098. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  23099. * @returns The JSON representation of the texture
  23100. */
  23101. serialize(): any;
  23102. /**
  23103. * Get the current class name of the texture useful for serialization or dynamic coding.
  23104. * @returns "Texture"
  23105. */
  23106. getClassName(): string;
  23107. /**
  23108. * Dispose the texture and release its associated resources.
  23109. */
  23110. dispose(): void;
  23111. /**
  23112. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  23113. * @param parsedTexture Define the JSON representation of the texture
  23114. * @param scene Define the scene the parsed texture should be instantiated in
  23115. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  23116. * @returns The parsed texture if successful
  23117. */
  23118. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  23119. /**
  23120. * Creates a texture from its base 64 representation.
  23121. * @param data Define the base64 payload without the data: prefix
  23122. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  23123. * @param scene Define the scene the texture should belong to
  23124. * @param noMipmap Forces the texture to not create mip map information if true
  23125. * @param invertY define if the texture needs to be inverted on the y axis during loading
  23126. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  23127. * @param onLoad define a callback triggered when the texture has been loaded
  23128. * @param onError define a callback triggered when an error occurred during the loading session
  23129. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  23130. * @returns the created texture
  23131. */
  23132. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  23133. /**
  23134. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  23135. * @param data Define the base64 payload without the data: prefix
  23136. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  23137. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  23138. * @param scene Define the scene the texture should belong to
  23139. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  23140. * @param noMipmap Forces the texture to not create mip map information if true
  23141. * @param invertY define if the texture needs to be inverted on the y axis during loading
  23142. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  23143. * @param onLoad define a callback triggered when the texture has been loaded
  23144. * @param onError define a callback triggered when an error occurred during the loading session
  23145. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  23146. * @returns the created texture
  23147. */
  23148. 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;
  23149. }
  23150. }
  23151. declare module BABYLON {
  23152. /**
  23153. * ThinSprite Class used to represent a thin sprite
  23154. * This is the base class for sprites but can also directly be used with ThinEngine
  23155. * @see https://doc.babylonjs.com/babylon101/sprites
  23156. */
  23157. export class ThinSprite {
  23158. /** Gets or sets the cell index in the sprite sheet */
  23159. cellIndex: number;
  23160. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  23161. cellRef: string;
  23162. /** Gets or sets the current world position */
  23163. position: IVector3Like;
  23164. /** Gets or sets the main color */
  23165. color: IColor4Like;
  23166. /** Gets or sets the width */
  23167. width: number;
  23168. /** Gets or sets the height */
  23169. height: number;
  23170. /** Gets or sets rotation angle */
  23171. angle: number;
  23172. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  23173. invertU: boolean;
  23174. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  23175. invertV: boolean;
  23176. /** Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true */
  23177. isVisible: boolean;
  23178. /**
  23179. * Returns a boolean indicating if the animation is started
  23180. */
  23181. get animationStarted(): boolean;
  23182. /** Gets the initial key for the animation (setting it will restart the animation) */
  23183. get fromIndex(): number;
  23184. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  23185. get toIndex(): number;
  23186. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  23187. get loopAnimation(): boolean;
  23188. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  23189. get delay(): number;
  23190. /** @hidden */
  23191. _xOffset: number;
  23192. /** @hidden */
  23193. _yOffset: number;
  23194. /** @hidden */
  23195. _xSize: number;
  23196. /** @hidden */
  23197. _ySize: number;
  23198. private _animationStarted;
  23199. protected _loopAnimation: boolean;
  23200. protected _fromIndex: number;
  23201. protected _toIndex: number;
  23202. protected _delay: number;
  23203. private _direction;
  23204. private _time;
  23205. private _onBaseAnimationEnd;
  23206. /**
  23207. * Creates a new Thin Sprite
  23208. */
  23209. constructor();
  23210. /**
  23211. * Starts an animation
  23212. * @param from defines the initial key
  23213. * @param to defines the end key
  23214. * @param loop defines if the animation must loop
  23215. * @param delay defines the start delay (in ms)
  23216. * @param onAnimationEnd defines a callback for when the animation ends
  23217. */
  23218. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd: Nullable<() => void>): void;
  23219. /** Stops current animation (if any) */
  23220. stopAnimation(): void;
  23221. /** @hidden */
  23222. _animate(deltaTime: number): void;
  23223. }
  23224. }
  23225. declare module BABYLON {
  23226. /** @hidden */
  23227. export var imageProcessingCompatibility: {
  23228. name: string;
  23229. shader: string;
  23230. };
  23231. }
  23232. declare module BABYLON {
  23233. /** @hidden */
  23234. export var spritesPixelShader: {
  23235. name: string;
  23236. shader: string;
  23237. };
  23238. }
  23239. declare module BABYLON {
  23240. /** @hidden */
  23241. export var spritesVertexShader: {
  23242. name: string;
  23243. shader: string;
  23244. };
  23245. }
  23246. declare module BABYLON {
  23247. /**
  23248. * Class used to render sprites.
  23249. *
  23250. * It can be used either to render Sprites or ThinSriptes with ThinEngine only.
  23251. */
  23252. export class SpriteRenderer {
  23253. /**
  23254. * Defines the texture of the spritesheet
  23255. */
  23256. texture: Nullable<ThinTexture>;
  23257. /**
  23258. * Defines the default width of a cell in the spritesheet
  23259. */
  23260. cellWidth: number;
  23261. /**
  23262. * Defines the default height of a cell in the spritesheet
  23263. */
  23264. cellHeight: number;
  23265. /**
  23266. * Blend mode use to render the particle, it can be any of
  23267. * the static Constants.ALPHA_x properties provided in this class.
  23268. * Default value is Constants.ALPHA_COMBINE
  23269. */
  23270. blendMode: number;
  23271. /**
  23272. * Gets or sets a boolean indicating if alpha mode is automatically
  23273. * reset.
  23274. */
  23275. autoResetAlpha: boolean;
  23276. /**
  23277. * Disables writing to the depth buffer when rendering the sprites.
  23278. * It can be handy to disable depth writing when using textures without alpha channel
  23279. * and setting some specific blend modes.
  23280. */
  23281. disableDepthWrite: boolean;
  23282. /**
  23283. * Gets or sets a boolean indicating if the manager must consider scene fog when rendering
  23284. */
  23285. fogEnabled: boolean;
  23286. /**
  23287. * Gets the capacity of the manager
  23288. */
  23289. get capacity(): number;
  23290. private readonly _engine;
  23291. private readonly _useVAO;
  23292. private readonly _useInstancing;
  23293. private readonly _scene;
  23294. private readonly _capacity;
  23295. private readonly _epsilon;
  23296. private _vertexBufferSize;
  23297. private _vertexData;
  23298. private _buffer;
  23299. private _vertexBuffers;
  23300. private _spriteBuffer;
  23301. private _indexBuffer;
  23302. private _effectBase;
  23303. private _effectFog;
  23304. private _vertexArrayObject;
  23305. /**
  23306. * Creates a new sprite Renderer
  23307. * @param engine defines the engine the renderer works with
  23308. * @param capacity defines the maximum allowed number of sprites
  23309. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  23310. * @param scene defines the hosting scene
  23311. */
  23312. constructor(engine: ThinEngine, capacity: number, epsilon?: number, scene?: Nullable<Scene>);
  23313. /**
  23314. * Render all child sprites
  23315. * @param sprites defines the list of sprites to render
  23316. * @param deltaTime defines the time since last frame
  23317. * @param viewMatrix defines the viewMatrix to use to render the sprites
  23318. * @param projectionMatrix defines the projectionMatrix to use to render the sprites
  23319. * @param customSpriteUpdate defines a custom function to update the sprites data before they render
  23320. */
  23321. render(sprites: ThinSprite[], deltaTime: number, viewMatrix: IMatrixLike, projectionMatrix: IMatrixLike, customSpriteUpdate?: Nullable<(sprite: ThinSprite, baseSize: ISize) => void>): void;
  23322. private _appendSpriteVertex;
  23323. /**
  23324. * Release associated resources
  23325. */
  23326. dispose(): void;
  23327. }
  23328. }
  23329. declare module BABYLON {
  23330. /**
  23331. * Defines the minimum interface to fullfil in order to be a sprite manager.
  23332. */
  23333. export interface ISpriteManager extends IDisposable {
  23334. /**
  23335. * Gets manager's name
  23336. */
  23337. name: string;
  23338. /**
  23339. * Restricts the camera to viewing objects with the same layerMask.
  23340. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  23341. */
  23342. layerMask: number;
  23343. /**
  23344. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  23345. */
  23346. isPickable: boolean;
  23347. /**
  23348. * Gets the hosting scene
  23349. */
  23350. scene: Scene;
  23351. /**
  23352. * Specifies the rendering group id for this mesh (0 by default)
  23353. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  23354. */
  23355. renderingGroupId: number;
  23356. /**
  23357. * Defines the list of sprites managed by the manager.
  23358. */
  23359. sprites: Array<Sprite>;
  23360. /**
  23361. * Gets or sets the spritesheet texture
  23362. */
  23363. texture: Texture;
  23364. /** Defines the default width of a cell in the spritesheet */
  23365. cellWidth: number;
  23366. /** Defines the default height of a cell in the spritesheet */
  23367. cellHeight: number;
  23368. /**
  23369. * Tests the intersection of a sprite with a specific ray.
  23370. * @param ray The ray we are sending to test the collision
  23371. * @param camera The camera space we are sending rays in
  23372. * @param predicate A predicate allowing excluding sprites from the list of object to test
  23373. * @param fastCheck defines if the first intersection will be used (and not the closest)
  23374. * @returns picking info or null.
  23375. */
  23376. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  23377. /**
  23378. * Intersects the sprites with a ray
  23379. * @param ray defines the ray to intersect with
  23380. * @param camera defines the current active camera
  23381. * @param predicate defines a predicate used to select candidate sprites
  23382. * @returns null if no hit or a PickingInfo array
  23383. */
  23384. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  23385. /**
  23386. * Renders the list of sprites on screen.
  23387. */
  23388. render(): void;
  23389. }
  23390. /**
  23391. * Class used to manage multiple sprites on the same spritesheet
  23392. * @see https://doc.babylonjs.com/babylon101/sprites
  23393. */
  23394. export class SpriteManager implements ISpriteManager {
  23395. /** defines the manager's name */
  23396. name: string;
  23397. /** Define the Url to load snippets */
  23398. static SnippetUrl: string;
  23399. /** Snippet ID if the manager was created from the snippet server */
  23400. snippetId: string;
  23401. /** Gets the list of sprites */
  23402. sprites: Sprite[];
  23403. /** Gets or sets the rendering group id (0 by default) */
  23404. renderingGroupId: number;
  23405. /** Gets or sets camera layer mask */
  23406. layerMask: number;
  23407. /** Gets or sets a boolean indicating if the sprites are pickable */
  23408. isPickable: boolean;
  23409. /**
  23410. * An event triggered when the manager is disposed.
  23411. */
  23412. onDisposeObservable: Observable<SpriteManager>;
  23413. /**
  23414. * Callback called when the manager is disposed
  23415. */
  23416. set onDispose(callback: () => void);
  23417. /**
  23418. * Gets or sets the unique id of the sprite
  23419. */
  23420. uniqueId: number;
  23421. /**
  23422. * Gets the array of sprites
  23423. */
  23424. get children(): Sprite[];
  23425. /**
  23426. * Gets the hosting scene
  23427. */
  23428. get scene(): Scene;
  23429. /**
  23430. * Gets the capacity of the manager
  23431. */
  23432. get capacity(): number;
  23433. /**
  23434. * Gets or sets the spritesheet texture
  23435. */
  23436. get texture(): Texture;
  23437. set texture(value: Texture);
  23438. /** Defines the default width of a cell in the spritesheet */
  23439. get cellWidth(): number;
  23440. set cellWidth(value: number);
  23441. /** Defines the default height of a cell in the spritesheet */
  23442. get cellHeight(): number;
  23443. set cellHeight(value: number);
  23444. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  23445. get fogEnabled(): boolean;
  23446. set fogEnabled(value: boolean);
  23447. /**
  23448. * Blend mode use to render the particle, it can be any of
  23449. * the static Constants.ALPHA_x properties provided in this class.
  23450. * Default value is Constants.ALPHA_COMBINE
  23451. */
  23452. get blendMode(): number;
  23453. set blendMode(blendMode: number);
  23454. /** Disables writing to the depth buffer when rendering the sprites.
  23455. * It can be handy to disable depth writing when using textures without alpha channel
  23456. * and setting some specific blend modes.
  23457. */
  23458. disableDepthWrite: boolean;
  23459. private _spriteRenderer;
  23460. /** Associative array from JSON sprite data file */
  23461. private _cellData;
  23462. /** Array of sprite names from JSON sprite data file */
  23463. private _spriteMap;
  23464. /** True when packed cell data from JSON file is ready*/
  23465. private _packedAndReady;
  23466. private _textureContent;
  23467. private _onDisposeObserver;
  23468. private _fromPacked;
  23469. private _scene;
  23470. /**
  23471. * Creates a new sprite manager
  23472. * @param name defines the manager's name
  23473. * @param imgUrl defines the sprite sheet url
  23474. * @param capacity defines the maximum allowed number of sprites
  23475. * @param cellSize defines the size of a sprite cell
  23476. * @param scene defines the hosting scene
  23477. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  23478. * @param samplingMode defines the smapling mode to use with spritesheet
  23479. * @param fromPacked set to false; do not alter
  23480. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  23481. */
  23482. constructor(
  23483. /** defines the manager's name */
  23484. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  23485. /**
  23486. * Returns the string "SpriteManager"
  23487. * @returns "SpriteManager"
  23488. */
  23489. getClassName(): string;
  23490. private _makePacked;
  23491. private _checkTextureAlpha;
  23492. /**
  23493. * Intersects the sprites with a ray
  23494. * @param ray defines the ray to intersect with
  23495. * @param camera defines the current active camera
  23496. * @param predicate defines a predicate used to select candidate sprites
  23497. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  23498. * @returns null if no hit or a PickingInfo
  23499. */
  23500. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  23501. /**
  23502. * Intersects the sprites with a ray
  23503. * @param ray defines the ray to intersect with
  23504. * @param camera defines the current active camera
  23505. * @param predicate defines a predicate used to select candidate sprites
  23506. * @returns null if no hit or a PickingInfo array
  23507. */
  23508. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  23509. /**
  23510. * Render all child sprites
  23511. */
  23512. render(): void;
  23513. private _customUpdate;
  23514. /**
  23515. * Release associated resources
  23516. */
  23517. dispose(): void;
  23518. /**
  23519. * Serializes the sprite manager to a JSON object
  23520. * @param serializeTexture defines if the texture must be serialized as well
  23521. * @returns the JSON object
  23522. */
  23523. serialize(serializeTexture?: boolean): any;
  23524. /**
  23525. * Parses a JSON object to create a new sprite manager.
  23526. * @param parsedManager The JSON object to parse
  23527. * @param scene The scene to create the sprite managerin
  23528. * @param rootUrl The root url to use to load external dependencies like texture
  23529. * @returns the new sprite manager
  23530. */
  23531. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  23532. /**
  23533. * Creates a sprite manager from a snippet saved in a remote file
  23534. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  23535. * @param url defines the url to load from
  23536. * @param scene defines the hosting scene
  23537. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23538. * @returns a promise that will resolve to the new sprite manager
  23539. */
  23540. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  23541. /**
  23542. * Creates a sprite manager from a snippet saved by the sprite editor
  23543. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  23544. * @param scene defines the hosting scene
  23545. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23546. * @returns a promise that will resolve to the new sprite manager
  23547. */
  23548. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  23549. }
  23550. }
  23551. declare module BABYLON {
  23552. /**
  23553. * Class used to represent a sprite
  23554. * @see https://doc.babylonjs.com/babylon101/sprites
  23555. */
  23556. export class Sprite extends ThinSprite implements IAnimatable {
  23557. /** defines the name */
  23558. name: string;
  23559. /** Gets or sets the current world position */
  23560. position: Vector3;
  23561. /** Gets or sets the main color */
  23562. color: Color4;
  23563. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  23564. disposeWhenFinishedAnimating: boolean;
  23565. /** Gets the list of attached animations */
  23566. animations: Nullable<Array<Animation>>;
  23567. /** Gets or sets a boolean indicating if the sprite can be picked */
  23568. isPickable: boolean;
  23569. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  23570. useAlphaForPicking: boolean;
  23571. /**
  23572. * Gets or sets the associated action manager
  23573. */
  23574. actionManager: Nullable<ActionManager>;
  23575. /**
  23576. * An event triggered when the control has been disposed
  23577. */
  23578. onDisposeObservable: Observable<Sprite>;
  23579. private _manager;
  23580. private _onAnimationEnd;
  23581. /**
  23582. * Gets or sets the sprite size
  23583. */
  23584. get size(): number;
  23585. set size(value: number);
  23586. /**
  23587. * Gets or sets the unique id of the sprite
  23588. */
  23589. uniqueId: number;
  23590. /**
  23591. * Gets the manager of this sprite
  23592. */
  23593. get manager(): ISpriteManager;
  23594. /**
  23595. * Creates a new Sprite
  23596. * @param name defines the name
  23597. * @param manager defines the manager
  23598. */
  23599. constructor(
  23600. /** defines the name */
  23601. name: string, manager: ISpriteManager);
  23602. /**
  23603. * Returns the string "Sprite"
  23604. * @returns "Sprite"
  23605. */
  23606. getClassName(): string;
  23607. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  23608. get fromIndex(): number;
  23609. set fromIndex(value: number);
  23610. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  23611. get toIndex(): number;
  23612. set toIndex(value: number);
  23613. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  23614. get loopAnimation(): boolean;
  23615. set loopAnimation(value: boolean);
  23616. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  23617. get delay(): number;
  23618. set delay(value: number);
  23619. /**
  23620. * Starts an animation
  23621. * @param from defines the initial key
  23622. * @param to defines the end key
  23623. * @param loop defines if the animation must loop
  23624. * @param delay defines the start delay (in ms)
  23625. * @param onAnimationEnd defines a callback to call when animation ends
  23626. */
  23627. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  23628. private _endAnimation;
  23629. /** Release associated resources */
  23630. dispose(): void;
  23631. /**
  23632. * Serializes the sprite to a JSON object
  23633. * @returns the JSON object
  23634. */
  23635. serialize(): any;
  23636. /**
  23637. * Parses a JSON object to create a new sprite
  23638. * @param parsedSprite The JSON object to parse
  23639. * @param manager defines the hosting manager
  23640. * @returns the new sprite
  23641. */
  23642. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  23643. }
  23644. }
  23645. declare module BABYLON {
  23646. /**
  23647. * Information about the result of picking within a scene
  23648. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  23649. */
  23650. export class PickingInfo {
  23651. /** @hidden */
  23652. _pickingUnavailable: boolean;
  23653. /**
  23654. * If the pick collided with an object
  23655. */
  23656. hit: boolean;
  23657. /**
  23658. * Distance away where the pick collided
  23659. */
  23660. distance: number;
  23661. /**
  23662. * The location of pick collision
  23663. */
  23664. pickedPoint: Nullable<Vector3>;
  23665. /**
  23666. * The mesh corresponding the the pick collision
  23667. */
  23668. pickedMesh: Nullable<AbstractMesh>;
  23669. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  23670. bu: number;
  23671. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  23672. bv: number;
  23673. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  23674. faceId: number;
  23675. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  23676. subMeshFaceId: number;
  23677. /** Id of the the submesh that was picked */
  23678. subMeshId: number;
  23679. /** If a sprite was picked, this will be the sprite the pick collided with */
  23680. pickedSprite: Nullable<Sprite>;
  23681. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  23682. thinInstanceIndex: number;
  23683. /**
  23684. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  23685. */
  23686. originMesh: Nullable<AbstractMesh>;
  23687. /**
  23688. * The ray that was used to perform the picking.
  23689. */
  23690. ray: Nullable<Ray>;
  23691. /**
  23692. * Gets the normal correspodning to the face the pick collided with
  23693. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  23694. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  23695. * @returns The normal correspodning to the face the pick collided with
  23696. */
  23697. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  23698. /**
  23699. * Gets the texture coordinates of where the pick occured
  23700. * @returns the vector containing the coordnates of the texture
  23701. */
  23702. getTextureCoordinates(): Nullable<Vector2>;
  23703. }
  23704. }
  23705. declare module BABYLON {
  23706. /**
  23707. * Gather the list of pointer event types as constants.
  23708. */
  23709. export class PointerEventTypes {
  23710. /**
  23711. * 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.
  23712. */
  23713. static readonly POINTERDOWN: number;
  23714. /**
  23715. * The pointerup event is fired when a pointer is no longer active.
  23716. */
  23717. static readonly POINTERUP: number;
  23718. /**
  23719. * The pointermove event is fired when a pointer changes coordinates.
  23720. */
  23721. static readonly POINTERMOVE: number;
  23722. /**
  23723. * The pointerwheel event is fired when a mouse wheel has been rotated.
  23724. */
  23725. static readonly POINTERWHEEL: number;
  23726. /**
  23727. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  23728. */
  23729. static readonly POINTERPICK: number;
  23730. /**
  23731. * The pointertap event is fired when a the object has been touched and released without drag.
  23732. */
  23733. static readonly POINTERTAP: number;
  23734. /**
  23735. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  23736. */
  23737. static readonly POINTERDOUBLETAP: number;
  23738. }
  23739. /**
  23740. * Base class of pointer info types.
  23741. */
  23742. export class PointerInfoBase {
  23743. /**
  23744. * Defines the type of event (PointerEventTypes)
  23745. */
  23746. type: number;
  23747. /**
  23748. * Defines the related dom event
  23749. */
  23750. event: PointerEvent | MouseWheelEvent;
  23751. /**
  23752. * Instantiates the base class of pointers info.
  23753. * @param type Defines the type of event (PointerEventTypes)
  23754. * @param event Defines the related dom event
  23755. */
  23756. constructor(
  23757. /**
  23758. * Defines the type of event (PointerEventTypes)
  23759. */
  23760. type: number,
  23761. /**
  23762. * Defines the related dom event
  23763. */
  23764. event: PointerEvent | MouseWheelEvent);
  23765. }
  23766. /**
  23767. * This class is used to store pointer related info for the onPrePointerObservable event.
  23768. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  23769. */
  23770. export class PointerInfoPre extends PointerInfoBase {
  23771. /**
  23772. * Ray from a pointer if availible (eg. 6dof controller)
  23773. */
  23774. ray: Nullable<Ray>;
  23775. /**
  23776. * Defines the local position of the pointer on the canvas.
  23777. */
  23778. localPosition: Vector2;
  23779. /**
  23780. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  23781. */
  23782. skipOnPointerObservable: boolean;
  23783. /**
  23784. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  23785. * @param type Defines the type of event (PointerEventTypes)
  23786. * @param event Defines the related dom event
  23787. * @param localX Defines the local x coordinates of the pointer when the event occured
  23788. * @param localY Defines the local y coordinates of the pointer when the event occured
  23789. */
  23790. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  23791. }
  23792. /**
  23793. * This type contains all the data related to a pointer event in Babylon.js.
  23794. * 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.
  23795. */
  23796. export class PointerInfo extends PointerInfoBase {
  23797. /**
  23798. * Defines the picking info associated to the info (if any)\
  23799. */
  23800. pickInfo: Nullable<PickingInfo>;
  23801. /**
  23802. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  23803. * @param type Defines the type of event (PointerEventTypes)
  23804. * @param event Defines the related dom event
  23805. * @param pickInfo Defines the picking info associated to the info (if any)\
  23806. */
  23807. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  23808. /**
  23809. * Defines the picking info associated to the info (if any)\
  23810. */
  23811. pickInfo: Nullable<PickingInfo>);
  23812. }
  23813. /**
  23814. * Data relating to a touch event on the screen.
  23815. */
  23816. export interface PointerTouch {
  23817. /**
  23818. * X coordinate of touch.
  23819. */
  23820. x: number;
  23821. /**
  23822. * Y coordinate of touch.
  23823. */
  23824. y: number;
  23825. /**
  23826. * Id of touch. Unique for each finger.
  23827. */
  23828. pointerId: number;
  23829. /**
  23830. * Event type passed from DOM.
  23831. */
  23832. type: any;
  23833. }
  23834. }
  23835. declare module BABYLON {
  23836. /**
  23837. * Manage the mouse inputs to control the movement of a free camera.
  23838. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  23839. */
  23840. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  23841. /**
  23842. * Define if touch is enabled in the mouse input
  23843. */
  23844. touchEnabled: boolean;
  23845. /**
  23846. * Defines the camera the input is attached to.
  23847. */
  23848. camera: FreeCamera;
  23849. /**
  23850. * Defines the buttons associated with the input to handle camera move.
  23851. */
  23852. buttons: number[];
  23853. /**
  23854. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  23855. */
  23856. angularSensibility: number;
  23857. private _pointerInput;
  23858. private _onMouseMove;
  23859. private _observer;
  23860. private previousPosition;
  23861. /**
  23862. * Observable for when a pointer move event occurs containing the move offset
  23863. */
  23864. onPointerMovedObservable: Observable<{
  23865. offsetX: number;
  23866. offsetY: number;
  23867. }>;
  23868. /**
  23869. * @hidden
  23870. * If the camera should be rotated automatically based on pointer movement
  23871. */
  23872. _allowCameraRotation: boolean;
  23873. /**
  23874. * Manage the mouse inputs to control the movement of a free camera.
  23875. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  23876. * @param touchEnabled Defines if touch is enabled or not
  23877. */
  23878. constructor(
  23879. /**
  23880. * Define if touch is enabled in the mouse input
  23881. */
  23882. touchEnabled?: boolean);
  23883. /**
  23884. * Attach the input controls to a specific dom element to get the input from.
  23885. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  23886. */
  23887. attachControl(noPreventDefault?: boolean): void;
  23888. /**
  23889. * Called on JS contextmenu event.
  23890. * Override this method to provide functionality.
  23891. */
  23892. protected onContextMenu(evt: PointerEvent): void;
  23893. /**
  23894. * Detach the current controls from the specified dom element.
  23895. */
  23896. detachControl(): void;
  23897. /**
  23898. * Gets the class name of the current intput.
  23899. * @returns the class name
  23900. */
  23901. getClassName(): string;
  23902. /**
  23903. * Get the friendly name associated with the input class.
  23904. * @returns the input friendly name
  23905. */
  23906. getSimpleName(): string;
  23907. }
  23908. }
  23909. declare module BABYLON {
  23910. /**
  23911. * Base class for mouse wheel input..
  23912. * See FollowCameraMouseWheelInput in src/Cameras/Inputs/freeCameraMouseWheelInput.ts
  23913. * for example usage.
  23914. */
  23915. export abstract class BaseCameraMouseWheelInput implements ICameraInput<Camera> {
  23916. /**
  23917. * Defines the camera the input is attached to.
  23918. */
  23919. abstract camera: Camera;
  23920. /**
  23921. * How fast is the camera moves in relation to X axis mouseWheel events.
  23922. * Use negative value to reverse direction.
  23923. */
  23924. wheelPrecisionX: number;
  23925. /**
  23926. * How fast is the camera moves in relation to Y axis mouseWheel events.
  23927. * Use negative value to reverse direction.
  23928. */
  23929. wheelPrecisionY: number;
  23930. /**
  23931. * How fast is the camera moves in relation to Z axis mouseWheel events.
  23932. * Use negative value to reverse direction.
  23933. */
  23934. wheelPrecisionZ: number;
  23935. /**
  23936. * Observable for when a mouse wheel move event occurs.
  23937. */
  23938. onChangedObservable: Observable<{
  23939. wheelDeltaX: number;
  23940. wheelDeltaY: number;
  23941. wheelDeltaZ: number;
  23942. }>;
  23943. private _wheel;
  23944. private _observer;
  23945. /**
  23946. * Attach the input controls to a specific dom element to get the input from.
  23947. * @param noPreventDefault Defines whether event caught by the controls
  23948. * should call preventdefault().
  23949. * (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  23950. */
  23951. attachControl(noPreventDefault?: boolean): void;
  23952. /**
  23953. * Detach the current controls from the specified dom element.
  23954. */
  23955. detachControl(): void;
  23956. /**
  23957. * Called for each rendered frame.
  23958. */
  23959. checkInputs(): void;
  23960. /**
  23961. * Gets the class name of the current intput.
  23962. * @returns the class name
  23963. */
  23964. getClassName(): string;
  23965. /**
  23966. * Get the friendly name associated with the input class.
  23967. * @returns the input friendly name
  23968. */
  23969. getSimpleName(): string;
  23970. /**
  23971. * Incremental value of multiple mouse wheel movements of the X axis.
  23972. * Should be zero-ed when read.
  23973. */
  23974. protected _wheelDeltaX: number;
  23975. /**
  23976. * Incremental value of multiple mouse wheel movements of the Y axis.
  23977. * Should be zero-ed when read.
  23978. */
  23979. protected _wheelDeltaY: number;
  23980. /**
  23981. * Incremental value of multiple mouse wheel movements of the Z axis.
  23982. * Should be zero-ed when read.
  23983. */
  23984. protected _wheelDeltaZ: number;
  23985. /**
  23986. * Firefox uses a different scheme to report scroll distances to other
  23987. * browsers. Rather than use complicated methods to calculate the exact
  23988. * multiple we need to apply, let's just cheat and use a constant.
  23989. * https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaMode
  23990. * https://stackoverflow.com/questions/20110224/what-is-the-height-of-a-line-in-a-wheel-event-deltamode-dom-delta-line
  23991. */
  23992. private readonly _ffMultiplier;
  23993. /**
  23994. * Different event attributes for wheel data fall into a few set ranges.
  23995. * Some relevant but dated date here:
  23996. * https://stackoverflow.com/questions/5527601/normalizing-mousewheel-speed-across-browsers
  23997. */
  23998. private readonly _normalize;
  23999. }
  24000. }
  24001. declare module BABYLON {
  24002. /**
  24003. * Manage the mouse wheel inputs to control a free camera.
  24004. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  24005. */
  24006. export class FreeCameraMouseWheelInput extends BaseCameraMouseWheelInput {
  24007. /**
  24008. * Defines the camera the input is attached to.
  24009. */
  24010. camera: FreeCamera;
  24011. /**
  24012. * Gets the class name of the current input.
  24013. * @returns the class name
  24014. */
  24015. getClassName(): string;
  24016. /**
  24017. * Set which movement axis (relative to camera's orientation) the mouse
  24018. * wheel's X axis controls.
  24019. * @param axis The axis to be moved. Set null to clear.
  24020. */
  24021. set wheelXMoveRelative(axis: Nullable<Coordinate>);
  24022. /**
  24023. * Get the configured movement axis (relative to camera's orientation) the
  24024. * mouse wheel's X axis controls.
  24025. * @returns The configured axis or null if none.
  24026. */
  24027. get wheelXMoveRelative(): Nullable<Coordinate>;
  24028. /**
  24029. * Set which movement axis (relative to camera's orientation) the mouse
  24030. * wheel's Y axis controls.
  24031. * @param axis The axis to be moved. Set null to clear.
  24032. */
  24033. set wheelYMoveRelative(axis: Nullable<Coordinate>);
  24034. /**
  24035. * Get the configured movement axis (relative to camera's orientation) the
  24036. * mouse wheel's Y axis controls.
  24037. * @returns The configured axis or null if none.
  24038. */
  24039. get wheelYMoveRelative(): Nullable<Coordinate>;
  24040. /**
  24041. * Set which movement axis (relative to camera's orientation) the mouse
  24042. * wheel's Z axis controls.
  24043. * @param axis The axis to be moved. Set null to clear.
  24044. */
  24045. set wheelZMoveRelative(axis: Nullable<Coordinate>);
  24046. /**
  24047. * Get the configured movement axis (relative to camera's orientation) the
  24048. * mouse wheel's Z axis controls.
  24049. * @returns The configured axis or null if none.
  24050. */
  24051. get wheelZMoveRelative(): Nullable<Coordinate>;
  24052. /**
  24053. * Set which rotation axis (relative to camera's orientation) the mouse
  24054. * wheel's X axis controls.
  24055. * @param axis The axis to be moved. Set null to clear.
  24056. */
  24057. set wheelXRotateRelative(axis: Nullable<Coordinate>);
  24058. /**
  24059. * Get the configured rotation axis (relative to camera's orientation) the
  24060. * mouse wheel's X axis controls.
  24061. * @returns The configured axis or null if none.
  24062. */
  24063. get wheelXRotateRelative(): Nullable<Coordinate>;
  24064. /**
  24065. * Set which rotation axis (relative to camera's orientation) the mouse
  24066. * wheel's Y axis controls.
  24067. * @param axis The axis to be moved. Set null to clear.
  24068. */
  24069. set wheelYRotateRelative(axis: Nullable<Coordinate>);
  24070. /**
  24071. * Get the configured rotation axis (relative to camera's orientation) the
  24072. * mouse wheel's Y axis controls.
  24073. * @returns The configured axis or null if none.
  24074. */
  24075. get wheelYRotateRelative(): Nullable<Coordinate>;
  24076. /**
  24077. * Set which rotation axis (relative to camera's orientation) the mouse
  24078. * wheel's Z axis controls.
  24079. * @param axis The axis to be moved. Set null to clear.
  24080. */
  24081. set wheelZRotateRelative(axis: Nullable<Coordinate>);
  24082. /**
  24083. * Get the configured rotation axis (relative to camera's orientation) the
  24084. * mouse wheel's Z axis controls.
  24085. * @returns The configured axis or null if none.
  24086. */
  24087. get wheelZRotateRelative(): Nullable<Coordinate>;
  24088. /**
  24089. * Set which movement axis (relative to the scene) the mouse wheel's X axis
  24090. * controls.
  24091. * @param axis The axis to be moved. Set null to clear.
  24092. */
  24093. set wheelXMoveScene(axis: Nullable<Coordinate>);
  24094. /**
  24095. * Get the configured movement axis (relative to the scene) the mouse wheel's
  24096. * X axis controls.
  24097. * @returns The configured axis or null if none.
  24098. */
  24099. get wheelXMoveScene(): Nullable<Coordinate>;
  24100. /**
  24101. * Set which movement axis (relative to the scene) the mouse wheel's Y axis
  24102. * controls.
  24103. * @param axis The axis to be moved. Set null to clear.
  24104. */
  24105. set wheelYMoveScene(axis: Nullable<Coordinate>);
  24106. /**
  24107. * Get the configured movement axis (relative to the scene) the mouse wheel's
  24108. * Y axis controls.
  24109. * @returns The configured axis or null if none.
  24110. */
  24111. get wheelYMoveScene(): Nullable<Coordinate>;
  24112. /**
  24113. * Set which movement axis (relative to the scene) the mouse wheel's Z axis
  24114. * controls.
  24115. * @param axis The axis to be moved. Set null to clear.
  24116. */
  24117. set wheelZMoveScene(axis: Nullable<Coordinate>);
  24118. /**
  24119. * Get the configured movement axis (relative to the scene) the mouse wheel's
  24120. * Z axis controls.
  24121. * @returns The configured axis or null if none.
  24122. */
  24123. get wheelZMoveScene(): Nullable<Coordinate>;
  24124. /**
  24125. * Called for each rendered frame.
  24126. */
  24127. checkInputs(): void;
  24128. private _moveRelative;
  24129. private _rotateRelative;
  24130. private _moveScene;
  24131. /**
  24132. * These are set to the desired default behaviour.
  24133. */
  24134. private _wheelXAction;
  24135. private _wheelXActionCoordinate;
  24136. private _wheelYAction;
  24137. private _wheelYActionCoordinate;
  24138. private _wheelZAction;
  24139. private _wheelZActionCoordinate;
  24140. /**
  24141. * Update the camera according to any configured properties for the 3
  24142. * mouse-wheel axis.
  24143. */
  24144. private _updateCamera;
  24145. }
  24146. }
  24147. declare module BABYLON {
  24148. /**
  24149. * Manage the touch inputs to control the movement of a free camera.
  24150. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  24151. */
  24152. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  24153. /**
  24154. * Define if mouse events can be treated as touch events
  24155. */
  24156. allowMouse: boolean;
  24157. /**
  24158. * Defines the camera the input is attached to.
  24159. */
  24160. camera: FreeCamera;
  24161. /**
  24162. * Defines the touch sensibility for rotation.
  24163. * The higher the faster.
  24164. */
  24165. touchAngularSensibility: number;
  24166. /**
  24167. * Defines the touch sensibility for move.
  24168. * The higher the faster.
  24169. */
  24170. touchMoveSensibility: number;
  24171. private _offsetX;
  24172. private _offsetY;
  24173. private _pointerPressed;
  24174. private _pointerInput?;
  24175. private _observer;
  24176. private _onLostFocus;
  24177. /**
  24178. * Manage the touch inputs to control the movement of a free camera.
  24179. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  24180. * @param allowMouse Defines if mouse events can be treated as touch events
  24181. */
  24182. constructor(
  24183. /**
  24184. * Define if mouse events can be treated as touch events
  24185. */
  24186. allowMouse?: boolean);
  24187. /**
  24188. * Attach the input controls to a specific dom element to get the input from.
  24189. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  24190. */
  24191. attachControl(noPreventDefault?: boolean): void;
  24192. /**
  24193. * Detach the current controls from the specified dom element.
  24194. */
  24195. detachControl(): void;
  24196. /**
  24197. * Update the current camera state depending on the inputs that have been used this frame.
  24198. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  24199. */
  24200. checkInputs(): void;
  24201. /**
  24202. * Gets the class name of the current intput.
  24203. * @returns the class name
  24204. */
  24205. getClassName(): string;
  24206. /**
  24207. * Get the friendly name associated with the input class.
  24208. * @returns the input friendly name
  24209. */
  24210. getSimpleName(): string;
  24211. }
  24212. }
  24213. declare module BABYLON {
  24214. /**
  24215. * Default Inputs manager for the FreeCamera.
  24216. * It groups all the default supported inputs for ease of use.
  24217. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  24218. */
  24219. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  24220. /**
  24221. * @hidden
  24222. */
  24223. _mouseInput: Nullable<FreeCameraMouseInput>;
  24224. /**
  24225. * @hidden
  24226. */
  24227. _mouseWheelInput: Nullable<FreeCameraMouseWheelInput>;
  24228. /**
  24229. * Instantiates a new FreeCameraInputsManager.
  24230. * @param camera Defines the camera the inputs belong to
  24231. */
  24232. constructor(camera: FreeCamera);
  24233. /**
  24234. * Add keyboard input support to the input manager.
  24235. * @returns the current input manager
  24236. */
  24237. addKeyboard(): FreeCameraInputsManager;
  24238. /**
  24239. * Add mouse input support to the input manager.
  24240. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  24241. * @returns the current input manager
  24242. */
  24243. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  24244. /**
  24245. * Removes the mouse input support from the manager
  24246. * @returns the current input manager
  24247. */
  24248. removeMouse(): FreeCameraInputsManager;
  24249. /**
  24250. * Add mouse wheel input support to the input manager.
  24251. * @returns the current input manager
  24252. */
  24253. addMouseWheel(): FreeCameraInputsManager;
  24254. /**
  24255. * Removes the mouse wheel input support from the manager
  24256. * @returns the current input manager
  24257. */
  24258. removeMouseWheel(): FreeCameraInputsManager;
  24259. /**
  24260. * Add touch input support to the input manager.
  24261. * @returns the current input manager
  24262. */
  24263. addTouch(): FreeCameraInputsManager;
  24264. /**
  24265. * Remove all attached input methods from a camera
  24266. */
  24267. clear(): void;
  24268. }
  24269. }
  24270. declare module BABYLON {
  24271. /**
  24272. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  24273. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  24274. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  24275. */
  24276. export class FreeCamera extends TargetCamera {
  24277. /**
  24278. * Define the collision ellipsoid of the camera.
  24279. * This is helpful to simulate a camera body like the player body around the camera
  24280. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  24281. */
  24282. ellipsoid: Vector3;
  24283. /**
  24284. * Define an offset for the position of the ellipsoid around the camera.
  24285. * This can be helpful to determine the center of the body near the gravity center of the body
  24286. * instead of its head.
  24287. */
  24288. ellipsoidOffset: Vector3;
  24289. /**
  24290. * Enable or disable collisions of the camera with the rest of the scene objects.
  24291. */
  24292. checkCollisions: boolean;
  24293. /**
  24294. * Enable or disable gravity on the camera.
  24295. */
  24296. applyGravity: boolean;
  24297. /**
  24298. * Define the input manager associated to the camera.
  24299. */
  24300. inputs: FreeCameraInputsManager;
  24301. /**
  24302. * Gets the input sensibility for a mouse input. (default is 2000.0)
  24303. * Higher values reduce sensitivity.
  24304. */
  24305. get angularSensibility(): number;
  24306. /**
  24307. * Sets the input sensibility for a mouse input. (default is 2000.0)
  24308. * Higher values reduce sensitivity.
  24309. */
  24310. set angularSensibility(value: number);
  24311. /**
  24312. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  24313. */
  24314. get keysUp(): number[];
  24315. set keysUp(value: number[]);
  24316. /**
  24317. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  24318. */
  24319. get keysUpward(): number[];
  24320. set keysUpward(value: number[]);
  24321. /**
  24322. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  24323. */
  24324. get keysDown(): number[];
  24325. set keysDown(value: number[]);
  24326. /**
  24327. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  24328. */
  24329. get keysDownward(): number[];
  24330. set keysDownward(value: number[]);
  24331. /**
  24332. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  24333. */
  24334. get keysLeft(): number[];
  24335. set keysLeft(value: number[]);
  24336. /**
  24337. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  24338. */
  24339. get keysRight(): number[];
  24340. set keysRight(value: number[]);
  24341. /**
  24342. * Event raised when the camera collide with a mesh in the scene.
  24343. */
  24344. onCollide: (collidedMesh: AbstractMesh) => void;
  24345. private _collider;
  24346. private _needMoveForGravity;
  24347. private _oldPosition;
  24348. private _diffPosition;
  24349. private _newPosition;
  24350. /** @hidden */
  24351. _localDirection: Vector3;
  24352. /** @hidden */
  24353. _transformedDirection: Vector3;
  24354. /**
  24355. * Instantiates a Free Camera.
  24356. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  24357. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  24358. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  24359. * @param name Define the name of the camera in the scene
  24360. * @param position Define the start position of the camera in the scene
  24361. * @param scene Define the scene the camera belongs to
  24362. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  24363. */
  24364. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  24365. /**
  24366. * Attach the input controls to a specific dom element to get the input from.
  24367. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  24368. */
  24369. attachControl(noPreventDefault?: boolean): void;
  24370. /**
  24371. * Attach the input controls to a specific dom element to get the input from.
  24372. * @param ignored defines an ignored parameter kept for backward compatibility. If you want to define the source input element, you can set engine.inputElement before calling camera.attachControl
  24373. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  24374. * BACK COMPAT SIGNATURE ONLY.
  24375. */
  24376. attachControl(ignored: any, noPreventDefault?: boolean): void;
  24377. /**
  24378. * Detach the current controls from the specified dom element.
  24379. */
  24380. detachControl(): void;
  24381. /**
  24382. * Detach the current controls from the specified dom element.
  24383. * @param ignored defines an ignored parameter kept for backward compatibility. If you want to define the source input element, you can set engine.inputElement before calling camera.attachControl
  24384. */
  24385. detachControl(ignored: any): void;
  24386. private _collisionMask;
  24387. /**
  24388. * Define a collision mask to limit the list of object the camera can collide with
  24389. */
  24390. get collisionMask(): number;
  24391. set collisionMask(mask: number);
  24392. /** @hidden */
  24393. _collideWithWorld(displacement: Vector3): void;
  24394. private _onCollisionPositionChange;
  24395. /** @hidden */
  24396. _checkInputs(): void;
  24397. /** @hidden */
  24398. _decideIfNeedsToMove(): boolean;
  24399. /** @hidden */
  24400. _updatePosition(): void;
  24401. /**
  24402. * Destroy the camera and release the current resources hold by it.
  24403. */
  24404. dispose(): void;
  24405. /**
  24406. * Gets the current object class name.
  24407. * @return the class name
  24408. */
  24409. getClassName(): string;
  24410. }
  24411. }
  24412. declare module BABYLON {
  24413. /**
  24414. * Represents a gamepad control stick position
  24415. */
  24416. export class StickValues {
  24417. /**
  24418. * The x component of the control stick
  24419. */
  24420. x: number;
  24421. /**
  24422. * The y component of the control stick
  24423. */
  24424. y: number;
  24425. /**
  24426. * Initializes the gamepad x and y control stick values
  24427. * @param x The x component of the gamepad control stick value
  24428. * @param y The y component of the gamepad control stick value
  24429. */
  24430. constructor(
  24431. /**
  24432. * The x component of the control stick
  24433. */
  24434. x: number,
  24435. /**
  24436. * The y component of the control stick
  24437. */
  24438. y: number);
  24439. }
  24440. /**
  24441. * An interface which manages callbacks for gamepad button changes
  24442. */
  24443. export interface GamepadButtonChanges {
  24444. /**
  24445. * Called when a gamepad has been changed
  24446. */
  24447. changed: boolean;
  24448. /**
  24449. * Called when a gamepad press event has been triggered
  24450. */
  24451. pressChanged: boolean;
  24452. /**
  24453. * Called when a touch event has been triggered
  24454. */
  24455. touchChanged: boolean;
  24456. /**
  24457. * Called when a value has changed
  24458. */
  24459. valueChanged: boolean;
  24460. }
  24461. /**
  24462. * Represents a gamepad
  24463. */
  24464. export class Gamepad {
  24465. /**
  24466. * The id of the gamepad
  24467. */
  24468. id: string;
  24469. /**
  24470. * The index of the gamepad
  24471. */
  24472. index: number;
  24473. /**
  24474. * The browser gamepad
  24475. */
  24476. browserGamepad: any;
  24477. /**
  24478. * Specifies what type of gamepad this represents
  24479. */
  24480. type: number;
  24481. private _leftStick;
  24482. private _rightStick;
  24483. /** @hidden */
  24484. _isConnected: boolean;
  24485. private _leftStickAxisX;
  24486. private _leftStickAxisY;
  24487. private _rightStickAxisX;
  24488. private _rightStickAxisY;
  24489. /**
  24490. * Triggered when the left control stick has been changed
  24491. */
  24492. private _onleftstickchanged;
  24493. /**
  24494. * Triggered when the right control stick has been changed
  24495. */
  24496. private _onrightstickchanged;
  24497. /**
  24498. * Represents a gamepad controller
  24499. */
  24500. static GAMEPAD: number;
  24501. /**
  24502. * Represents a generic controller
  24503. */
  24504. static GENERIC: number;
  24505. /**
  24506. * Represents an XBox controller
  24507. */
  24508. static XBOX: number;
  24509. /**
  24510. * Represents a pose-enabled controller
  24511. */
  24512. static POSE_ENABLED: number;
  24513. /**
  24514. * Represents an Dual Shock controller
  24515. */
  24516. static DUALSHOCK: number;
  24517. /**
  24518. * Specifies whether the left control stick should be Y-inverted
  24519. */
  24520. protected _invertLeftStickY: boolean;
  24521. /**
  24522. * Specifies if the gamepad has been connected
  24523. */
  24524. get isConnected(): boolean;
  24525. /**
  24526. * Initializes the gamepad
  24527. * @param id The id of the gamepad
  24528. * @param index The index of the gamepad
  24529. * @param browserGamepad The browser gamepad
  24530. * @param leftStickX The x component of the left joystick
  24531. * @param leftStickY The y component of the left joystick
  24532. * @param rightStickX The x component of the right joystick
  24533. * @param rightStickY The y component of the right joystick
  24534. */
  24535. constructor(
  24536. /**
  24537. * The id of the gamepad
  24538. */
  24539. id: string,
  24540. /**
  24541. * The index of the gamepad
  24542. */
  24543. index: number,
  24544. /**
  24545. * The browser gamepad
  24546. */
  24547. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  24548. /**
  24549. * Callback triggered when the left joystick has changed
  24550. * @param callback
  24551. */
  24552. onleftstickchanged(callback: (values: StickValues) => void): void;
  24553. /**
  24554. * Callback triggered when the right joystick has changed
  24555. * @param callback
  24556. */
  24557. onrightstickchanged(callback: (values: StickValues) => void): void;
  24558. /**
  24559. * Gets the left joystick
  24560. */
  24561. get leftStick(): StickValues;
  24562. /**
  24563. * Sets the left joystick values
  24564. */
  24565. set leftStick(newValues: StickValues);
  24566. /**
  24567. * Gets the right joystick
  24568. */
  24569. get rightStick(): StickValues;
  24570. /**
  24571. * Sets the right joystick value
  24572. */
  24573. set rightStick(newValues: StickValues);
  24574. /**
  24575. * Updates the gamepad joystick positions
  24576. */
  24577. update(): void;
  24578. /**
  24579. * Disposes the gamepad
  24580. */
  24581. dispose(): void;
  24582. }
  24583. /**
  24584. * Represents a generic gamepad
  24585. */
  24586. export class GenericPad extends Gamepad {
  24587. private _buttons;
  24588. private _onbuttondown;
  24589. private _onbuttonup;
  24590. /**
  24591. * Observable triggered when a button has been pressed
  24592. */
  24593. onButtonDownObservable: Observable<number>;
  24594. /**
  24595. * Observable triggered when a button has been released
  24596. */
  24597. onButtonUpObservable: Observable<number>;
  24598. /**
  24599. * Callback triggered when a button has been pressed
  24600. * @param callback Called when a button has been pressed
  24601. */
  24602. onbuttondown(callback: (buttonPressed: number) => void): void;
  24603. /**
  24604. * Callback triggered when a button has been released
  24605. * @param callback Called when a button has been released
  24606. */
  24607. onbuttonup(callback: (buttonReleased: number) => void): void;
  24608. /**
  24609. * Initializes the generic gamepad
  24610. * @param id The id of the generic gamepad
  24611. * @param index The index of the generic gamepad
  24612. * @param browserGamepad The browser gamepad
  24613. */
  24614. constructor(id: string, index: number, browserGamepad: any);
  24615. private _setButtonValue;
  24616. /**
  24617. * Updates the generic gamepad
  24618. */
  24619. update(): void;
  24620. /**
  24621. * Disposes the generic gamepad
  24622. */
  24623. dispose(): void;
  24624. }
  24625. }
  24626. declare module BABYLON {
  24627. /**
  24628. * Defines a runtime animation
  24629. */
  24630. export class RuntimeAnimation {
  24631. private _events;
  24632. /**
  24633. * The current frame of the runtime animation
  24634. */
  24635. private _currentFrame;
  24636. /**
  24637. * The animation used by the runtime animation
  24638. */
  24639. private _animation;
  24640. /**
  24641. * The target of the runtime animation
  24642. */
  24643. private _target;
  24644. /**
  24645. * The initiating animatable
  24646. */
  24647. private _host;
  24648. /**
  24649. * The original value of the runtime animation
  24650. */
  24651. private _originalValue;
  24652. /**
  24653. * The original blend value of the runtime animation
  24654. */
  24655. private _originalBlendValue;
  24656. /**
  24657. * The offsets cache of the runtime animation
  24658. */
  24659. private _offsetsCache;
  24660. /**
  24661. * The high limits cache of the runtime animation
  24662. */
  24663. private _highLimitsCache;
  24664. /**
  24665. * Specifies if the runtime animation has been stopped
  24666. */
  24667. private _stopped;
  24668. /**
  24669. * The blending factor of the runtime animation
  24670. */
  24671. private _blendingFactor;
  24672. /**
  24673. * The BabylonJS scene
  24674. */
  24675. private _scene;
  24676. /**
  24677. * The current value of the runtime animation
  24678. */
  24679. private _currentValue;
  24680. /** @hidden */
  24681. _animationState: _IAnimationState;
  24682. /**
  24683. * The active target of the runtime animation
  24684. */
  24685. private _activeTargets;
  24686. private _currentActiveTarget;
  24687. private _directTarget;
  24688. /**
  24689. * The target path of the runtime animation
  24690. */
  24691. private _targetPath;
  24692. /**
  24693. * The weight of the runtime animation
  24694. */
  24695. private _weight;
  24696. /**
  24697. * The ratio offset of the runtime animation
  24698. */
  24699. private _ratioOffset;
  24700. /**
  24701. * The previous delay of the runtime animation
  24702. */
  24703. private _previousDelay;
  24704. /**
  24705. * The previous ratio of the runtime animation
  24706. */
  24707. private _previousRatio;
  24708. private _enableBlending;
  24709. private _keys;
  24710. private _minFrame;
  24711. private _maxFrame;
  24712. private _minValue;
  24713. private _maxValue;
  24714. private _targetIsArray;
  24715. /**
  24716. * Gets the current frame of the runtime animation
  24717. */
  24718. get currentFrame(): number;
  24719. /**
  24720. * Gets the weight of the runtime animation
  24721. */
  24722. get weight(): number;
  24723. /**
  24724. * Gets the current value of the runtime animation
  24725. */
  24726. get currentValue(): any;
  24727. /**
  24728. * Gets the target path of the runtime animation
  24729. */
  24730. get targetPath(): string;
  24731. /**
  24732. * Gets the actual target of the runtime animation
  24733. */
  24734. get target(): any;
  24735. /**
  24736. * Gets the additive state of the runtime animation
  24737. */
  24738. get isAdditive(): boolean;
  24739. /** @hidden */
  24740. _onLoop: () => void;
  24741. /**
  24742. * Create a new RuntimeAnimation object
  24743. * @param target defines the target of the animation
  24744. * @param animation defines the source animation object
  24745. * @param scene defines the hosting scene
  24746. * @param host defines the initiating Animatable
  24747. */
  24748. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  24749. private _preparePath;
  24750. /**
  24751. * Gets the animation from the runtime animation
  24752. */
  24753. get animation(): Animation;
  24754. /**
  24755. * Resets the runtime animation to the beginning
  24756. * @param restoreOriginal defines whether to restore the target property to the original value
  24757. */
  24758. reset(restoreOriginal?: boolean): void;
  24759. /**
  24760. * Specifies if the runtime animation is stopped
  24761. * @returns Boolean specifying if the runtime animation is stopped
  24762. */
  24763. isStopped(): boolean;
  24764. /**
  24765. * Disposes of the runtime animation
  24766. */
  24767. dispose(): void;
  24768. /**
  24769. * Apply the interpolated value to the target
  24770. * @param currentValue defines the value computed by the animation
  24771. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  24772. */
  24773. setValue(currentValue: any, weight: number): void;
  24774. private _getOriginalValues;
  24775. private _setValue;
  24776. /**
  24777. * Gets the loop pmode of the runtime animation
  24778. * @returns Loop Mode
  24779. */
  24780. private _getCorrectLoopMode;
  24781. /**
  24782. * Move the current animation to a given frame
  24783. * @param frame defines the frame to move to
  24784. */
  24785. goToFrame(frame: number): void;
  24786. /**
  24787. * @hidden Internal use only
  24788. */
  24789. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  24790. /**
  24791. * Execute the current animation
  24792. * @param delay defines the delay to add to the current frame
  24793. * @param from defines the lower bound of the animation range
  24794. * @param to defines the upper bound of the animation range
  24795. * @param loop defines if the current animation must loop
  24796. * @param speedRatio defines the current speed ratio
  24797. * @param weight defines the weight of the animation (default is -1 so no weight)
  24798. * @param onLoop optional callback called when animation loops
  24799. * @returns a boolean indicating if the animation is running
  24800. */
  24801. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  24802. }
  24803. }
  24804. declare module BABYLON {
  24805. /**
  24806. * Class used to store an actual running animation
  24807. */
  24808. export class Animatable {
  24809. /** defines the target object */
  24810. target: any;
  24811. /** defines the starting frame number (default is 0) */
  24812. fromFrame: number;
  24813. /** defines the ending frame number (default is 100) */
  24814. toFrame: number;
  24815. /** defines if the animation must loop (default is false) */
  24816. loopAnimation: boolean;
  24817. /** defines a callback to call when animation ends if it is not looping */
  24818. onAnimationEnd?: (() => void) | null | undefined;
  24819. /** defines a callback to call when animation loops */
  24820. onAnimationLoop?: (() => void) | null | undefined;
  24821. /** defines whether the animation should be evaluated additively */
  24822. isAdditive: boolean;
  24823. private _localDelayOffset;
  24824. private _pausedDelay;
  24825. private _runtimeAnimations;
  24826. private _paused;
  24827. private _scene;
  24828. private _speedRatio;
  24829. private _weight;
  24830. private _syncRoot;
  24831. /**
  24832. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  24833. * This will only apply for non looping animation (default is true)
  24834. */
  24835. disposeOnEnd: boolean;
  24836. /**
  24837. * Gets a boolean indicating if the animation has started
  24838. */
  24839. animationStarted: boolean;
  24840. /**
  24841. * Observer raised when the animation ends
  24842. */
  24843. onAnimationEndObservable: Observable<Animatable>;
  24844. /**
  24845. * Observer raised when the animation loops
  24846. */
  24847. onAnimationLoopObservable: Observable<Animatable>;
  24848. /**
  24849. * Gets the root Animatable used to synchronize and normalize animations
  24850. */
  24851. get syncRoot(): Nullable<Animatable>;
  24852. /**
  24853. * Gets the current frame of the first RuntimeAnimation
  24854. * Used to synchronize Animatables
  24855. */
  24856. get masterFrame(): number;
  24857. /**
  24858. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  24859. */
  24860. get weight(): number;
  24861. set weight(value: number);
  24862. /**
  24863. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  24864. */
  24865. get speedRatio(): number;
  24866. set speedRatio(value: number);
  24867. /**
  24868. * Creates a new Animatable
  24869. * @param scene defines the hosting scene
  24870. * @param target defines the target object
  24871. * @param fromFrame defines the starting frame number (default is 0)
  24872. * @param toFrame defines the ending frame number (default is 100)
  24873. * @param loopAnimation defines if the animation must loop (default is false)
  24874. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  24875. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  24876. * @param animations defines a group of animation to add to the new Animatable
  24877. * @param onAnimationLoop defines a callback to call when animation loops
  24878. * @param isAdditive defines whether the animation should be evaluated additively
  24879. */
  24880. constructor(scene: Scene,
  24881. /** defines the target object */
  24882. target: any,
  24883. /** defines the starting frame number (default is 0) */
  24884. fromFrame?: number,
  24885. /** defines the ending frame number (default is 100) */
  24886. toFrame?: number,
  24887. /** defines if the animation must loop (default is false) */
  24888. loopAnimation?: boolean, speedRatio?: number,
  24889. /** defines a callback to call when animation ends if it is not looping */
  24890. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  24891. /** defines a callback to call when animation loops */
  24892. onAnimationLoop?: (() => void) | null | undefined,
  24893. /** defines whether the animation should be evaluated additively */
  24894. isAdditive?: boolean);
  24895. /**
  24896. * Synchronize and normalize current Animatable with a source Animatable
  24897. * This is useful when using animation weights and when animations are not of the same length
  24898. * @param root defines the root Animatable to synchronize with
  24899. * @returns the current Animatable
  24900. */
  24901. syncWith(root: Animatable): Animatable;
  24902. /**
  24903. * Gets the list of runtime animations
  24904. * @returns an array of RuntimeAnimation
  24905. */
  24906. getAnimations(): RuntimeAnimation[];
  24907. /**
  24908. * Adds more animations to the current animatable
  24909. * @param target defines the target of the animations
  24910. * @param animations defines the new animations to add
  24911. */
  24912. appendAnimations(target: any, animations: Animation[]): void;
  24913. /**
  24914. * Gets the source animation for a specific property
  24915. * @param property defines the propertyu to look for
  24916. * @returns null or the source animation for the given property
  24917. */
  24918. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  24919. /**
  24920. * Gets the runtime animation for a specific property
  24921. * @param property defines the propertyu to look for
  24922. * @returns null or the runtime animation for the given property
  24923. */
  24924. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  24925. /**
  24926. * Resets the animatable to its original state
  24927. */
  24928. reset(): void;
  24929. /**
  24930. * Allows the animatable to blend with current running animations
  24931. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  24932. * @param blendingSpeed defines the blending speed to use
  24933. */
  24934. enableBlending(blendingSpeed: number): void;
  24935. /**
  24936. * Disable animation blending
  24937. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  24938. */
  24939. disableBlending(): void;
  24940. /**
  24941. * Jump directly to a given frame
  24942. * @param frame defines the frame to jump to
  24943. */
  24944. goToFrame(frame: number): void;
  24945. /**
  24946. * Pause the animation
  24947. */
  24948. pause(): void;
  24949. /**
  24950. * Restart the animation
  24951. */
  24952. restart(): void;
  24953. private _raiseOnAnimationEnd;
  24954. /**
  24955. * Stop and delete the current animation
  24956. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  24957. * @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)
  24958. */
  24959. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  24960. /**
  24961. * Wait asynchronously for the animation to end
  24962. * @returns a promise which will be fullfilled when the animation ends
  24963. */
  24964. waitAsync(): Promise<Animatable>;
  24965. /** @hidden */
  24966. _animate(delay: number): boolean;
  24967. }
  24968. interface Scene {
  24969. /** @hidden */
  24970. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  24971. /** @hidden */
  24972. _processLateAnimationBindingsForMatrices(holder: {
  24973. totalWeight: number;
  24974. totalAdditiveWeight: number;
  24975. animations: RuntimeAnimation[];
  24976. additiveAnimations: RuntimeAnimation[];
  24977. originalValue: Matrix;
  24978. }): any;
  24979. /** @hidden */
  24980. _processLateAnimationBindingsForQuaternions(holder: {
  24981. totalWeight: number;
  24982. totalAdditiveWeight: number;
  24983. animations: RuntimeAnimation[];
  24984. additiveAnimations: RuntimeAnimation[];
  24985. originalValue: Quaternion;
  24986. }, refQuaternion: Quaternion): Quaternion;
  24987. /** @hidden */
  24988. _processLateAnimationBindings(): void;
  24989. /**
  24990. * Will start the animation sequence of a given target
  24991. * @param target defines the target
  24992. * @param from defines from which frame should animation start
  24993. * @param to defines until which frame should animation run.
  24994. * @param weight defines the weight to apply to the animation (1.0 by default)
  24995. * @param loop defines if the animation loops
  24996. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  24997. * @param onAnimationEnd defines the function to be executed when the animation ends
  24998. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  24999. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  25000. * @param onAnimationLoop defines the callback to call when an animation loops
  25001. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  25002. * @returns the animatable object created for this animation
  25003. */
  25004. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  25005. /**
  25006. * Will start the animation sequence of a given target
  25007. * @param target defines the target
  25008. * @param from defines from which frame should animation start
  25009. * @param to defines until which frame should animation run.
  25010. * @param loop defines if the animation loops
  25011. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  25012. * @param onAnimationEnd defines the function to be executed when the animation ends
  25013. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  25014. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  25015. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  25016. * @param onAnimationLoop defines the callback to call when an animation loops
  25017. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  25018. * @returns the animatable object created for this animation
  25019. */
  25020. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  25021. /**
  25022. * Will start the animation sequence of a given target and its hierarchy
  25023. * @param target defines the target
  25024. * @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.
  25025. * @param from defines from which frame should animation start
  25026. * @param to defines until which frame should animation run.
  25027. * @param loop defines if the animation loops
  25028. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  25029. * @param onAnimationEnd defines the function to be executed when the animation ends
  25030. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  25031. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  25032. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  25033. * @param onAnimationLoop defines the callback to call when an animation loops
  25034. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  25035. * @returns the list of created animatables
  25036. */
  25037. beginHierarchyAnimation(target: any, directDescendantsOnly: boolean, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  25038. /**
  25039. * Begin a new animation on a given node
  25040. * @param target defines the target where the animation will take place
  25041. * @param animations defines the list of animations to start
  25042. * @param from defines the initial value
  25043. * @param to defines the final value
  25044. * @param loop defines if you want animation to loop (off by default)
  25045. * @param speedRatio defines the speed ratio to apply to all animations
  25046. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  25047. * @param onAnimationLoop defines the callback to call when an animation loops
  25048. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  25049. * @returns the list of created animatables
  25050. */
  25051. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  25052. /**
  25053. * Begin a new animation on a given node and its hierarchy
  25054. * @param target defines the root node where the animation will take place
  25055. * @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.
  25056. * @param animations defines the list of animations to start
  25057. * @param from defines the initial value
  25058. * @param to defines the final value
  25059. * @param loop defines if you want animation to loop (off by default)
  25060. * @param speedRatio defines the speed ratio to apply to all animations
  25061. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  25062. * @param onAnimationLoop defines the callback to call when an animation loops
  25063. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  25064. * @returns the list of animatables created for all nodes
  25065. */
  25066. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  25067. /**
  25068. * Gets the animatable associated with a specific target
  25069. * @param target defines the target of the animatable
  25070. * @returns the required animatable if found
  25071. */
  25072. getAnimatableByTarget(target: any): Nullable<Animatable>;
  25073. /**
  25074. * Gets all animatables associated with a given target
  25075. * @param target defines the target to look animatables for
  25076. * @returns an array of Animatables
  25077. */
  25078. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  25079. /**
  25080. * Stops and removes all animations that have been applied to the scene
  25081. */
  25082. stopAllAnimations(): void;
  25083. /**
  25084. * Gets the current delta time used by animation engine
  25085. */
  25086. deltaTime: number;
  25087. }
  25088. interface Bone {
  25089. /**
  25090. * Copy an animation range from another bone
  25091. * @param source defines the source bone
  25092. * @param rangeName defines the range name to copy
  25093. * @param frameOffset defines the frame offset
  25094. * @param rescaleAsRequired defines if rescaling must be applied if required
  25095. * @param skelDimensionsRatio defines the scaling ratio
  25096. * @returns true if operation was successful
  25097. */
  25098. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  25099. }
  25100. }
  25101. declare module BABYLON {
  25102. /**
  25103. * Class used to override all child animations of a given target
  25104. */
  25105. export class AnimationPropertiesOverride {
  25106. /**
  25107. * Gets or sets a value indicating if animation blending must be used
  25108. */
  25109. enableBlending: boolean;
  25110. /**
  25111. * Gets or sets the blending speed to use when enableBlending is true
  25112. */
  25113. blendingSpeed: number;
  25114. /**
  25115. * Gets or sets the default loop mode to use
  25116. */
  25117. loopMode: number;
  25118. }
  25119. }
  25120. declare module BABYLON {
  25121. /**
  25122. * Class used to handle skinning animations
  25123. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  25124. */
  25125. export class Skeleton implements IAnimatable {
  25126. /** defines the skeleton name */
  25127. name: string;
  25128. /** defines the skeleton Id */
  25129. id: string;
  25130. /**
  25131. * Defines the list of child bones
  25132. */
  25133. bones: Bone[];
  25134. /**
  25135. * Defines an estimate of the dimension of the skeleton at rest
  25136. */
  25137. dimensionsAtRest: Vector3;
  25138. /**
  25139. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  25140. */
  25141. needInitialSkinMatrix: boolean;
  25142. /**
  25143. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  25144. */
  25145. overrideMesh: Nullable<AbstractMesh>;
  25146. /**
  25147. * Gets the list of animations attached to this skeleton
  25148. */
  25149. animations: Array<Animation>;
  25150. private _scene;
  25151. private _isDirty;
  25152. private _transformMatrices;
  25153. private _transformMatrixTexture;
  25154. private _meshesWithPoseMatrix;
  25155. private _animatables;
  25156. private _identity;
  25157. private _synchronizedWithMesh;
  25158. private _ranges;
  25159. private _lastAbsoluteTransformsUpdateId;
  25160. private _canUseTextureForBones;
  25161. private _uniqueId;
  25162. /** @hidden */
  25163. _numBonesWithLinkedTransformNode: number;
  25164. /** @hidden */
  25165. _hasWaitingData: Nullable<boolean>;
  25166. /** @hidden */
  25167. _waitingOverrideMeshId: Nullable<string>;
  25168. /**
  25169. * Specifies if the skeleton should be serialized
  25170. */
  25171. doNotSerialize: boolean;
  25172. private _useTextureToStoreBoneMatrices;
  25173. /**
  25174. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  25175. * Please note that this option is not available if the hardware does not support it
  25176. */
  25177. get useTextureToStoreBoneMatrices(): boolean;
  25178. set useTextureToStoreBoneMatrices(value: boolean);
  25179. private _animationPropertiesOverride;
  25180. /**
  25181. * Gets or sets the animation properties override
  25182. */
  25183. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  25184. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  25185. /**
  25186. * List of inspectable custom properties (used by the Inspector)
  25187. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  25188. */
  25189. inspectableCustomProperties: IInspectable[];
  25190. /**
  25191. * An observable triggered before computing the skeleton's matrices
  25192. */
  25193. onBeforeComputeObservable: Observable<Skeleton>;
  25194. /**
  25195. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  25196. */
  25197. get isUsingTextureForMatrices(): boolean;
  25198. /**
  25199. * Gets the unique ID of this skeleton
  25200. */
  25201. get uniqueId(): number;
  25202. /**
  25203. * Creates a new skeleton
  25204. * @param name defines the skeleton name
  25205. * @param id defines the skeleton Id
  25206. * @param scene defines the hosting scene
  25207. */
  25208. constructor(
  25209. /** defines the skeleton name */
  25210. name: string,
  25211. /** defines the skeleton Id */
  25212. id: string, scene: Scene);
  25213. /**
  25214. * Gets the current object class name.
  25215. * @return the class name
  25216. */
  25217. getClassName(): string;
  25218. /**
  25219. * Returns an array containing the root bones
  25220. * @returns an array containing the root bones
  25221. */
  25222. getChildren(): Array<Bone>;
  25223. /**
  25224. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  25225. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  25226. * @returns a Float32Array containing matrices data
  25227. */
  25228. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  25229. /**
  25230. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  25231. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  25232. * @returns a raw texture containing the data
  25233. */
  25234. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  25235. /**
  25236. * Gets the current hosting scene
  25237. * @returns a scene object
  25238. */
  25239. getScene(): Scene;
  25240. /**
  25241. * Gets a string representing the current skeleton data
  25242. * @param fullDetails defines a boolean indicating if we want a verbose version
  25243. * @returns a string representing the current skeleton data
  25244. */
  25245. toString(fullDetails?: boolean): string;
  25246. /**
  25247. * Get bone's index searching by name
  25248. * @param name defines bone's name to search for
  25249. * @return the indice of the bone. Returns -1 if not found
  25250. */
  25251. getBoneIndexByName(name: string): number;
  25252. /**
  25253. * Creater a new animation range
  25254. * @param name defines the name of the range
  25255. * @param from defines the start key
  25256. * @param to defines the end key
  25257. */
  25258. createAnimationRange(name: string, from: number, to: number): void;
  25259. /**
  25260. * Delete a specific animation range
  25261. * @param name defines the name of the range
  25262. * @param deleteFrames defines if frames must be removed as well
  25263. */
  25264. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  25265. /**
  25266. * Gets a specific animation range
  25267. * @param name defines the name of the range to look for
  25268. * @returns the requested animation range or null if not found
  25269. */
  25270. getAnimationRange(name: string): Nullable<AnimationRange>;
  25271. /**
  25272. * Gets the list of all animation ranges defined on this skeleton
  25273. * @returns an array
  25274. */
  25275. getAnimationRanges(): Nullable<AnimationRange>[];
  25276. /**
  25277. * Copy animation range from a source skeleton.
  25278. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  25279. * @param source defines the source skeleton
  25280. * @param name defines the name of the range to copy
  25281. * @param rescaleAsRequired defines if rescaling must be applied if required
  25282. * @returns true if operation was successful
  25283. */
  25284. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  25285. /**
  25286. * Forces the skeleton to go to rest pose
  25287. */
  25288. returnToRest(): void;
  25289. private _getHighestAnimationFrame;
  25290. /**
  25291. * Begin a specific animation range
  25292. * @param name defines the name of the range to start
  25293. * @param loop defines if looping must be turned on (false by default)
  25294. * @param speedRatio defines the speed ratio to apply (1 by default)
  25295. * @param onAnimationEnd defines a callback which will be called when animation will end
  25296. * @returns a new animatable
  25297. */
  25298. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  25299. /**
  25300. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  25301. * @param skeleton defines the Skeleton containing the animation range to convert
  25302. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  25303. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  25304. * @returns the original skeleton
  25305. */
  25306. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  25307. /** @hidden */
  25308. _markAsDirty(): void;
  25309. /** @hidden */
  25310. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  25311. /** @hidden */
  25312. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  25313. private _computeTransformMatrices;
  25314. /**
  25315. * Build all resources required to render a skeleton
  25316. */
  25317. prepare(): void;
  25318. /**
  25319. * Gets the list of animatables currently running for this skeleton
  25320. * @returns an array of animatables
  25321. */
  25322. getAnimatables(): IAnimatable[];
  25323. /**
  25324. * Clone the current skeleton
  25325. * @param name defines the name of the new skeleton
  25326. * @param id defines the id of the new skeleton
  25327. * @returns the new skeleton
  25328. */
  25329. clone(name: string, id?: string): Skeleton;
  25330. /**
  25331. * Enable animation blending for this skeleton
  25332. * @param blendingSpeed defines the blending speed to apply
  25333. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  25334. */
  25335. enableBlending(blendingSpeed?: number): void;
  25336. /**
  25337. * Releases all resources associated with the current skeleton
  25338. */
  25339. dispose(): void;
  25340. /**
  25341. * Serialize the skeleton in a JSON object
  25342. * @returns a JSON object
  25343. */
  25344. serialize(): any;
  25345. /**
  25346. * Creates a new skeleton from serialized data
  25347. * @param parsedSkeleton defines the serialized data
  25348. * @param scene defines the hosting scene
  25349. * @returns a new skeleton
  25350. */
  25351. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  25352. /**
  25353. * Compute all node absolute transforms
  25354. * @param forceUpdate defines if computation must be done even if cache is up to date
  25355. */
  25356. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  25357. /**
  25358. * Gets the root pose matrix
  25359. * @returns a matrix
  25360. */
  25361. getPoseMatrix(): Nullable<Matrix>;
  25362. /**
  25363. * Sorts bones per internal index
  25364. */
  25365. sortBones(): void;
  25366. private _sortBones;
  25367. /**
  25368. * Set the current local matrix as the restPose for all bones in the skeleton.
  25369. */
  25370. setCurrentPoseAsRest(): void;
  25371. }
  25372. }
  25373. declare module BABYLON {
  25374. /**
  25375. * Class used to store bone information
  25376. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  25377. */
  25378. export class Bone extends Node {
  25379. /**
  25380. * defines the bone name
  25381. */
  25382. name: string;
  25383. private static _tmpVecs;
  25384. private static _tmpQuat;
  25385. private static _tmpMats;
  25386. /**
  25387. * Gets the list of child bones
  25388. */
  25389. children: Bone[];
  25390. /** Gets the animations associated with this bone */
  25391. animations: Animation[];
  25392. /**
  25393. * Gets or sets bone length
  25394. */
  25395. length: number;
  25396. /**
  25397. * @hidden Internal only
  25398. * Set this value to map this bone to a different index in the transform matrices
  25399. * Set this value to -1 to exclude the bone from the transform matrices
  25400. */
  25401. _index: Nullable<number>;
  25402. private _skeleton;
  25403. private _localMatrix;
  25404. private _restPose;
  25405. private _bindPose;
  25406. private _baseMatrix;
  25407. private _absoluteTransform;
  25408. private _invertedAbsoluteTransform;
  25409. private _parent;
  25410. private _scalingDeterminant;
  25411. private _worldTransform;
  25412. private _localScaling;
  25413. private _localRotation;
  25414. private _localPosition;
  25415. private _needToDecompose;
  25416. private _needToCompose;
  25417. /** @hidden */
  25418. _linkedTransformNode: Nullable<TransformNode>;
  25419. /** @hidden */
  25420. _waitingTransformNodeId: Nullable<string>;
  25421. /** @hidden */
  25422. get _matrix(): Matrix;
  25423. /** @hidden */
  25424. set _matrix(value: Matrix);
  25425. /**
  25426. * Create a new bone
  25427. * @param name defines the bone name
  25428. * @param skeleton defines the parent skeleton
  25429. * @param parentBone defines the parent (can be null if the bone is the root)
  25430. * @param localMatrix defines the local matrix
  25431. * @param restPose defines the rest pose matrix
  25432. * @param baseMatrix defines the base matrix
  25433. * @param index defines index of the bone in the hiearchy
  25434. */
  25435. constructor(
  25436. /**
  25437. * defines the bone name
  25438. */
  25439. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  25440. /**
  25441. * Gets the current object class name.
  25442. * @return the class name
  25443. */
  25444. getClassName(): string;
  25445. /**
  25446. * Gets the parent skeleton
  25447. * @returns a skeleton
  25448. */
  25449. getSkeleton(): Skeleton;
  25450. /**
  25451. * Gets parent bone
  25452. * @returns a bone or null if the bone is the root of the bone hierarchy
  25453. */
  25454. getParent(): Nullable<Bone>;
  25455. /**
  25456. * Returns an array containing the root bones
  25457. * @returns an array containing the root bones
  25458. */
  25459. getChildren(): Array<Bone>;
  25460. /**
  25461. * Gets the node index in matrix array generated for rendering
  25462. * @returns the node index
  25463. */
  25464. getIndex(): number;
  25465. /**
  25466. * Sets the parent bone
  25467. * @param parent defines the parent (can be null if the bone is the root)
  25468. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  25469. */
  25470. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  25471. /**
  25472. * Gets the local matrix
  25473. * @returns a matrix
  25474. */
  25475. getLocalMatrix(): Matrix;
  25476. /**
  25477. * Gets the base matrix (initial matrix which remains unchanged)
  25478. * @returns a matrix
  25479. */
  25480. getBaseMatrix(): Matrix;
  25481. /**
  25482. * Gets the rest pose matrix
  25483. * @returns a matrix
  25484. */
  25485. getRestPose(): Matrix;
  25486. /**
  25487. * Sets the rest pose matrix
  25488. * @param matrix the local-space rest pose to set for this bone
  25489. */
  25490. setRestPose(matrix: Matrix): void;
  25491. /**
  25492. * Gets the bind pose matrix
  25493. * @returns the bind pose matrix
  25494. */
  25495. getBindPose(): Matrix;
  25496. /**
  25497. * Sets the bind pose matrix
  25498. * @param matrix the local-space bind pose to set for this bone
  25499. */
  25500. setBindPose(matrix: Matrix): void;
  25501. /**
  25502. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  25503. */
  25504. getWorldMatrix(): Matrix;
  25505. /**
  25506. * Sets the local matrix to rest pose matrix
  25507. */
  25508. returnToRest(): void;
  25509. /**
  25510. * Gets the inverse of the absolute transform matrix.
  25511. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  25512. * @returns a matrix
  25513. */
  25514. getInvertedAbsoluteTransform(): Matrix;
  25515. /**
  25516. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  25517. * @returns a matrix
  25518. */
  25519. getAbsoluteTransform(): Matrix;
  25520. /**
  25521. * Links with the given transform node.
  25522. * The local matrix of this bone is copied from the transform node every frame.
  25523. * @param transformNode defines the transform node to link to
  25524. */
  25525. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  25526. /**
  25527. * Gets the node used to drive the bone's transformation
  25528. * @returns a transform node or null
  25529. */
  25530. getTransformNode(): Nullable<TransformNode>;
  25531. /** Gets or sets current position (in local space) */
  25532. get position(): Vector3;
  25533. set position(newPosition: Vector3);
  25534. /** Gets or sets current rotation (in local space) */
  25535. get rotation(): Vector3;
  25536. set rotation(newRotation: Vector3);
  25537. /** Gets or sets current rotation quaternion (in local space) */
  25538. get rotationQuaternion(): Quaternion;
  25539. set rotationQuaternion(newRotation: Quaternion);
  25540. /** Gets or sets current scaling (in local space) */
  25541. get scaling(): Vector3;
  25542. set scaling(newScaling: Vector3);
  25543. /**
  25544. * Gets the animation properties override
  25545. */
  25546. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  25547. private _decompose;
  25548. private _compose;
  25549. /**
  25550. * Update the base and local matrices
  25551. * @param matrix defines the new base or local matrix
  25552. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  25553. * @param updateLocalMatrix defines if the local matrix should be updated
  25554. */
  25555. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  25556. /** @hidden */
  25557. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  25558. /**
  25559. * Flag the bone as dirty (Forcing it to update everything)
  25560. */
  25561. markAsDirty(): void;
  25562. /** @hidden */
  25563. _markAsDirtyAndCompose(): void;
  25564. private _markAsDirtyAndDecompose;
  25565. /**
  25566. * Translate the bone in local or world space
  25567. * @param vec The amount to translate the bone
  25568. * @param space The space that the translation is in
  25569. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25570. */
  25571. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  25572. /**
  25573. * Set the postion of the bone in local or world space
  25574. * @param position The position to set the bone
  25575. * @param space The space that the position is in
  25576. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25577. */
  25578. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  25579. /**
  25580. * Set the absolute position of the bone (world space)
  25581. * @param position The position to set the bone
  25582. * @param mesh The mesh that this bone is attached to
  25583. */
  25584. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  25585. /**
  25586. * Scale the bone on the x, y and z axes (in local space)
  25587. * @param x The amount to scale the bone on the x axis
  25588. * @param y The amount to scale the bone on the y axis
  25589. * @param z The amount to scale the bone on the z axis
  25590. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  25591. */
  25592. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  25593. /**
  25594. * Set the bone scaling in local space
  25595. * @param scale defines the scaling vector
  25596. */
  25597. setScale(scale: Vector3): void;
  25598. /**
  25599. * Gets the current scaling in local space
  25600. * @returns the current scaling vector
  25601. */
  25602. getScale(): Vector3;
  25603. /**
  25604. * Gets the current scaling in local space and stores it in a target vector
  25605. * @param result defines the target vector
  25606. */
  25607. getScaleToRef(result: Vector3): void;
  25608. /**
  25609. * Set the yaw, pitch, and roll of the bone in local or world space
  25610. * @param yaw The rotation of the bone on the y axis
  25611. * @param pitch The rotation of the bone on the x axis
  25612. * @param roll The rotation of the bone on the z axis
  25613. * @param space The space that the axes of rotation are in
  25614. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25615. */
  25616. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  25617. /**
  25618. * Add a rotation to the bone on an axis in local or world space
  25619. * @param axis The axis to rotate the bone on
  25620. * @param amount The amount to rotate the bone
  25621. * @param space The space that the axis is in
  25622. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25623. */
  25624. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  25625. /**
  25626. * Set the rotation of the bone to a particular axis angle in local or world space
  25627. * @param axis The axis to rotate the bone on
  25628. * @param angle The angle that the bone should be rotated to
  25629. * @param space The space that the axis is in
  25630. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25631. */
  25632. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  25633. /**
  25634. * Set the euler rotation of the bone in local or world space
  25635. * @param rotation The euler rotation that the bone should be set to
  25636. * @param space The space that the rotation is in
  25637. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25638. */
  25639. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  25640. /**
  25641. * Set the quaternion rotation of the bone in local or world space
  25642. * @param quat The quaternion rotation that the bone should be set to
  25643. * @param space The space that the rotation is in
  25644. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25645. */
  25646. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  25647. /**
  25648. * Set the rotation matrix of the bone in local or world space
  25649. * @param rotMat The rotation matrix that the bone should be set to
  25650. * @param space The space that the rotation is in
  25651. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25652. */
  25653. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  25654. private _rotateWithMatrix;
  25655. private _getNegativeRotationToRef;
  25656. /**
  25657. * Get the position of the bone in local or world space
  25658. * @param space The space that the returned position is in
  25659. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25660. * @returns The position of the bone
  25661. */
  25662. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  25663. /**
  25664. * Copy the position of the bone to a vector3 in local or world space
  25665. * @param space The space that the returned position is in
  25666. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25667. * @param result The vector3 to copy the position to
  25668. */
  25669. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  25670. /**
  25671. * Get the absolute position of the bone (world space)
  25672. * @param mesh The mesh that this bone is attached to
  25673. * @returns The absolute position of the bone
  25674. */
  25675. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  25676. /**
  25677. * Copy the absolute position of the bone (world space) to the result param
  25678. * @param mesh The mesh that this bone is attached to
  25679. * @param result The vector3 to copy the absolute position to
  25680. */
  25681. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  25682. /**
  25683. * Compute the absolute transforms of this bone and its children
  25684. */
  25685. computeAbsoluteTransforms(): void;
  25686. /**
  25687. * Get the world direction from an axis that is in the local space of the bone
  25688. * @param localAxis The local direction that is used to compute the world direction
  25689. * @param mesh The mesh that this bone is attached to
  25690. * @returns The world direction
  25691. */
  25692. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  25693. /**
  25694. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  25695. * @param localAxis The local direction that is used to compute the world direction
  25696. * @param mesh The mesh that this bone is attached to
  25697. * @param result The vector3 that the world direction will be copied to
  25698. */
  25699. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  25700. /**
  25701. * Get the euler rotation of the bone in local or world space
  25702. * @param space The space that the rotation should be in
  25703. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25704. * @returns The euler rotation
  25705. */
  25706. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  25707. /**
  25708. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  25709. * @param space The space that the rotation should be in
  25710. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25711. * @param result The vector3 that the rotation should be copied to
  25712. */
  25713. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  25714. /**
  25715. * Get the quaternion rotation of the bone in either local or world space
  25716. * @param space The space that the rotation should be in
  25717. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25718. * @returns The quaternion rotation
  25719. */
  25720. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  25721. /**
  25722. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  25723. * @param space The space that the rotation should be in
  25724. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25725. * @param result The quaternion that the rotation should be copied to
  25726. */
  25727. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  25728. /**
  25729. * Get the rotation matrix of the bone in local or world space
  25730. * @param space The space that the rotation should be in
  25731. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25732. * @returns The rotation matrix
  25733. */
  25734. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  25735. /**
  25736. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  25737. * @param space The space that the rotation should be in
  25738. * @param mesh The mesh that this bone is attached to. This is only used in world space
  25739. * @param result The quaternion that the rotation should be copied to
  25740. */
  25741. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  25742. /**
  25743. * Get the world position of a point that is in the local space of the bone
  25744. * @param position The local position
  25745. * @param mesh The mesh that this bone is attached to
  25746. * @returns The world position
  25747. */
  25748. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  25749. /**
  25750. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  25751. * @param position The local position
  25752. * @param mesh The mesh that this bone is attached to
  25753. * @param result The vector3 that the world position should be copied to
  25754. */
  25755. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  25756. /**
  25757. * Get the local position of a point that is in world space
  25758. * @param position The world position
  25759. * @param mesh The mesh that this bone is attached to
  25760. * @returns The local position
  25761. */
  25762. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  25763. /**
  25764. * Get the local position of a point that is in world space and copy it to the result param
  25765. * @param position The world position
  25766. * @param mesh The mesh that this bone is attached to
  25767. * @param result The vector3 that the local position should be copied to
  25768. */
  25769. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  25770. /**
  25771. * Set the current local matrix as the restPose for this bone.
  25772. */
  25773. setCurrentPoseAsRest(): void;
  25774. }
  25775. }
  25776. declare module BABYLON {
  25777. /**
  25778. * 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.
  25779. * @see https://doc.babylonjs.com/how_to/transformnode
  25780. */
  25781. export class TransformNode extends Node {
  25782. /**
  25783. * Object will not rotate to face the camera
  25784. */
  25785. static BILLBOARDMODE_NONE: number;
  25786. /**
  25787. * Object will rotate to face the camera but only on the x axis
  25788. */
  25789. static BILLBOARDMODE_X: number;
  25790. /**
  25791. * Object will rotate to face the camera but only on the y axis
  25792. */
  25793. static BILLBOARDMODE_Y: number;
  25794. /**
  25795. * Object will rotate to face the camera but only on the z axis
  25796. */
  25797. static BILLBOARDMODE_Z: number;
  25798. /**
  25799. * Object will rotate to face the camera
  25800. */
  25801. static BILLBOARDMODE_ALL: number;
  25802. /**
  25803. * Object will rotate to face the camera's position instead of orientation
  25804. */
  25805. static BILLBOARDMODE_USE_POSITION: number;
  25806. private static _TmpRotation;
  25807. private static _TmpScaling;
  25808. private static _TmpTranslation;
  25809. private _forward;
  25810. private _forwardInverted;
  25811. private _up;
  25812. private _right;
  25813. private _rightInverted;
  25814. private _position;
  25815. private _rotation;
  25816. private _rotationQuaternion;
  25817. protected _scaling: Vector3;
  25818. protected _isDirty: boolean;
  25819. private _transformToBoneReferal;
  25820. private _isAbsoluteSynced;
  25821. private _billboardMode;
  25822. /**
  25823. * Gets or sets the billboard mode. Default is 0.
  25824. *
  25825. * | Value | Type | Description |
  25826. * | --- | --- | --- |
  25827. * | 0 | BILLBOARDMODE_NONE | |
  25828. * | 1 | BILLBOARDMODE_X | |
  25829. * | 2 | BILLBOARDMODE_Y | |
  25830. * | 4 | BILLBOARDMODE_Z | |
  25831. * | 7 | BILLBOARDMODE_ALL | |
  25832. *
  25833. */
  25834. get billboardMode(): number;
  25835. set billboardMode(value: number);
  25836. private _preserveParentRotationForBillboard;
  25837. /**
  25838. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  25839. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  25840. */
  25841. get preserveParentRotationForBillboard(): boolean;
  25842. set preserveParentRotationForBillboard(value: boolean);
  25843. /**
  25844. * 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
  25845. */
  25846. scalingDeterminant: number;
  25847. private _infiniteDistance;
  25848. /**
  25849. * Gets or sets the distance of the object to max, often used by skybox
  25850. */
  25851. get infiniteDistance(): boolean;
  25852. set infiniteDistance(value: boolean);
  25853. /**
  25854. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  25855. * By default the system will update normals to compensate
  25856. */
  25857. ignoreNonUniformScaling: boolean;
  25858. /**
  25859. * 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
  25860. */
  25861. reIntegrateRotationIntoRotationQuaternion: boolean;
  25862. /** @hidden */
  25863. _poseMatrix: Nullable<Matrix>;
  25864. /** @hidden */
  25865. _localMatrix: Matrix;
  25866. private _usePivotMatrix;
  25867. private _absolutePosition;
  25868. private _absoluteScaling;
  25869. private _absoluteRotationQuaternion;
  25870. private _pivotMatrix;
  25871. private _pivotMatrixInverse;
  25872. /** @hidden */
  25873. _postMultiplyPivotMatrix: boolean;
  25874. protected _isWorldMatrixFrozen: boolean;
  25875. /** @hidden */
  25876. _indexInSceneTransformNodesArray: number;
  25877. /**
  25878. * An event triggered after the world matrix is updated
  25879. */
  25880. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  25881. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  25882. /**
  25883. * Gets a string identifying the name of the class
  25884. * @returns "TransformNode" string
  25885. */
  25886. getClassName(): string;
  25887. /**
  25888. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  25889. */
  25890. get position(): Vector3;
  25891. set position(newPosition: Vector3);
  25892. /**
  25893. * 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)).
  25894. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  25895. */
  25896. get rotation(): Vector3;
  25897. set rotation(newRotation: Vector3);
  25898. /**
  25899. * 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)).
  25900. */
  25901. get scaling(): Vector3;
  25902. set scaling(newScaling: Vector3);
  25903. /**
  25904. * 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).
  25905. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  25906. */
  25907. get rotationQuaternion(): Nullable<Quaternion>;
  25908. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  25909. /**
  25910. * The forward direction of that transform in world space.
  25911. */
  25912. get forward(): Vector3;
  25913. /**
  25914. * The up direction of that transform in world space.
  25915. */
  25916. get up(): Vector3;
  25917. /**
  25918. * The right direction of that transform in world space.
  25919. */
  25920. get right(): Vector3;
  25921. /**
  25922. * Copies the parameter passed Matrix into the mesh Pose matrix.
  25923. * @param matrix the matrix to copy the pose from
  25924. * @returns this TransformNode.
  25925. */
  25926. updatePoseMatrix(matrix: Matrix): TransformNode;
  25927. /**
  25928. * Returns the mesh Pose matrix.
  25929. * @returns the pose matrix
  25930. */
  25931. getPoseMatrix(): Matrix;
  25932. /** @hidden */
  25933. _isSynchronized(): boolean;
  25934. /** @hidden */
  25935. _initCache(): void;
  25936. /**
  25937. * Flag the transform node as dirty (Forcing it to update everything)
  25938. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  25939. * @returns this transform node
  25940. */
  25941. markAsDirty(property: string): TransformNode;
  25942. /**
  25943. * Returns the current mesh absolute position.
  25944. * Returns a Vector3.
  25945. */
  25946. get absolutePosition(): Vector3;
  25947. /**
  25948. * Returns the current mesh absolute scaling.
  25949. * Returns a Vector3.
  25950. */
  25951. get absoluteScaling(): Vector3;
  25952. /**
  25953. * Returns the current mesh absolute rotation.
  25954. * Returns a Quaternion.
  25955. */
  25956. get absoluteRotationQuaternion(): Quaternion;
  25957. /**
  25958. * Sets a new matrix to apply before all other transformation
  25959. * @param matrix defines the transform matrix
  25960. * @returns the current TransformNode
  25961. */
  25962. setPreTransformMatrix(matrix: Matrix): TransformNode;
  25963. /**
  25964. * Sets a new pivot matrix to the current node
  25965. * @param matrix defines the new pivot matrix to use
  25966. * @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
  25967. * @returns the current TransformNode
  25968. */
  25969. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  25970. /**
  25971. * Returns the mesh pivot matrix.
  25972. * Default : Identity.
  25973. * @returns the matrix
  25974. */
  25975. getPivotMatrix(): Matrix;
  25976. /**
  25977. * Instantiate (when possible) or clone that node with its hierarchy
  25978. * @param newParent defines the new parent to use for the instance (or clone)
  25979. * @param options defines options to configure how copy is done
  25980. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  25981. * @returns an instance (or a clone) of the current node with its hiearchy
  25982. */
  25983. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  25984. doNotInstantiate: boolean;
  25985. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  25986. /**
  25987. * Prevents the World matrix to be computed any longer
  25988. * @param newWorldMatrix defines an optional matrix to use as world matrix
  25989. * @returns the TransformNode.
  25990. */
  25991. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  25992. /**
  25993. * Allows back the World matrix computation.
  25994. * @returns the TransformNode.
  25995. */
  25996. unfreezeWorldMatrix(): this;
  25997. /**
  25998. * True if the World matrix has been frozen.
  25999. */
  26000. get isWorldMatrixFrozen(): boolean;
  26001. /**
  26002. * Retuns the mesh absolute position in the World.
  26003. * @returns a Vector3.
  26004. */
  26005. getAbsolutePosition(): Vector3;
  26006. /**
  26007. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  26008. * @param absolutePosition the absolute position to set
  26009. * @returns the TransformNode.
  26010. */
  26011. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  26012. /**
  26013. * Sets the mesh position in its local space.
  26014. * @param vector3 the position to set in localspace
  26015. * @returns the TransformNode.
  26016. */
  26017. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  26018. /**
  26019. * Returns the mesh position in the local space from the current World matrix values.
  26020. * @returns a new Vector3.
  26021. */
  26022. getPositionExpressedInLocalSpace(): Vector3;
  26023. /**
  26024. * Translates the mesh along the passed Vector3 in its local space.
  26025. * @param vector3 the distance to translate in localspace
  26026. * @returns the TransformNode.
  26027. */
  26028. locallyTranslate(vector3: Vector3): TransformNode;
  26029. private static _lookAtVectorCache;
  26030. /**
  26031. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  26032. * @param targetPoint the position (must be in same space as current mesh) to look at
  26033. * @param yawCor optional yaw (y-axis) correction in radians
  26034. * @param pitchCor optional pitch (x-axis) correction in radians
  26035. * @param rollCor optional roll (z-axis) correction in radians
  26036. * @param space the choosen space of the target
  26037. * @returns the TransformNode.
  26038. */
  26039. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  26040. /**
  26041. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  26042. * This Vector3 is expressed in the World space.
  26043. * @param localAxis axis to rotate
  26044. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  26045. */
  26046. getDirection(localAxis: Vector3): Vector3;
  26047. /**
  26048. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  26049. * localAxis is expressed in the mesh local space.
  26050. * result is computed in the Wordl space from the mesh World matrix.
  26051. * @param localAxis axis to rotate
  26052. * @param result the resulting transformnode
  26053. * @returns this TransformNode.
  26054. */
  26055. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  26056. /**
  26057. * Sets this transform node rotation to the given local axis.
  26058. * @param localAxis the axis in local space
  26059. * @param yawCor optional yaw (y-axis) correction in radians
  26060. * @param pitchCor optional pitch (x-axis) correction in radians
  26061. * @param rollCor optional roll (z-axis) correction in radians
  26062. * @returns this TransformNode
  26063. */
  26064. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  26065. /**
  26066. * Sets a new pivot point to the current node
  26067. * @param point defines the new pivot point to use
  26068. * @param space defines if the point is in world or local space (local by default)
  26069. * @returns the current TransformNode
  26070. */
  26071. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  26072. /**
  26073. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  26074. * @returns the pivot point
  26075. */
  26076. getPivotPoint(): Vector3;
  26077. /**
  26078. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  26079. * @param result the vector3 to store the result
  26080. * @returns this TransformNode.
  26081. */
  26082. getPivotPointToRef(result: Vector3): TransformNode;
  26083. /**
  26084. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  26085. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  26086. */
  26087. getAbsolutePivotPoint(): Vector3;
  26088. /**
  26089. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  26090. * @param result vector3 to store the result
  26091. * @returns this TransformNode.
  26092. */
  26093. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  26094. /**
  26095. * Defines the passed node as the parent of the current node.
  26096. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  26097. * @see https://doc.babylonjs.com/how_to/parenting
  26098. * @param node the node ot set as the parent
  26099. * @returns this TransformNode.
  26100. */
  26101. setParent(node: Nullable<Node>): TransformNode;
  26102. private _nonUniformScaling;
  26103. /**
  26104. * True if the scaling property of this object is non uniform eg. (1,2,1)
  26105. */
  26106. get nonUniformScaling(): boolean;
  26107. /** @hidden */
  26108. _updateNonUniformScalingState(value: boolean): boolean;
  26109. /**
  26110. * Attach the current TransformNode to another TransformNode associated with a bone
  26111. * @param bone Bone affecting the TransformNode
  26112. * @param affectedTransformNode TransformNode associated with the bone
  26113. * @returns this object
  26114. */
  26115. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  26116. /**
  26117. * Detach the transform node if its associated with a bone
  26118. * @returns this object
  26119. */
  26120. detachFromBone(): TransformNode;
  26121. private static _rotationAxisCache;
  26122. /**
  26123. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  26124. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  26125. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  26126. * The passed axis is also normalized.
  26127. * @param axis the axis to rotate around
  26128. * @param amount the amount to rotate in radians
  26129. * @param space Space to rotate in (Default: local)
  26130. * @returns the TransformNode.
  26131. */
  26132. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  26133. /**
  26134. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  26135. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  26136. * The passed axis is also normalized. .
  26137. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  26138. * @param point the point to rotate around
  26139. * @param axis the axis to rotate around
  26140. * @param amount the amount to rotate in radians
  26141. * @returns the TransformNode
  26142. */
  26143. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  26144. /**
  26145. * Translates the mesh along the axis vector for the passed distance in the given space.
  26146. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  26147. * @param axis the axis to translate in
  26148. * @param distance the distance to translate
  26149. * @param space Space to rotate in (Default: local)
  26150. * @returns the TransformNode.
  26151. */
  26152. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  26153. /**
  26154. * Adds a rotation step to the mesh current rotation.
  26155. * x, y, z are Euler angles expressed in radians.
  26156. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  26157. * This means this rotation is made in the mesh local space only.
  26158. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  26159. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  26160. * ```javascript
  26161. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  26162. * ```
  26163. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  26164. * 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.
  26165. * @param x Rotation to add
  26166. * @param y Rotation to add
  26167. * @param z Rotation to add
  26168. * @returns the TransformNode.
  26169. */
  26170. addRotation(x: number, y: number, z: number): TransformNode;
  26171. /**
  26172. * @hidden
  26173. */
  26174. protected _getEffectiveParent(): Nullable<Node>;
  26175. /**
  26176. * Computes the world matrix of the node
  26177. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  26178. * @returns the world matrix
  26179. */
  26180. computeWorldMatrix(force?: boolean): Matrix;
  26181. /**
  26182. * Resets this nodeTransform's local matrix to Matrix.Identity().
  26183. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  26184. */
  26185. resetLocalMatrix(independentOfChildren?: boolean): void;
  26186. protected _afterComputeWorldMatrix(): void;
  26187. /**
  26188. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  26189. * @param func callback function to add
  26190. *
  26191. * @returns the TransformNode.
  26192. */
  26193. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  26194. /**
  26195. * Removes a registered callback function.
  26196. * @param func callback function to remove
  26197. * @returns the TransformNode.
  26198. */
  26199. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  26200. /**
  26201. * Gets the position of the current mesh in camera space
  26202. * @param camera defines the camera to use
  26203. * @returns a position
  26204. */
  26205. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  26206. /**
  26207. * Returns the distance from the mesh to the active camera
  26208. * @param camera defines the camera to use
  26209. * @returns the distance
  26210. */
  26211. getDistanceToCamera(camera?: Nullable<Camera>): number;
  26212. /**
  26213. * Clone the current transform node
  26214. * @param name Name of the new clone
  26215. * @param newParent New parent for the clone
  26216. * @param doNotCloneChildren Do not clone children hierarchy
  26217. * @returns the new transform node
  26218. */
  26219. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  26220. /**
  26221. * Serializes the objects information.
  26222. * @param currentSerializationObject defines the object to serialize in
  26223. * @returns the serialized object
  26224. */
  26225. serialize(currentSerializationObject?: any): any;
  26226. /**
  26227. * Returns a new TransformNode object parsed from the source provided.
  26228. * @param parsedTransformNode is the source.
  26229. * @param scene the scne the object belongs to
  26230. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  26231. * @returns a new TransformNode object parsed from the source provided.
  26232. */
  26233. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  26234. /**
  26235. * Get all child-transformNodes of this node
  26236. * @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
  26237. * @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
  26238. * @returns an array of TransformNode
  26239. */
  26240. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  26241. /**
  26242. * Releases resources associated with this transform node.
  26243. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  26244. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  26245. */
  26246. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  26247. /**
  26248. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  26249. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  26250. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  26251. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  26252. * @returns the current mesh
  26253. */
  26254. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  26255. private _syncAbsoluteScalingAndRotation;
  26256. }
  26257. }
  26258. declare module BABYLON {
  26259. /**
  26260. * Defines the types of pose enabled controllers that are supported
  26261. */
  26262. export enum PoseEnabledControllerType {
  26263. /**
  26264. * HTC Vive
  26265. */
  26266. VIVE = 0,
  26267. /**
  26268. * Oculus Rift
  26269. */
  26270. OCULUS = 1,
  26271. /**
  26272. * Windows mixed reality
  26273. */
  26274. WINDOWS = 2,
  26275. /**
  26276. * Samsung gear VR
  26277. */
  26278. GEAR_VR = 3,
  26279. /**
  26280. * Google Daydream
  26281. */
  26282. DAYDREAM = 4,
  26283. /**
  26284. * Generic
  26285. */
  26286. GENERIC = 5
  26287. }
  26288. /**
  26289. * Defines the MutableGamepadButton interface for the state of a gamepad button
  26290. */
  26291. export interface MutableGamepadButton {
  26292. /**
  26293. * Value of the button/trigger
  26294. */
  26295. value: number;
  26296. /**
  26297. * If the button/trigger is currently touched
  26298. */
  26299. touched: boolean;
  26300. /**
  26301. * If the button/trigger is currently pressed
  26302. */
  26303. pressed: boolean;
  26304. }
  26305. /**
  26306. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  26307. * @hidden
  26308. */
  26309. export interface ExtendedGamepadButton extends GamepadButton {
  26310. /**
  26311. * If the button/trigger is currently pressed
  26312. */
  26313. readonly pressed: boolean;
  26314. /**
  26315. * If the button/trigger is currently touched
  26316. */
  26317. readonly touched: boolean;
  26318. /**
  26319. * Value of the button/trigger
  26320. */
  26321. readonly value: number;
  26322. }
  26323. /** @hidden */
  26324. export interface _GamePadFactory {
  26325. /**
  26326. * Returns whether or not the current gamepad can be created for this type of controller.
  26327. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  26328. * @returns true if it can be created, otherwise false
  26329. */
  26330. canCreate(gamepadInfo: any): boolean;
  26331. /**
  26332. * Creates a new instance of the Gamepad.
  26333. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  26334. * @returns the new gamepad instance
  26335. */
  26336. create(gamepadInfo: any): Gamepad;
  26337. }
  26338. /**
  26339. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  26340. */
  26341. export class PoseEnabledControllerHelper {
  26342. /** @hidden */
  26343. static _ControllerFactories: _GamePadFactory[];
  26344. /** @hidden */
  26345. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  26346. /**
  26347. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  26348. * @param vrGamepad the gamepad to initialized
  26349. * @returns a vr controller of the type the gamepad identified as
  26350. */
  26351. static InitiateController(vrGamepad: any): Gamepad;
  26352. }
  26353. /**
  26354. * Defines the PoseEnabledController object that contains state of a vr capable controller
  26355. */
  26356. export class PoseEnabledController extends Gamepad implements PoseControlled {
  26357. /**
  26358. * If the controller is used in a webXR session
  26359. */
  26360. isXR: boolean;
  26361. private _deviceRoomPosition;
  26362. private _deviceRoomRotationQuaternion;
  26363. /**
  26364. * The device position in babylon space
  26365. */
  26366. devicePosition: Vector3;
  26367. /**
  26368. * The device rotation in babylon space
  26369. */
  26370. deviceRotationQuaternion: Quaternion;
  26371. /**
  26372. * The scale factor of the device in babylon space
  26373. */
  26374. deviceScaleFactor: number;
  26375. /**
  26376. * (Likely devicePosition should be used instead) The device position in its room space
  26377. */
  26378. position: Vector3;
  26379. /**
  26380. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  26381. */
  26382. rotationQuaternion: Quaternion;
  26383. /**
  26384. * The type of controller (Eg. Windows mixed reality)
  26385. */
  26386. controllerType: PoseEnabledControllerType;
  26387. protected _calculatedPosition: Vector3;
  26388. private _calculatedRotation;
  26389. /**
  26390. * The raw pose from the device
  26391. */
  26392. rawPose: DevicePose;
  26393. private _trackPosition;
  26394. private _maxRotationDistFromHeadset;
  26395. private _draggedRoomRotation;
  26396. /**
  26397. * @hidden
  26398. */
  26399. _disableTrackPosition(fixedPosition: Vector3): void;
  26400. /**
  26401. * Internal, the mesh attached to the controller
  26402. * @hidden
  26403. */
  26404. _mesh: Nullable<AbstractMesh>;
  26405. private _poseControlledCamera;
  26406. private _leftHandSystemQuaternion;
  26407. /**
  26408. * Internal, matrix used to convert room space to babylon space
  26409. * @hidden
  26410. */
  26411. _deviceToWorld: Matrix;
  26412. /**
  26413. * Node to be used when casting a ray from the controller
  26414. * @hidden
  26415. */
  26416. _pointingPoseNode: Nullable<TransformNode>;
  26417. /**
  26418. * Name of the child mesh that can be used to cast a ray from the controller
  26419. */
  26420. static readonly POINTING_POSE: string;
  26421. /**
  26422. * Creates a new PoseEnabledController from a gamepad
  26423. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  26424. */
  26425. constructor(browserGamepad: any);
  26426. private _workingMatrix;
  26427. /**
  26428. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  26429. */
  26430. update(): void;
  26431. /**
  26432. * Updates only the pose device and mesh without doing any button event checking
  26433. */
  26434. protected _updatePoseAndMesh(): void;
  26435. /**
  26436. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  26437. * @param poseData raw pose fromthe device
  26438. */
  26439. updateFromDevice(poseData: DevicePose): void;
  26440. /**
  26441. * @hidden
  26442. */
  26443. _meshAttachedObservable: Observable<AbstractMesh>;
  26444. /**
  26445. * Attaches a mesh to the controller
  26446. * @param mesh the mesh to be attached
  26447. */
  26448. attachToMesh(mesh: AbstractMesh): void;
  26449. /**
  26450. * Attaches the controllers mesh to a camera
  26451. * @param camera the camera the mesh should be attached to
  26452. */
  26453. attachToPoseControlledCamera(camera: TargetCamera): void;
  26454. /**
  26455. * Disposes of the controller
  26456. */
  26457. dispose(): void;
  26458. /**
  26459. * The mesh that is attached to the controller
  26460. */
  26461. get mesh(): Nullable<AbstractMesh>;
  26462. /**
  26463. * Gets the ray of the controller in the direction the controller is pointing
  26464. * @param length the length the resulting ray should be
  26465. * @returns a ray in the direction the controller is pointing
  26466. */
  26467. getForwardRay(length?: number): Ray;
  26468. }
  26469. }
  26470. declare module BABYLON {
  26471. /**
  26472. * Defines the WebVRController object that represents controllers tracked in 3D space
  26473. */
  26474. export abstract class WebVRController extends PoseEnabledController {
  26475. /**
  26476. * Internal, the default controller model for the controller
  26477. */
  26478. protected _defaultModel: Nullable<AbstractMesh>;
  26479. /**
  26480. * Fired when the trigger state has changed
  26481. */
  26482. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  26483. /**
  26484. * Fired when the main button state has changed
  26485. */
  26486. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  26487. /**
  26488. * Fired when the secondary button state has changed
  26489. */
  26490. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  26491. /**
  26492. * Fired when the pad state has changed
  26493. */
  26494. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  26495. /**
  26496. * Fired when controllers stick values have changed
  26497. */
  26498. onPadValuesChangedObservable: Observable<StickValues>;
  26499. /**
  26500. * Array of button availible on the controller
  26501. */
  26502. protected _buttons: Array<MutableGamepadButton>;
  26503. private _onButtonStateChange;
  26504. /**
  26505. * Fired when a controller button's state has changed
  26506. * @param callback the callback containing the button that was modified
  26507. */
  26508. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  26509. /**
  26510. * X and Y axis corresponding to the controllers joystick
  26511. */
  26512. pad: StickValues;
  26513. /**
  26514. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  26515. */
  26516. hand: string;
  26517. /**
  26518. * The default controller model for the controller
  26519. */
  26520. get defaultModel(): Nullable<AbstractMesh>;
  26521. /**
  26522. * Creates a new WebVRController from a gamepad
  26523. * @param vrGamepad the gamepad that the WebVRController should be created from
  26524. */
  26525. constructor(vrGamepad: any);
  26526. /**
  26527. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  26528. */
  26529. update(): void;
  26530. /**
  26531. * Function to be called when a button is modified
  26532. */
  26533. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  26534. /**
  26535. * Loads a mesh and attaches it to the controller
  26536. * @param scene the scene the mesh should be added to
  26537. * @param meshLoaded callback for when the mesh has been loaded
  26538. */
  26539. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  26540. private _setButtonValue;
  26541. private _changes;
  26542. private _checkChanges;
  26543. /**
  26544. * Disposes of th webVRCOntroller
  26545. */
  26546. dispose(): void;
  26547. }
  26548. }
  26549. declare module BABYLON {
  26550. /**
  26551. * The HemisphericLight simulates the ambient environment light,
  26552. * so the passed direction is the light reflection direction, not the incoming direction.
  26553. */
  26554. export class HemisphericLight extends Light {
  26555. /**
  26556. * The groundColor is the light in the opposite direction to the one specified during creation.
  26557. * 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.
  26558. */
  26559. groundColor: Color3;
  26560. /**
  26561. * The light reflection direction, not the incoming direction.
  26562. */
  26563. direction: Vector3;
  26564. /**
  26565. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  26566. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  26567. * The HemisphericLight can't cast shadows.
  26568. * Documentation : https://doc.babylonjs.com/babylon101/lights
  26569. * @param name The friendly name of the light
  26570. * @param direction The direction of the light reflection
  26571. * @param scene The scene the light belongs to
  26572. */
  26573. constructor(name: string, direction: Vector3, scene: Scene);
  26574. protected _buildUniformLayout(): void;
  26575. /**
  26576. * Returns the string "HemisphericLight".
  26577. * @return The class name
  26578. */
  26579. getClassName(): string;
  26580. /**
  26581. * Sets the HemisphericLight direction towards the passed target (Vector3).
  26582. * Returns the updated direction.
  26583. * @param target The target the direction should point to
  26584. * @return The computed direction
  26585. */
  26586. setDirectionToTarget(target: Vector3): Vector3;
  26587. /**
  26588. * Returns the shadow generator associated to the light.
  26589. * @returns Always null for hemispheric lights because it does not support shadows.
  26590. */
  26591. getShadowGenerator(): Nullable<IShadowGenerator>;
  26592. /**
  26593. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  26594. * @param effect The effect to update
  26595. * @param lightIndex The index of the light in the effect to update
  26596. * @returns The hemispheric light
  26597. */
  26598. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  26599. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  26600. /**
  26601. * Computes the world matrix of the node
  26602. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  26603. * @param useWasUpdatedFlag defines a reserved property
  26604. * @returns the world matrix
  26605. */
  26606. computeWorldMatrix(): Matrix;
  26607. /**
  26608. * Returns the integer 3.
  26609. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  26610. */
  26611. getTypeID(): number;
  26612. /**
  26613. * Prepares the list of defines specific to the light type.
  26614. * @param defines the list of defines
  26615. * @param lightIndex defines the index of the light for the effect
  26616. */
  26617. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  26618. }
  26619. }
  26620. declare module BABYLON {
  26621. /** @hidden */
  26622. export var vrMultiviewToSingleviewPixelShader: {
  26623. name: string;
  26624. shader: string;
  26625. };
  26626. }
  26627. declare module BABYLON {
  26628. /**
  26629. * Renders to multiple views with a single draw call
  26630. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  26631. */
  26632. export class MultiviewRenderTarget extends RenderTargetTexture {
  26633. /**
  26634. * Creates a multiview render target
  26635. * @param scene scene used with the render target
  26636. * @param size the size of the render target (used for each view)
  26637. */
  26638. constructor(scene: Scene, size?: number | {
  26639. width: number;
  26640. height: number;
  26641. } | {
  26642. ratio: number;
  26643. });
  26644. /**
  26645. * @hidden
  26646. * @param faceIndex the face index, if its a cube texture
  26647. */
  26648. _bindFrameBuffer(faceIndex?: number): void;
  26649. /**
  26650. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  26651. * @returns the view count
  26652. */
  26653. getViewCount(): number;
  26654. }
  26655. }
  26656. declare module BABYLON {
  26657. interface Engine {
  26658. /**
  26659. * Creates a new multiview render target
  26660. * @param width defines the width of the texture
  26661. * @param height defines the height of the texture
  26662. * @returns the created multiview texture
  26663. */
  26664. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  26665. /**
  26666. * Binds a multiview framebuffer to be drawn to
  26667. * @param multiviewTexture texture to bind
  26668. */
  26669. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  26670. }
  26671. interface Camera {
  26672. /**
  26673. * @hidden
  26674. * 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)
  26675. */
  26676. _useMultiviewToSingleView: boolean;
  26677. /**
  26678. * @hidden
  26679. * 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)
  26680. */
  26681. _multiviewTexture: Nullable<RenderTargetTexture>;
  26682. /**
  26683. * @hidden
  26684. * ensures the multiview texture of the camera exists and has the specified width/height
  26685. * @param width height to set on the multiview texture
  26686. * @param height width to set on the multiview texture
  26687. */
  26688. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  26689. }
  26690. interface Scene {
  26691. /** @hidden */
  26692. _transformMatrixR: Matrix;
  26693. /** @hidden */
  26694. _multiviewSceneUbo: Nullable<UniformBuffer>;
  26695. /** @hidden */
  26696. _createMultiviewUbo(): void;
  26697. /** @hidden */
  26698. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  26699. /** @hidden */
  26700. _renderMultiviewToSingleView(camera: Camera): void;
  26701. }
  26702. }
  26703. declare module BABYLON {
  26704. /**
  26705. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  26706. * This will not be used for webXR as it supports displaying texture arrays directly
  26707. */
  26708. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  26709. /**
  26710. * Gets a string identifying the name of the class
  26711. * @returns "VRMultiviewToSingleviewPostProcess" string
  26712. */
  26713. getClassName(): string;
  26714. /**
  26715. * Initializes a VRMultiviewToSingleview
  26716. * @param name name of the post process
  26717. * @param camera camera to be applied to
  26718. * @param scaleFactor scaling factor to the size of the output texture
  26719. */
  26720. constructor(name: string, camera: Camera, scaleFactor: number);
  26721. }
  26722. }
  26723. declare module BABYLON {
  26724. /**
  26725. * Interface used to define additional presentation attributes
  26726. */
  26727. export interface IVRPresentationAttributes {
  26728. /**
  26729. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  26730. */
  26731. highRefreshRate: boolean;
  26732. /**
  26733. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  26734. */
  26735. foveationLevel: number;
  26736. }
  26737. interface Engine {
  26738. /** @hidden */
  26739. _vrDisplay: any;
  26740. /** @hidden */
  26741. _vrSupported: boolean;
  26742. /** @hidden */
  26743. _oldSize: Size;
  26744. /** @hidden */
  26745. _oldHardwareScaleFactor: number;
  26746. /** @hidden */
  26747. _vrExclusivePointerMode: boolean;
  26748. /** @hidden */
  26749. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  26750. /** @hidden */
  26751. _onVRDisplayPointerRestricted: () => void;
  26752. /** @hidden */
  26753. _onVRDisplayPointerUnrestricted: () => void;
  26754. /** @hidden */
  26755. _onVrDisplayConnect: Nullable<(display: any) => void>;
  26756. /** @hidden */
  26757. _onVrDisplayDisconnect: Nullable<() => void>;
  26758. /** @hidden */
  26759. _onVrDisplayPresentChange: Nullable<() => void>;
  26760. /**
  26761. * Observable signaled when VR display mode changes
  26762. */
  26763. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  26764. /**
  26765. * Observable signaled when VR request present is complete
  26766. */
  26767. onVRRequestPresentComplete: Observable<boolean>;
  26768. /**
  26769. * Observable signaled when VR request present starts
  26770. */
  26771. onVRRequestPresentStart: Observable<Engine>;
  26772. /**
  26773. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  26774. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  26775. */
  26776. isInVRExclusivePointerMode: boolean;
  26777. /**
  26778. * Gets a boolean indicating if a webVR device was detected
  26779. * @returns true if a webVR device was detected
  26780. */
  26781. isVRDevicePresent(): boolean;
  26782. /**
  26783. * Gets the current webVR device
  26784. * @returns the current webVR device (or null)
  26785. */
  26786. getVRDevice(): any;
  26787. /**
  26788. * Initializes a webVR display and starts listening to display change events
  26789. * The onVRDisplayChangedObservable will be notified upon these changes
  26790. * @returns A promise containing a VRDisplay and if vr is supported
  26791. */
  26792. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  26793. /** @hidden */
  26794. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  26795. /**
  26796. * Gets or sets the presentation attributes used to configure VR rendering
  26797. */
  26798. vrPresentationAttributes?: IVRPresentationAttributes;
  26799. /**
  26800. * Call this function to switch to webVR mode
  26801. * Will do nothing if webVR is not supported or if there is no webVR device
  26802. * @param options the webvr options provided to the camera. mainly used for multiview
  26803. * @see https://doc.babylonjs.com/how_to/webvr_camera
  26804. */
  26805. enableVR(options: WebVROptions): void;
  26806. /** @hidden */
  26807. _onVRFullScreenTriggered(): void;
  26808. }
  26809. }
  26810. declare module BABYLON {
  26811. /**
  26812. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  26813. * IMPORTANT!! The data is right-hand data.
  26814. * @export
  26815. * @interface DevicePose
  26816. */
  26817. export interface DevicePose {
  26818. /**
  26819. * The position of the device, values in array are [x,y,z].
  26820. */
  26821. readonly position: Nullable<Float32Array>;
  26822. /**
  26823. * The linearVelocity of the device, values in array are [x,y,z].
  26824. */
  26825. readonly linearVelocity: Nullable<Float32Array>;
  26826. /**
  26827. * The linearAcceleration of the device, values in array are [x,y,z].
  26828. */
  26829. readonly linearAcceleration: Nullable<Float32Array>;
  26830. /**
  26831. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  26832. */
  26833. readonly orientation: Nullable<Float32Array>;
  26834. /**
  26835. * The angularVelocity of the device, values in array are [x,y,z].
  26836. */
  26837. readonly angularVelocity: Nullable<Float32Array>;
  26838. /**
  26839. * The angularAcceleration of the device, values in array are [x,y,z].
  26840. */
  26841. readonly angularAcceleration: Nullable<Float32Array>;
  26842. }
  26843. /**
  26844. * Interface representing a pose controlled object in Babylon.
  26845. * A pose controlled object has both regular pose values as well as pose values
  26846. * from an external device such as a VR head mounted display
  26847. */
  26848. export interface PoseControlled {
  26849. /**
  26850. * The position of the object in babylon space.
  26851. */
  26852. position: Vector3;
  26853. /**
  26854. * The rotation quaternion of the object in babylon space.
  26855. */
  26856. rotationQuaternion: Quaternion;
  26857. /**
  26858. * The position of the device in babylon space.
  26859. */
  26860. devicePosition?: Vector3;
  26861. /**
  26862. * The rotation quaternion of the device in babylon space.
  26863. */
  26864. deviceRotationQuaternion: Quaternion;
  26865. /**
  26866. * The raw pose coming from the device.
  26867. */
  26868. rawPose: Nullable<DevicePose>;
  26869. /**
  26870. * The scale of the device to be used when translating from device space to babylon space.
  26871. */
  26872. deviceScaleFactor: number;
  26873. /**
  26874. * Updates the poseControlled values based on the input device pose.
  26875. * @param poseData the pose data to update the object with
  26876. */
  26877. updateFromDevice(poseData: DevicePose): void;
  26878. }
  26879. /**
  26880. * Set of options to customize the webVRCamera
  26881. */
  26882. export interface WebVROptions {
  26883. /**
  26884. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  26885. */
  26886. trackPosition?: boolean;
  26887. /**
  26888. * Sets the scale of the vrDevice in babylon space. (default: 1)
  26889. */
  26890. positionScale?: number;
  26891. /**
  26892. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  26893. */
  26894. displayName?: string;
  26895. /**
  26896. * Should the native controller meshes be initialized. (default: true)
  26897. */
  26898. controllerMeshes?: boolean;
  26899. /**
  26900. * Creating a default HemiLight only on controllers. (default: true)
  26901. */
  26902. defaultLightingOnControllers?: boolean;
  26903. /**
  26904. * If you don't want to use the default VR button of the helper. (default: false)
  26905. */
  26906. useCustomVRButton?: boolean;
  26907. /**
  26908. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  26909. */
  26910. customVRButton?: HTMLButtonElement;
  26911. /**
  26912. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  26913. */
  26914. rayLength?: number;
  26915. /**
  26916. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  26917. */
  26918. defaultHeight?: number;
  26919. /**
  26920. * If multiview should be used if availible (default: false)
  26921. */
  26922. useMultiview?: boolean;
  26923. }
  26924. /**
  26925. * This represents a WebVR camera.
  26926. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  26927. * @example https://doc.babylonjs.com/how_to/webvr_camera
  26928. */
  26929. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  26930. private webVROptions;
  26931. /**
  26932. * @hidden
  26933. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  26934. */
  26935. _vrDevice: any;
  26936. /**
  26937. * The rawPose of the vrDevice.
  26938. */
  26939. rawPose: Nullable<DevicePose>;
  26940. private _onVREnabled;
  26941. private _specsVersion;
  26942. private _attached;
  26943. private _frameData;
  26944. protected _descendants: Array<Node>;
  26945. private _deviceRoomPosition;
  26946. /** @hidden */
  26947. _deviceRoomRotationQuaternion: Quaternion;
  26948. private _standingMatrix;
  26949. /**
  26950. * Represents device position in babylon space.
  26951. */
  26952. devicePosition: Vector3;
  26953. /**
  26954. * Represents device rotation in babylon space.
  26955. */
  26956. deviceRotationQuaternion: Quaternion;
  26957. /**
  26958. * The scale of the device to be used when translating from device space to babylon space.
  26959. */
  26960. deviceScaleFactor: number;
  26961. private _deviceToWorld;
  26962. private _worldToDevice;
  26963. /**
  26964. * References to the webVR controllers for the vrDevice.
  26965. */
  26966. controllers: Array<WebVRController>;
  26967. /**
  26968. * Emits an event when a controller is attached.
  26969. */
  26970. onControllersAttachedObservable: Observable<WebVRController[]>;
  26971. /**
  26972. * Emits an event when a controller's mesh has been loaded;
  26973. */
  26974. onControllerMeshLoadedObservable: Observable<WebVRController>;
  26975. /**
  26976. * Emits an event when the HMD's pose has been updated.
  26977. */
  26978. onPoseUpdatedFromDeviceObservable: Observable<any>;
  26979. private _poseSet;
  26980. /**
  26981. * If the rig cameras be used as parent instead of this camera.
  26982. */
  26983. rigParenting: boolean;
  26984. private _lightOnControllers;
  26985. private _defaultHeight?;
  26986. /**
  26987. * Instantiates a WebVRFreeCamera.
  26988. * @param name The name of the WebVRFreeCamera
  26989. * @param position The starting anchor position for the camera
  26990. * @param scene The scene the camera belongs to
  26991. * @param webVROptions a set of customizable options for the webVRCamera
  26992. */
  26993. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  26994. /**
  26995. * Gets the device distance from the ground in meters.
  26996. * @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.
  26997. */
  26998. deviceDistanceToRoomGround(): number;
  26999. /**
  27000. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  27001. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  27002. */
  27003. useStandingMatrix(callback?: (bool: boolean) => void): void;
  27004. /**
  27005. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  27006. * @returns A promise with a boolean set to if the standing matrix is supported.
  27007. */
  27008. useStandingMatrixAsync(): Promise<boolean>;
  27009. /**
  27010. * Disposes the camera
  27011. */
  27012. dispose(): void;
  27013. /**
  27014. * Gets a vrController by name.
  27015. * @param name The name of the controller to retreive
  27016. * @returns the controller matching the name specified or null if not found
  27017. */
  27018. getControllerByName(name: string): Nullable<WebVRController>;
  27019. private _leftController;
  27020. /**
  27021. * The controller corresponding to the users left hand.
  27022. */
  27023. get leftController(): Nullable<WebVRController>;
  27024. private _rightController;
  27025. /**
  27026. * The controller corresponding to the users right hand.
  27027. */
  27028. get rightController(): Nullable<WebVRController>;
  27029. /**
  27030. * Casts a ray forward from the vrCamera's gaze.
  27031. * @param length Length of the ray (default: 100)
  27032. * @returns the ray corresponding to the gaze
  27033. */
  27034. getForwardRay(length?: number): Ray;
  27035. /**
  27036. * @hidden
  27037. * Updates the camera based on device's frame data
  27038. */
  27039. _checkInputs(): void;
  27040. /**
  27041. * Updates the poseControlled values based on the input device pose.
  27042. * @param poseData Pose coming from the device
  27043. */
  27044. updateFromDevice(poseData: DevicePose): void;
  27045. private _detachIfAttached;
  27046. /**
  27047. * WebVR's attach control will start broadcasting frames to the device.
  27048. * Note that in certain browsers (chrome for example) this function must be called
  27049. * within a user-interaction callback. Example:
  27050. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  27051. *
  27052. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  27053. */
  27054. attachControl(noPreventDefault?: boolean): void;
  27055. /**
  27056. * Detach the current controls from the specified dom element.
  27057. */
  27058. detachControl(): void;
  27059. /**
  27060. * @returns the name of this class
  27061. */
  27062. getClassName(): string;
  27063. /**
  27064. * Calls resetPose on the vrDisplay
  27065. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  27066. */
  27067. resetToCurrentRotation(): void;
  27068. /**
  27069. * @hidden
  27070. * Updates the rig cameras (left and right eye)
  27071. */
  27072. _updateRigCameras(): void;
  27073. private _workingVector;
  27074. private _oneVector;
  27075. private _workingMatrix;
  27076. private updateCacheCalled;
  27077. private _correctPositionIfNotTrackPosition;
  27078. /**
  27079. * @hidden
  27080. * Updates the cached values of the camera
  27081. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  27082. */
  27083. _updateCache(ignoreParentClass?: boolean): void;
  27084. /**
  27085. * @hidden
  27086. * Get current device position in babylon world
  27087. */
  27088. _computeDevicePosition(): void;
  27089. /**
  27090. * Updates the current device position and rotation in the babylon world
  27091. */
  27092. update(): void;
  27093. /**
  27094. * @hidden
  27095. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  27096. * @returns an identity matrix
  27097. */
  27098. _getViewMatrix(): Matrix;
  27099. private _tmpMatrix;
  27100. /**
  27101. * This function is called by the two RIG cameras.
  27102. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  27103. * @hidden
  27104. */
  27105. _getWebVRViewMatrix(): Matrix;
  27106. /** @hidden */
  27107. _getWebVRProjectionMatrix(): Matrix;
  27108. private _onGamepadConnectedObserver;
  27109. private _onGamepadDisconnectedObserver;
  27110. private _updateCacheWhenTrackingDisabledObserver;
  27111. /**
  27112. * Initializes the controllers and their meshes
  27113. */
  27114. initControllers(): void;
  27115. }
  27116. }
  27117. declare module BABYLON {
  27118. /**
  27119. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  27120. *
  27121. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  27122. *
  27123. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  27124. */
  27125. export class MaterialHelper {
  27126. /**
  27127. * Bind the current view position to an effect.
  27128. * @param effect The effect to be bound
  27129. * @param scene The scene the eyes position is used from
  27130. * @param variableName name of the shader variable that will hold the eye position
  27131. */
  27132. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  27133. /**
  27134. * Helps preparing the defines values about the UVs in used in the effect.
  27135. * UVs are shared as much as we can accross channels in the shaders.
  27136. * @param texture The texture we are preparing the UVs for
  27137. * @param defines The defines to update
  27138. * @param key The channel key "diffuse", "specular"... used in the shader
  27139. */
  27140. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  27141. /**
  27142. * Binds a texture matrix value to its corrsponding uniform
  27143. * @param texture The texture to bind the matrix for
  27144. * @param uniformBuffer The uniform buffer receivin the data
  27145. * @param key The channel key "diffuse", "specular"... used in the shader
  27146. */
  27147. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  27148. /**
  27149. * Gets the current status of the fog (should it be enabled?)
  27150. * @param mesh defines the mesh to evaluate for fog support
  27151. * @param scene defines the hosting scene
  27152. * @returns true if fog must be enabled
  27153. */
  27154. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  27155. /**
  27156. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  27157. * @param mesh defines the current mesh
  27158. * @param scene defines the current scene
  27159. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  27160. * @param pointsCloud defines if point cloud rendering has to be turned on
  27161. * @param fogEnabled defines if fog has to be turned on
  27162. * @param alphaTest defines if alpha testing has to be turned on
  27163. * @param defines defines the current list of defines
  27164. */
  27165. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  27166. /**
  27167. * Helper used to prepare the list of defines associated with frame values for shader compilation
  27168. * @param scene defines the current scene
  27169. * @param engine defines the current engine
  27170. * @param defines specifies the list of active defines
  27171. * @param useInstances defines if instances have to be turned on
  27172. * @param useClipPlane defines if clip plane have to be turned on
  27173. * @param useInstances defines if instances have to be turned on
  27174. * @param useThinInstances defines if thin instances have to be turned on
  27175. */
  27176. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  27177. /**
  27178. * Prepares the defines for bones
  27179. * @param mesh The mesh containing the geometry data we will draw
  27180. * @param defines The defines to update
  27181. */
  27182. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  27183. /**
  27184. * Prepares the defines for morph targets
  27185. * @param mesh The mesh containing the geometry data we will draw
  27186. * @param defines The defines to update
  27187. */
  27188. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  27189. /**
  27190. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  27191. * @param mesh The mesh containing the geometry data we will draw
  27192. * @param defines The defines to update
  27193. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  27194. * @param useBones Precise whether bones should be used or not (override mesh info)
  27195. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  27196. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  27197. * @returns false if defines are considered not dirty and have not been checked
  27198. */
  27199. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  27200. /**
  27201. * Prepares the defines related to multiview
  27202. * @param scene The scene we are intending to draw
  27203. * @param defines The defines to update
  27204. */
  27205. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  27206. /**
  27207. * Prepares the defines related to the prepass
  27208. * @param scene The scene we are intending to draw
  27209. * @param defines The defines to update
  27210. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  27211. */
  27212. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  27213. /**
  27214. * Prepares the defines related to the light information passed in parameter
  27215. * @param scene The scene we are intending to draw
  27216. * @param mesh The mesh the effect is compiling for
  27217. * @param light The light the effect is compiling for
  27218. * @param lightIndex The index of the light
  27219. * @param defines The defines to update
  27220. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  27221. * @param state Defines the current state regarding what is needed (normals, etc...)
  27222. */
  27223. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  27224. needNormals: boolean;
  27225. needRebuild: boolean;
  27226. shadowEnabled: boolean;
  27227. specularEnabled: boolean;
  27228. lightmapMode: boolean;
  27229. }): void;
  27230. /**
  27231. * Prepares the defines related to the light information passed in parameter
  27232. * @param scene The scene we are intending to draw
  27233. * @param mesh The mesh the effect is compiling for
  27234. * @param defines The defines to update
  27235. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  27236. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  27237. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  27238. * @returns true if normals will be required for the rest of the effect
  27239. */
  27240. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  27241. /**
  27242. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  27243. * @param lightIndex defines the light index
  27244. * @param uniformsList The uniform list
  27245. * @param samplersList The sampler list
  27246. * @param projectedLightTexture defines if projected texture must be used
  27247. * @param uniformBuffersList defines an optional list of uniform buffers
  27248. */
  27249. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  27250. /**
  27251. * Prepares the uniforms and samplers list to be used in the effect
  27252. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  27253. * @param samplersList The sampler list
  27254. * @param defines The defines helping in the list generation
  27255. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  27256. */
  27257. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  27258. /**
  27259. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  27260. * @param defines The defines to update while falling back
  27261. * @param fallbacks The authorized effect fallbacks
  27262. * @param maxSimultaneousLights The maximum number of lights allowed
  27263. * @param rank the current rank of the Effect
  27264. * @returns The newly affected rank
  27265. */
  27266. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  27267. private static _TmpMorphInfluencers;
  27268. /**
  27269. * Prepares the list of attributes required for morph targets according to the effect defines.
  27270. * @param attribs The current list of supported attribs
  27271. * @param mesh The mesh to prepare the morph targets attributes for
  27272. * @param influencers The number of influencers
  27273. */
  27274. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  27275. /**
  27276. * Prepares the list of attributes required for morph targets according to the effect defines.
  27277. * @param attribs The current list of supported attribs
  27278. * @param mesh The mesh to prepare the morph targets attributes for
  27279. * @param defines The current Defines of the effect
  27280. */
  27281. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  27282. /**
  27283. * Prepares the list of attributes required for bones according to the effect defines.
  27284. * @param attribs The current list of supported attribs
  27285. * @param mesh The mesh to prepare the bones attributes for
  27286. * @param defines The current Defines of the effect
  27287. * @param fallbacks The current efffect fallback strategy
  27288. */
  27289. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  27290. /**
  27291. * Check and prepare the list of attributes required for instances according to the effect defines.
  27292. * @param attribs The current list of supported attribs
  27293. * @param defines The current MaterialDefines of the effect
  27294. */
  27295. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  27296. /**
  27297. * Add the list of attributes required for instances to the attribs array.
  27298. * @param attribs The current list of supported attribs
  27299. */
  27300. static PushAttributesForInstances(attribs: string[]): void;
  27301. /**
  27302. * Binds the light information to the effect.
  27303. * @param light The light containing the generator
  27304. * @param effect The effect we are binding the data to
  27305. * @param lightIndex The light index in the effect used to render
  27306. */
  27307. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  27308. /**
  27309. * Binds the lights information from the scene to the effect for the given mesh.
  27310. * @param light Light to bind
  27311. * @param lightIndex Light index
  27312. * @param scene The scene where the light belongs to
  27313. * @param effect The effect we are binding the data to
  27314. * @param useSpecular Defines if specular is supported
  27315. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  27316. */
  27317. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  27318. /**
  27319. * Binds the lights information from the scene to the effect for the given mesh.
  27320. * @param scene The scene the lights belongs to
  27321. * @param mesh The mesh we are binding the information to render
  27322. * @param effect The effect we are binding the data to
  27323. * @param defines The generated defines for the effect
  27324. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  27325. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  27326. */
  27327. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  27328. private static _tempFogColor;
  27329. /**
  27330. * Binds the fog information from the scene to the effect for the given mesh.
  27331. * @param scene The scene the lights belongs to
  27332. * @param mesh The mesh we are binding the information to render
  27333. * @param effect The effect we are binding the data to
  27334. * @param linearSpace Defines if the fog effect is applied in linear space
  27335. */
  27336. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  27337. /**
  27338. * Binds the bones information from the mesh to the effect.
  27339. * @param mesh The mesh we are binding the information to render
  27340. * @param effect The effect we are binding the data to
  27341. * @param prePassConfiguration Configuration for the prepass, in case prepass is activated
  27342. */
  27343. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect, prePassConfiguration?: PrePassConfiguration): void;
  27344. private static _CopyBonesTransformationMatrices;
  27345. /**
  27346. * Binds the morph targets information from the mesh to the effect.
  27347. * @param abstractMesh The mesh we are binding the information to render
  27348. * @param effect The effect we are binding the data to
  27349. */
  27350. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  27351. /**
  27352. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  27353. * @param defines The generated defines used in the effect
  27354. * @param effect The effect we are binding the data to
  27355. * @param scene The scene we are willing to render with logarithmic scale for
  27356. */
  27357. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  27358. /**
  27359. * Binds the clip plane information from the scene to the effect.
  27360. * @param scene The scene the clip plane information are extracted from
  27361. * @param effect The effect we are binding the data to
  27362. */
  27363. static BindClipPlane(effect: Effect, scene: Scene): void;
  27364. }
  27365. }
  27366. declare module BABYLON {
  27367. /** @hidden */
  27368. export var bayerDitherFunctions: {
  27369. name: string;
  27370. shader: string;
  27371. };
  27372. }
  27373. declare module BABYLON {
  27374. /** @hidden */
  27375. export var shadowMapFragmentDeclaration: {
  27376. name: string;
  27377. shader: string;
  27378. };
  27379. }
  27380. declare module BABYLON {
  27381. /** @hidden */
  27382. export var shadowMapFragment: {
  27383. name: string;
  27384. shader: string;
  27385. };
  27386. }
  27387. declare module BABYLON {
  27388. /** @hidden */
  27389. export var shadowMapPixelShader: {
  27390. name: string;
  27391. shader: string;
  27392. };
  27393. }
  27394. declare module BABYLON {
  27395. /** @hidden */
  27396. export var shadowMapVertexDeclaration: {
  27397. name: string;
  27398. shader: string;
  27399. };
  27400. }
  27401. declare module BABYLON {
  27402. /** @hidden */
  27403. export var shadowMapVertexNormalBias: {
  27404. name: string;
  27405. shader: string;
  27406. };
  27407. }
  27408. declare module BABYLON {
  27409. /** @hidden */
  27410. export var shadowMapVertexMetric: {
  27411. name: string;
  27412. shader: string;
  27413. };
  27414. }
  27415. declare module BABYLON {
  27416. /** @hidden */
  27417. export var shadowMapVertexShader: {
  27418. name: string;
  27419. shader: string;
  27420. };
  27421. }
  27422. declare module BABYLON {
  27423. /** @hidden */
  27424. export var depthBoxBlurPixelShader: {
  27425. name: string;
  27426. shader: string;
  27427. };
  27428. }
  27429. declare module BABYLON {
  27430. /** @hidden */
  27431. export var shadowMapFragmentSoftTransparentShadow: {
  27432. name: string;
  27433. shader: string;
  27434. };
  27435. }
  27436. declare module BABYLON {
  27437. /**
  27438. * Creates an instance based on a source mesh.
  27439. */
  27440. export class InstancedMesh extends AbstractMesh {
  27441. private _sourceMesh;
  27442. private _currentLOD;
  27443. /** @hidden */
  27444. _indexInSourceMeshInstanceArray: number;
  27445. constructor(name: string, source: Mesh);
  27446. /**
  27447. * Returns the string "InstancedMesh".
  27448. */
  27449. getClassName(): string;
  27450. /** Gets the list of lights affecting that mesh */
  27451. get lightSources(): Light[];
  27452. _resyncLightSources(): void;
  27453. _resyncLightSource(light: Light): void;
  27454. _removeLightSource(light: Light, dispose: boolean): void;
  27455. /**
  27456. * If the source mesh receives shadows
  27457. */
  27458. get receiveShadows(): boolean;
  27459. /**
  27460. * The material of the source mesh
  27461. */
  27462. get material(): Nullable<Material>;
  27463. /**
  27464. * Visibility of the source mesh
  27465. */
  27466. get visibility(): number;
  27467. /**
  27468. * Skeleton of the source mesh
  27469. */
  27470. get skeleton(): Nullable<Skeleton>;
  27471. /**
  27472. * Rendering ground id of the source mesh
  27473. */
  27474. get renderingGroupId(): number;
  27475. set renderingGroupId(value: number);
  27476. /**
  27477. * Returns the total number of vertices (integer).
  27478. */
  27479. getTotalVertices(): number;
  27480. /**
  27481. * Returns a positive integer : the total number of indices in this mesh geometry.
  27482. * @returns the numner of indices or zero if the mesh has no geometry.
  27483. */
  27484. getTotalIndices(): number;
  27485. /**
  27486. * The source mesh of the instance
  27487. */
  27488. get sourceMesh(): Mesh;
  27489. /**
  27490. * Creates a new InstancedMesh object from the mesh model.
  27491. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  27492. * @param name defines the name of the new instance
  27493. * @returns a new InstancedMesh
  27494. */
  27495. createInstance(name: string): InstancedMesh;
  27496. /**
  27497. * Is this node ready to be used/rendered
  27498. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  27499. * @return {boolean} is it ready
  27500. */
  27501. isReady(completeCheck?: boolean): boolean;
  27502. /**
  27503. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  27504. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  27505. * @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.
  27506. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  27507. */
  27508. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  27509. /**
  27510. * Sets the vertex data of the mesh geometry for the requested `kind`.
  27511. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  27512. * The `data` are either a numeric array either a Float32Array.
  27513. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  27514. * 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).
  27515. * Note that a new underlying VertexBuffer object is created each call.
  27516. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  27517. *
  27518. * Possible `kind` values :
  27519. * - VertexBuffer.PositionKind
  27520. * - VertexBuffer.UVKind
  27521. * - VertexBuffer.UV2Kind
  27522. * - VertexBuffer.UV3Kind
  27523. * - VertexBuffer.UV4Kind
  27524. * - VertexBuffer.UV5Kind
  27525. * - VertexBuffer.UV6Kind
  27526. * - VertexBuffer.ColorKind
  27527. * - VertexBuffer.MatricesIndicesKind
  27528. * - VertexBuffer.MatricesIndicesExtraKind
  27529. * - VertexBuffer.MatricesWeightsKind
  27530. * - VertexBuffer.MatricesWeightsExtraKind
  27531. *
  27532. * Returns the Mesh.
  27533. */
  27534. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  27535. /**
  27536. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  27537. * If the mesh has no geometry, it is simply returned as it is.
  27538. * The `data` are either a numeric array either a Float32Array.
  27539. * No new underlying VertexBuffer object is created.
  27540. * 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.
  27541. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  27542. *
  27543. * Possible `kind` values :
  27544. * - VertexBuffer.PositionKind
  27545. * - VertexBuffer.UVKind
  27546. * - VertexBuffer.UV2Kind
  27547. * - VertexBuffer.UV3Kind
  27548. * - VertexBuffer.UV4Kind
  27549. * - VertexBuffer.UV5Kind
  27550. * - VertexBuffer.UV6Kind
  27551. * - VertexBuffer.ColorKind
  27552. * - VertexBuffer.MatricesIndicesKind
  27553. * - VertexBuffer.MatricesIndicesExtraKind
  27554. * - VertexBuffer.MatricesWeightsKind
  27555. * - VertexBuffer.MatricesWeightsExtraKind
  27556. *
  27557. * Returns the Mesh.
  27558. */
  27559. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  27560. /**
  27561. * Sets the mesh indices.
  27562. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  27563. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  27564. * This method creates a new index buffer each call.
  27565. * Returns the Mesh.
  27566. */
  27567. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  27568. /**
  27569. * Boolean : True if the mesh owns the requested kind of data.
  27570. */
  27571. isVerticesDataPresent(kind: string): boolean;
  27572. /**
  27573. * Returns an array of indices (IndicesArray).
  27574. */
  27575. getIndices(): Nullable<IndicesArray>;
  27576. get _positions(): Nullable<Vector3[]>;
  27577. /**
  27578. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  27579. * This means the mesh underlying bounding box and sphere are recomputed.
  27580. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  27581. * @returns the current mesh
  27582. */
  27583. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  27584. /** @hidden */
  27585. _preActivate(): InstancedMesh;
  27586. /** @hidden */
  27587. _activate(renderId: number, intermediateRendering: boolean): boolean;
  27588. /** @hidden */
  27589. _postActivate(): void;
  27590. getWorldMatrix(): Matrix;
  27591. get isAnInstance(): boolean;
  27592. /**
  27593. * Returns the current associated LOD AbstractMesh.
  27594. */
  27595. getLOD(camera: Camera): AbstractMesh;
  27596. /** @hidden */
  27597. _preActivateForIntermediateRendering(renderId: number): Mesh;
  27598. /** @hidden */
  27599. _syncSubMeshes(): InstancedMesh;
  27600. /** @hidden */
  27601. _generatePointsArray(): boolean;
  27602. /** @hidden */
  27603. _updateBoundingInfo(): AbstractMesh;
  27604. /**
  27605. * Creates a new InstancedMesh from the current mesh.
  27606. * - name (string) : the cloned mesh name
  27607. * - newParent (optional Node) : the optional Node to parent the clone to.
  27608. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  27609. *
  27610. * Returns the clone.
  27611. */
  27612. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  27613. /**
  27614. * Disposes the InstancedMesh.
  27615. * Returns nothing.
  27616. */
  27617. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  27618. }
  27619. interface Mesh {
  27620. /**
  27621. * Register a custom buffer that will be instanced
  27622. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  27623. * @param kind defines the buffer kind
  27624. * @param stride defines the stride in floats
  27625. */
  27626. registerInstancedBuffer(kind: string, stride: number): void;
  27627. /**
  27628. * true to use the edge renderer for all instances of this mesh
  27629. */
  27630. edgesShareWithInstances: boolean;
  27631. /** @hidden */
  27632. _userInstancedBuffersStorage: {
  27633. data: {
  27634. [key: string]: Float32Array;
  27635. };
  27636. sizes: {
  27637. [key: string]: number;
  27638. };
  27639. vertexBuffers: {
  27640. [key: string]: Nullable<VertexBuffer>;
  27641. };
  27642. strides: {
  27643. [key: string]: number;
  27644. };
  27645. };
  27646. }
  27647. interface AbstractMesh {
  27648. /**
  27649. * Object used to store instanced buffers defined by user
  27650. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  27651. */
  27652. instancedBuffers: {
  27653. [key: string]: any;
  27654. };
  27655. }
  27656. }
  27657. declare module BABYLON {
  27658. /**
  27659. * Defines the options associated with the creation of a shader material.
  27660. */
  27661. export interface IShaderMaterialOptions {
  27662. /**
  27663. * Does the material work in alpha blend mode
  27664. */
  27665. needAlphaBlending: boolean;
  27666. /**
  27667. * Does the material work in alpha test mode
  27668. */
  27669. needAlphaTesting: boolean;
  27670. /**
  27671. * The list of attribute names used in the shader
  27672. */
  27673. attributes: string[];
  27674. /**
  27675. * The list of unifrom names used in the shader
  27676. */
  27677. uniforms: string[];
  27678. /**
  27679. * The list of UBO names used in the shader
  27680. */
  27681. uniformBuffers: string[];
  27682. /**
  27683. * The list of sampler names used in the shader
  27684. */
  27685. samplers: string[];
  27686. /**
  27687. * The list of defines used in the shader
  27688. */
  27689. defines: string[];
  27690. }
  27691. /**
  27692. * 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.
  27693. *
  27694. * This returned material effects how the mesh will look based on the code in the shaders.
  27695. *
  27696. * @see https://doc.babylonjs.com/how_to/shader_material
  27697. */
  27698. export class ShaderMaterial extends Material {
  27699. private _shaderPath;
  27700. private _options;
  27701. private _textures;
  27702. private _textureArrays;
  27703. private _floats;
  27704. private _ints;
  27705. private _floatsArrays;
  27706. private _colors3;
  27707. private _colors3Arrays;
  27708. private _colors4;
  27709. private _colors4Arrays;
  27710. private _vectors2;
  27711. private _vectors3;
  27712. private _vectors4;
  27713. private _matrices;
  27714. private _matrixArrays;
  27715. private _matrices3x3;
  27716. private _matrices2x2;
  27717. private _vectors2Arrays;
  27718. private _vectors3Arrays;
  27719. private _vectors4Arrays;
  27720. private _cachedWorldViewMatrix;
  27721. private _cachedWorldViewProjectionMatrix;
  27722. private _renderId;
  27723. private _multiview;
  27724. private _cachedDefines;
  27725. /** Define the Url to load snippets */
  27726. static SnippetUrl: string;
  27727. /** Snippet ID if the material was created from the snippet server */
  27728. snippetId: string;
  27729. /**
  27730. * Instantiate a new shader material.
  27731. * 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.
  27732. * This returned material effects how the mesh will look based on the code in the shaders.
  27733. * @see https://doc.babylonjs.com/how_to/shader_material
  27734. * @param name Define the name of the material in the scene
  27735. * @param scene Define the scene the material belongs to
  27736. * @param shaderPath Defines the route to the shader code in one of three ways:
  27737. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  27738. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  27739. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  27740. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  27741. * @param options Define the options used to create the shader
  27742. */
  27743. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  27744. /**
  27745. * Gets the shader path used to define the shader code
  27746. * It can be modified to trigger a new compilation
  27747. */
  27748. get shaderPath(): any;
  27749. /**
  27750. * Sets the shader path used to define the shader code
  27751. * It can be modified to trigger a new compilation
  27752. */
  27753. set shaderPath(shaderPath: any);
  27754. /**
  27755. * Gets the options used to compile the shader.
  27756. * They can be modified to trigger a new compilation
  27757. */
  27758. get options(): IShaderMaterialOptions;
  27759. /**
  27760. * Gets the current class name of the material e.g. "ShaderMaterial"
  27761. * Mainly use in serialization.
  27762. * @returns the class name
  27763. */
  27764. getClassName(): string;
  27765. /**
  27766. * Specifies if the material will require alpha blending
  27767. * @returns a boolean specifying if alpha blending is needed
  27768. */
  27769. needAlphaBlending(): boolean;
  27770. /**
  27771. * Specifies if this material should be rendered in alpha test mode
  27772. * @returns a boolean specifying if an alpha test is needed.
  27773. */
  27774. needAlphaTesting(): boolean;
  27775. private _checkUniform;
  27776. /**
  27777. * Set a texture in the shader.
  27778. * @param name Define the name of the uniform samplers as defined in the shader
  27779. * @param texture Define the texture to bind to this sampler
  27780. * @return the material itself allowing "fluent" like uniform updates
  27781. */
  27782. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  27783. /**
  27784. * Set a texture array in the shader.
  27785. * @param name Define the name of the uniform sampler array as defined in the shader
  27786. * @param textures Define the list of textures to bind to this sampler
  27787. * @return the material itself allowing "fluent" like uniform updates
  27788. */
  27789. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  27790. /**
  27791. * Set a float in the shader.
  27792. * @param name Define the name of the uniform as defined in the shader
  27793. * @param value Define the value to give to the uniform
  27794. * @return the material itself allowing "fluent" like uniform updates
  27795. */
  27796. setFloat(name: string, value: number): ShaderMaterial;
  27797. /**
  27798. * Set a int in the shader.
  27799. * @param name Define the name of the uniform as defined in the shader
  27800. * @param value Define the value to give to the uniform
  27801. * @return the material itself allowing "fluent" like uniform updates
  27802. */
  27803. setInt(name: string, value: number): ShaderMaterial;
  27804. /**
  27805. * Set an array of floats in the shader.
  27806. * @param name Define the name of the uniform as defined in the shader
  27807. * @param value Define the value to give to the uniform
  27808. * @return the material itself allowing "fluent" like uniform updates
  27809. */
  27810. setFloats(name: string, value: number[]): ShaderMaterial;
  27811. /**
  27812. * Set a vec3 in the shader from a Color3.
  27813. * @param name Define the name of the uniform as defined in the shader
  27814. * @param value Define the value to give to the uniform
  27815. * @return the material itself allowing "fluent" like uniform updates
  27816. */
  27817. setColor3(name: string, value: Color3): ShaderMaterial;
  27818. /**
  27819. * Set a vec3 array in the shader from a Color3 array.
  27820. * @param name Define the name of the uniform as defined in the shader
  27821. * @param value Define the value to give to the uniform
  27822. * @return the material itself allowing "fluent" like uniform updates
  27823. */
  27824. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  27825. /**
  27826. * Set a vec4 in the shader from a Color4.
  27827. * @param name Define the name of the uniform as defined in the shader
  27828. * @param value Define the value to give to the uniform
  27829. * @return the material itself allowing "fluent" like uniform updates
  27830. */
  27831. setColor4(name: string, value: Color4): ShaderMaterial;
  27832. /**
  27833. * Set a vec4 array in the shader from a Color4 array.
  27834. * @param name Define the name of the uniform as defined in the shader
  27835. * @param value Define the value to give to the uniform
  27836. * @return the material itself allowing "fluent" like uniform updates
  27837. */
  27838. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  27839. /**
  27840. * Set a vec2 in the shader from a Vector2.
  27841. * @param name Define the name of the uniform as defined in the shader
  27842. * @param value Define the value to give to the uniform
  27843. * @return the material itself allowing "fluent" like uniform updates
  27844. */
  27845. setVector2(name: string, value: Vector2): ShaderMaterial;
  27846. /**
  27847. * Set a vec3 in the shader from a Vector3.
  27848. * @param name Define the name of the uniform as defined in the shader
  27849. * @param value Define the value to give to the uniform
  27850. * @return the material itself allowing "fluent" like uniform updates
  27851. */
  27852. setVector3(name: string, value: Vector3): ShaderMaterial;
  27853. /**
  27854. * Set a vec4 in the shader from a Vector4.
  27855. * @param name Define the name of the uniform as defined in the shader
  27856. * @param value Define the value to give to the uniform
  27857. * @return the material itself allowing "fluent" like uniform updates
  27858. */
  27859. setVector4(name: string, value: Vector4): ShaderMaterial;
  27860. /**
  27861. * Set a mat4 in the shader from a Matrix.
  27862. * @param name Define the name of the uniform as defined in the shader
  27863. * @param value Define the value to give to the uniform
  27864. * @return the material itself allowing "fluent" like uniform updates
  27865. */
  27866. setMatrix(name: string, value: Matrix): ShaderMaterial;
  27867. /**
  27868. * Set a float32Array in the shader from a matrix array.
  27869. * @param name Define the name of the uniform as defined in the shader
  27870. * @param value Define the value to give to the uniform
  27871. * @return the material itself allowing "fluent" like uniform updates
  27872. */
  27873. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  27874. /**
  27875. * Set a mat3 in the shader from a Float32Array.
  27876. * @param name Define the name of the uniform as defined in the shader
  27877. * @param value Define the value to give to the uniform
  27878. * @return the material itself allowing "fluent" like uniform updates
  27879. */
  27880. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  27881. /**
  27882. * Set a mat2 in the shader from a Float32Array.
  27883. * @param name Define the name of the uniform as defined in the shader
  27884. * @param value Define the value to give to the uniform
  27885. * @return the material itself allowing "fluent" like uniform updates
  27886. */
  27887. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  27888. /**
  27889. * Set a vec2 array in the shader from a number array.
  27890. * @param name Define the name of the uniform as defined in the shader
  27891. * @param value Define the value to give to the uniform
  27892. * @return the material itself allowing "fluent" like uniform updates
  27893. */
  27894. setArray2(name: string, value: number[]): ShaderMaterial;
  27895. /**
  27896. * Set a vec3 array in the shader from a number array.
  27897. * @param name Define the name of the uniform as defined in the shader
  27898. * @param value Define the value to give to the uniform
  27899. * @return the material itself allowing "fluent" like uniform updates
  27900. */
  27901. setArray3(name: string, value: number[]): ShaderMaterial;
  27902. /**
  27903. * Set a vec4 array in the shader from a number array.
  27904. * @param name Define the name of the uniform as defined in the shader
  27905. * @param value Define the value to give to the uniform
  27906. * @return the material itself allowing "fluent" like uniform updates
  27907. */
  27908. setArray4(name: string, value: number[]): ShaderMaterial;
  27909. private _checkCache;
  27910. /**
  27911. * Specifies that the submesh is ready to be used
  27912. * @param mesh defines the mesh to check
  27913. * @param subMesh defines which submesh to check
  27914. * @param useInstances specifies that instances should be used
  27915. * @returns a boolean indicating that the submesh is ready or not
  27916. */
  27917. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  27918. /**
  27919. * Checks if the material is ready to render the requested mesh
  27920. * @param mesh Define the mesh to render
  27921. * @param useInstances Define whether or not the material is used with instances
  27922. * @returns true if ready, otherwise false
  27923. */
  27924. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  27925. /**
  27926. * Binds the world matrix to the material
  27927. * @param world defines the world transformation matrix
  27928. * @param effectOverride - If provided, use this effect instead of internal effect
  27929. */
  27930. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  27931. /**
  27932. * Binds the submesh to this material by preparing the effect and shader to draw
  27933. * @param world defines the world transformation matrix
  27934. * @param mesh defines the mesh containing the submesh
  27935. * @param subMesh defines the submesh to bind the material to
  27936. */
  27937. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  27938. /**
  27939. * Binds the material to the mesh
  27940. * @param world defines the world transformation matrix
  27941. * @param mesh defines the mesh to bind the material to
  27942. * @param effectOverride - If provided, use this effect instead of internal effect
  27943. */
  27944. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  27945. protected _afterBind(mesh?: Mesh): void;
  27946. /**
  27947. * Gets the active textures from the material
  27948. * @returns an array of textures
  27949. */
  27950. getActiveTextures(): BaseTexture[];
  27951. /**
  27952. * Specifies if the material uses a texture
  27953. * @param texture defines the texture to check against the material
  27954. * @returns a boolean specifying if the material uses the texture
  27955. */
  27956. hasTexture(texture: BaseTexture): boolean;
  27957. /**
  27958. * Makes a duplicate of the material, and gives it a new name
  27959. * @param name defines the new name for the duplicated material
  27960. * @returns the cloned material
  27961. */
  27962. clone(name: string): ShaderMaterial;
  27963. /**
  27964. * Disposes the material
  27965. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  27966. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  27967. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  27968. */
  27969. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  27970. /**
  27971. * Serializes this material in a JSON representation
  27972. * @returns the serialized material object
  27973. */
  27974. serialize(): any;
  27975. /**
  27976. * Creates a shader material from parsed shader material data
  27977. * @param source defines the JSON represnetation of the material
  27978. * @param scene defines the hosting scene
  27979. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  27980. * @returns a new material
  27981. */
  27982. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  27983. /**
  27984. * Creates a new ShaderMaterial from a snippet saved in a remote file
  27985. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  27986. * @param url defines the url to load from
  27987. * @param scene defines the hosting scene
  27988. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  27989. * @returns a promise that will resolve to the new ShaderMaterial
  27990. */
  27991. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  27992. /**
  27993. * Creates a ShaderMaterial from a snippet saved by the Inspector
  27994. * @param snippetId defines the snippet to load
  27995. * @param scene defines the hosting scene
  27996. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  27997. * @returns a promise that will resolve to the new ShaderMaterial
  27998. */
  27999. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  28000. }
  28001. }
  28002. declare module BABYLON {
  28003. /** @hidden */
  28004. export var colorPixelShader: {
  28005. name: string;
  28006. shader: string;
  28007. };
  28008. }
  28009. declare module BABYLON {
  28010. /** @hidden */
  28011. export var colorVertexShader: {
  28012. name: string;
  28013. shader: string;
  28014. };
  28015. }
  28016. declare module BABYLON {
  28017. /**
  28018. * Line mesh
  28019. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  28020. */
  28021. export class LinesMesh extends Mesh {
  28022. /**
  28023. * If vertex color should be applied to the mesh
  28024. */
  28025. readonly useVertexColor?: boolean | undefined;
  28026. /**
  28027. * If vertex alpha should be applied to the mesh
  28028. */
  28029. readonly useVertexAlpha?: boolean | undefined;
  28030. /**
  28031. * Color of the line (Default: White)
  28032. */
  28033. color: Color3;
  28034. /**
  28035. * Alpha of the line (Default: 1)
  28036. */
  28037. alpha: number;
  28038. /**
  28039. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  28040. * This margin is expressed in world space coordinates, so its value may vary.
  28041. * Default value is 0.1
  28042. */
  28043. intersectionThreshold: number;
  28044. private _colorShader;
  28045. private color4;
  28046. /**
  28047. * Creates a new LinesMesh
  28048. * @param name defines the name
  28049. * @param scene defines the hosting scene
  28050. * @param parent defines the parent mesh if any
  28051. * @param source defines the optional source LinesMesh used to clone data from
  28052. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  28053. * When false, achieved by calling a clone(), also passing False.
  28054. * This will make creation of children, recursive.
  28055. * @param useVertexColor defines if this LinesMesh supports vertex color
  28056. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  28057. */
  28058. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  28059. /**
  28060. * If vertex color should be applied to the mesh
  28061. */
  28062. useVertexColor?: boolean | undefined,
  28063. /**
  28064. * If vertex alpha should be applied to the mesh
  28065. */
  28066. useVertexAlpha?: boolean | undefined);
  28067. private _addClipPlaneDefine;
  28068. private _removeClipPlaneDefine;
  28069. isReady(): boolean;
  28070. /**
  28071. * Returns the string "LineMesh"
  28072. */
  28073. getClassName(): string;
  28074. /**
  28075. * @hidden
  28076. */
  28077. get material(): Material;
  28078. /**
  28079. * @hidden
  28080. */
  28081. set material(value: Material);
  28082. /**
  28083. * @hidden
  28084. */
  28085. get checkCollisions(): boolean;
  28086. /** @hidden */
  28087. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  28088. /** @hidden */
  28089. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  28090. /**
  28091. * Disposes of the line mesh
  28092. * @param doNotRecurse If children should be disposed
  28093. */
  28094. dispose(doNotRecurse?: boolean): void;
  28095. /**
  28096. * Returns a new LineMesh object cloned from the current one.
  28097. */
  28098. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  28099. /**
  28100. * Creates a new InstancedLinesMesh object from the mesh model.
  28101. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  28102. * @param name defines the name of the new instance
  28103. * @returns a new InstancedLinesMesh
  28104. */
  28105. createInstance(name: string): InstancedLinesMesh;
  28106. }
  28107. /**
  28108. * Creates an instance based on a source LinesMesh
  28109. */
  28110. export class InstancedLinesMesh extends InstancedMesh {
  28111. /**
  28112. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  28113. * This margin is expressed in world space coordinates, so its value may vary.
  28114. * Initilized with the intersectionThreshold value of the source LinesMesh
  28115. */
  28116. intersectionThreshold: number;
  28117. constructor(name: string, source: LinesMesh);
  28118. /**
  28119. * Returns the string "InstancedLinesMesh".
  28120. */
  28121. getClassName(): string;
  28122. }
  28123. }
  28124. declare module BABYLON {
  28125. /** @hidden */
  28126. export var linePixelShader: {
  28127. name: string;
  28128. shader: string;
  28129. };
  28130. }
  28131. declare module BABYLON {
  28132. /** @hidden */
  28133. export var lineVertexShader: {
  28134. name: string;
  28135. shader: string;
  28136. };
  28137. }
  28138. declare module BABYLON {
  28139. interface Scene {
  28140. /** @hidden */
  28141. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  28142. }
  28143. interface AbstractMesh {
  28144. /**
  28145. * Gets the edgesRenderer associated with the mesh
  28146. */
  28147. edgesRenderer: Nullable<EdgesRenderer>;
  28148. }
  28149. interface LinesMesh {
  28150. /**
  28151. * Enables the edge rendering mode on the mesh.
  28152. * This mode makes the mesh edges visible
  28153. * @param epsilon defines the maximal distance between two angles to detect a face
  28154. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  28155. * @returns the currentAbstractMesh
  28156. * @see https://www.babylonjs-playground.com/#19O9TU#0
  28157. */
  28158. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  28159. }
  28160. interface InstancedLinesMesh {
  28161. /**
  28162. * Enables the edge rendering mode on the mesh.
  28163. * This mode makes the mesh edges visible
  28164. * @param epsilon defines the maximal distance between two angles to detect a face
  28165. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  28166. * @returns the current InstancedLinesMesh
  28167. * @see https://www.babylonjs-playground.com/#19O9TU#0
  28168. */
  28169. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  28170. }
  28171. /**
  28172. * Defines the minimum contract an Edges renderer should follow.
  28173. */
  28174. export interface IEdgesRenderer extends IDisposable {
  28175. /**
  28176. * Gets or sets a boolean indicating if the edgesRenderer is active
  28177. */
  28178. isEnabled: boolean;
  28179. /**
  28180. * Renders the edges of the attached mesh,
  28181. */
  28182. render(): void;
  28183. /**
  28184. * Checks wether or not the edges renderer is ready to render.
  28185. * @return true if ready, otherwise false.
  28186. */
  28187. isReady(): boolean;
  28188. /**
  28189. * List of instances to render in case the source mesh has instances
  28190. */
  28191. customInstances: SmartArray<Matrix>;
  28192. }
  28193. /**
  28194. * Defines the additional options of the edges renderer
  28195. */
  28196. export interface IEdgesRendererOptions {
  28197. /**
  28198. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  28199. * If not defined, the default value is true
  28200. */
  28201. useAlternateEdgeFinder?: boolean;
  28202. /**
  28203. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  28204. * If not defined, the default value is true.
  28205. * You should normally leave it undefined (or set it to true), except if you see some artifacts in the edges rendering (can happen with complex geometries)
  28206. * This option is used only if useAlternateEdgeFinder = true
  28207. */
  28208. useFastVertexMerger?: boolean;
  28209. /**
  28210. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  28211. * The default value is 1e-6
  28212. * This option is used only if useAlternateEdgeFinder = true
  28213. */
  28214. epsilonVertexMerge?: number;
  28215. /**
  28216. * Gets or sets a boolean indicating that tessellation should be applied before finding the edges. You may need to activate this option if your geometry is a bit
  28217. * unusual, like having a vertex of a triangle in-between two vertices of an edge of another triangle. It happens often when using CSG to construct meshes.
  28218. * This option is used only if useAlternateEdgeFinder = true
  28219. */
  28220. applyTessellation?: boolean;
  28221. /**
  28222. * The limit under which 3 vertices are considered to be aligned. 3 vertices PQR are considered aligned if distance(PQ) + distance(QR) - distance(PR) < epsilonVertexAligned
  28223. * The default value is 1e-6
  28224. * This option is used only if useAlternateEdgeFinder = true
  28225. */
  28226. epsilonVertexAligned?: number;
  28227. }
  28228. /**
  28229. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  28230. */
  28231. export class EdgesRenderer implements IEdgesRenderer {
  28232. /**
  28233. * Define the size of the edges with an orthographic camera
  28234. */
  28235. edgesWidthScalerForOrthographic: number;
  28236. /**
  28237. * Define the size of the edges with a perspective camera
  28238. */
  28239. edgesWidthScalerForPerspective: number;
  28240. protected _source: AbstractMesh;
  28241. protected _linesPositions: number[];
  28242. protected _linesNormals: number[];
  28243. protected _linesIndices: number[];
  28244. protected _epsilon: number;
  28245. protected _indicesCount: number;
  28246. protected _lineShader: ShaderMaterial;
  28247. protected _ib: DataBuffer;
  28248. protected _buffers: {
  28249. [key: string]: Nullable<VertexBuffer>;
  28250. };
  28251. protected _buffersForInstances: {
  28252. [key: string]: Nullable<VertexBuffer>;
  28253. };
  28254. protected _checkVerticesInsteadOfIndices: boolean;
  28255. protected _options: Nullable<IEdgesRendererOptions>;
  28256. private _meshRebuildObserver;
  28257. private _meshDisposeObserver;
  28258. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  28259. isEnabled: boolean;
  28260. /** Gets the vertices generated by the edge renderer */
  28261. get linesPositions(): Immutable<Array<number>>;
  28262. /** Gets the normals generated by the edge renderer */
  28263. get linesNormals(): Immutable<Array<number>>;
  28264. /** Gets the indices generated by the edge renderer */
  28265. get linesIndices(): Immutable<Array<number>>;
  28266. /**
  28267. * List of instances to render in case the source mesh has instances
  28268. */
  28269. customInstances: SmartArray<Matrix>;
  28270. private static GetShader;
  28271. /**
  28272. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  28273. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  28274. * @param source Mesh used to create edges
  28275. * @param epsilon sum of angles in adjacency to check for edge
  28276. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  28277. * @param generateEdgesLines - should generate Lines or only prepare resources.
  28278. * @param options The options to apply when generating the edges
  28279. */
  28280. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  28281. protected _prepareRessources(): void;
  28282. /** @hidden */
  28283. _rebuild(): void;
  28284. /**
  28285. * Releases the required resources for the edges renderer
  28286. */
  28287. dispose(): void;
  28288. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  28289. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  28290. /**
  28291. * Checks if the pair of p0 and p1 is en edge
  28292. * @param faceIndex
  28293. * @param edge
  28294. * @param faceNormals
  28295. * @param p0
  28296. * @param p1
  28297. * @private
  28298. */
  28299. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  28300. /**
  28301. * push line into the position, normal and index buffer
  28302. * @protected
  28303. */
  28304. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  28305. /**
  28306. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  28307. */
  28308. private _tessellateTriangle;
  28309. private _generateEdgesLinesAlternate;
  28310. /**
  28311. * Generates lines edges from adjacencjes
  28312. * @private
  28313. */
  28314. _generateEdgesLines(): void;
  28315. /**
  28316. * Checks wether or not the edges renderer is ready to render.
  28317. * @return true if ready, otherwise false.
  28318. */
  28319. isReady(): boolean;
  28320. /**
  28321. * Renders the edges of the attached mesh,
  28322. */
  28323. render(): void;
  28324. }
  28325. /**
  28326. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  28327. */
  28328. export class LineEdgesRenderer extends EdgesRenderer {
  28329. /**
  28330. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  28331. * @param source LineMesh used to generate edges
  28332. * @param epsilon not important (specified angle for edge detection)
  28333. * @param checkVerticesInsteadOfIndices not important for LineMesh
  28334. */
  28335. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  28336. /**
  28337. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  28338. */
  28339. _generateEdgesLines(): void;
  28340. }
  28341. }
  28342. declare module BABYLON {
  28343. /**
  28344. * This represents the object necessary to create a rendering group.
  28345. * This is exclusively used and created by the rendering manager.
  28346. * To modify the behavior, you use the available helpers in your scene or meshes.
  28347. * @hidden
  28348. */
  28349. export class RenderingGroup {
  28350. index: number;
  28351. private static _zeroVector;
  28352. private _scene;
  28353. private _opaqueSubMeshes;
  28354. private _transparentSubMeshes;
  28355. private _alphaTestSubMeshes;
  28356. private _depthOnlySubMeshes;
  28357. private _particleSystems;
  28358. private _spriteManagers;
  28359. private _opaqueSortCompareFn;
  28360. private _alphaTestSortCompareFn;
  28361. private _transparentSortCompareFn;
  28362. private _renderOpaque;
  28363. private _renderAlphaTest;
  28364. private _renderTransparent;
  28365. /** @hidden */
  28366. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  28367. onBeforeTransparentRendering: () => void;
  28368. /**
  28369. * Set the opaque sort comparison function.
  28370. * If null the sub meshes will be render in the order they were created
  28371. */
  28372. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  28373. /**
  28374. * Set the alpha test sort comparison function.
  28375. * If null the sub meshes will be render in the order they were created
  28376. */
  28377. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  28378. /**
  28379. * Set the transparent sort comparison function.
  28380. * If null the sub meshes will be render in the order they were created
  28381. */
  28382. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  28383. /**
  28384. * Creates a new rendering group.
  28385. * @param index The rendering group index
  28386. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  28387. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  28388. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  28389. */
  28390. 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>);
  28391. /**
  28392. * Render all the sub meshes contained in the group.
  28393. * @param customRenderFunction Used to override the default render behaviour of the group.
  28394. * @returns true if rendered some submeshes.
  28395. */
  28396. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  28397. /**
  28398. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  28399. * @param subMeshes The submeshes to render
  28400. */
  28401. private renderOpaqueSorted;
  28402. /**
  28403. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  28404. * @param subMeshes The submeshes to render
  28405. */
  28406. private renderAlphaTestSorted;
  28407. /**
  28408. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  28409. * @param subMeshes The submeshes to render
  28410. */
  28411. private renderTransparentSorted;
  28412. /**
  28413. * Renders the submeshes in a specified order.
  28414. * @param subMeshes The submeshes to sort before render
  28415. * @param sortCompareFn The comparison function use to sort
  28416. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  28417. * @param transparent Specifies to activate blending if true
  28418. */
  28419. private static renderSorted;
  28420. /**
  28421. * Renders the submeshes in the order they were dispatched (no sort applied).
  28422. * @param subMeshes The submeshes to render
  28423. */
  28424. private static renderUnsorted;
  28425. /**
  28426. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  28427. * are rendered back to front if in the same alpha index.
  28428. *
  28429. * @param a The first submesh
  28430. * @param b The second submesh
  28431. * @returns The result of the comparison
  28432. */
  28433. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  28434. /**
  28435. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  28436. * are rendered back to front.
  28437. *
  28438. * @param a The first submesh
  28439. * @param b The second submesh
  28440. * @returns The result of the comparison
  28441. */
  28442. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  28443. /**
  28444. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  28445. * are rendered front to back (prevent overdraw).
  28446. *
  28447. * @param a The first submesh
  28448. * @param b The second submesh
  28449. * @returns The result of the comparison
  28450. */
  28451. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  28452. /**
  28453. * Resets the different lists of submeshes to prepare a new frame.
  28454. */
  28455. prepare(): void;
  28456. dispose(): void;
  28457. /**
  28458. * Inserts the submesh in its correct queue depending on its material.
  28459. * @param subMesh The submesh to dispatch
  28460. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  28461. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  28462. */
  28463. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  28464. dispatchSprites(spriteManager: ISpriteManager): void;
  28465. dispatchParticles(particleSystem: IParticleSystem): void;
  28466. private _renderParticles;
  28467. private _renderSprites;
  28468. }
  28469. }
  28470. declare module BABYLON {
  28471. /**
  28472. * Interface describing the different options available in the rendering manager
  28473. * regarding Auto Clear between groups.
  28474. */
  28475. export interface IRenderingManagerAutoClearSetup {
  28476. /**
  28477. * Defines whether or not autoclear is enable.
  28478. */
  28479. autoClear: boolean;
  28480. /**
  28481. * Defines whether or not to autoclear the depth buffer.
  28482. */
  28483. depth: boolean;
  28484. /**
  28485. * Defines whether or not to autoclear the stencil buffer.
  28486. */
  28487. stencil: boolean;
  28488. }
  28489. /**
  28490. * This class is used by the onRenderingGroupObservable
  28491. */
  28492. export class RenderingGroupInfo {
  28493. /**
  28494. * The Scene that being rendered
  28495. */
  28496. scene: Scene;
  28497. /**
  28498. * The camera currently used for the rendering pass
  28499. */
  28500. camera: Nullable<Camera>;
  28501. /**
  28502. * The ID of the renderingGroup being processed
  28503. */
  28504. renderingGroupId: number;
  28505. }
  28506. /**
  28507. * This is the manager responsible of all the rendering for meshes sprites and particles.
  28508. * It is enable to manage the different groups as well as the different necessary sort functions.
  28509. * This should not be used directly aside of the few static configurations
  28510. */
  28511. export class RenderingManager {
  28512. /**
  28513. * The max id used for rendering groups (not included)
  28514. */
  28515. static MAX_RENDERINGGROUPS: number;
  28516. /**
  28517. * The min id used for rendering groups (included)
  28518. */
  28519. static MIN_RENDERINGGROUPS: number;
  28520. /**
  28521. * Used to globally prevent autoclearing scenes.
  28522. */
  28523. static AUTOCLEAR: boolean;
  28524. /**
  28525. * @hidden
  28526. */
  28527. _useSceneAutoClearSetup: boolean;
  28528. private _scene;
  28529. private _renderingGroups;
  28530. private _depthStencilBufferAlreadyCleaned;
  28531. private _autoClearDepthStencil;
  28532. private _customOpaqueSortCompareFn;
  28533. private _customAlphaTestSortCompareFn;
  28534. private _customTransparentSortCompareFn;
  28535. private _renderingGroupInfo;
  28536. /**
  28537. * Instantiates a new rendering group for a particular scene
  28538. * @param scene Defines the scene the groups belongs to
  28539. */
  28540. constructor(scene: Scene);
  28541. private _clearDepthStencilBuffer;
  28542. /**
  28543. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  28544. * @hidden
  28545. */
  28546. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  28547. /**
  28548. * Resets the different information of the group to prepare a new frame
  28549. * @hidden
  28550. */
  28551. reset(): void;
  28552. /**
  28553. * Dispose and release the group and its associated resources.
  28554. * @hidden
  28555. */
  28556. dispose(): void;
  28557. /**
  28558. * Clear the info related to rendering groups preventing retention points during dispose.
  28559. */
  28560. freeRenderingGroups(): void;
  28561. private _prepareRenderingGroup;
  28562. /**
  28563. * Add a sprite manager to the rendering manager in order to render it this frame.
  28564. * @param spriteManager Define the sprite manager to render
  28565. */
  28566. dispatchSprites(spriteManager: ISpriteManager): void;
  28567. /**
  28568. * Add a particle system to the rendering manager in order to render it this frame.
  28569. * @param particleSystem Define the particle system to render
  28570. */
  28571. dispatchParticles(particleSystem: IParticleSystem): void;
  28572. /**
  28573. * Add a submesh to the manager in order to render it this frame
  28574. * @param subMesh The submesh to dispatch
  28575. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  28576. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  28577. */
  28578. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  28579. /**
  28580. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  28581. * This allowed control for front to back rendering or reversly depending of the special needs.
  28582. *
  28583. * @param renderingGroupId The rendering group id corresponding to its index
  28584. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  28585. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  28586. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  28587. */
  28588. 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;
  28589. /**
  28590. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  28591. *
  28592. * @param renderingGroupId The rendering group id corresponding to its index
  28593. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  28594. * @param depth Automatically clears depth between groups if true and autoClear is true.
  28595. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  28596. */
  28597. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  28598. /**
  28599. * Gets the current auto clear configuration for one rendering group of the rendering
  28600. * manager.
  28601. * @param index the rendering group index to get the information for
  28602. * @returns The auto clear setup for the requested rendering group
  28603. */
  28604. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  28605. }
  28606. }
  28607. declare module BABYLON {
  28608. /**
  28609. * Defines the options associated with the creation of a custom shader for a shadow generator.
  28610. */
  28611. export interface ICustomShaderOptions {
  28612. /**
  28613. * Gets or sets the custom shader name to use
  28614. */
  28615. shaderName: string;
  28616. /**
  28617. * The list of attribute names used in the shader
  28618. */
  28619. attributes?: string[];
  28620. /**
  28621. * The list of unifrom names used in the shader
  28622. */
  28623. uniforms?: string[];
  28624. /**
  28625. * The list of sampler names used in the shader
  28626. */
  28627. samplers?: string[];
  28628. /**
  28629. * The list of defines used in the shader
  28630. */
  28631. defines?: string[];
  28632. }
  28633. /**
  28634. * Interface to implement to create a shadow generator compatible with BJS.
  28635. */
  28636. export interface IShadowGenerator {
  28637. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  28638. id: string;
  28639. /**
  28640. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  28641. * @returns The render target texture if present otherwise, null
  28642. */
  28643. getShadowMap(): Nullable<RenderTargetTexture>;
  28644. /**
  28645. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  28646. * @param subMesh The submesh we want to render in the shadow map
  28647. * @param useInstances Defines wether will draw in the map using instances
  28648. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  28649. * @returns true if ready otherwise, false
  28650. */
  28651. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  28652. /**
  28653. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  28654. * @param defines Defines of the material we want to update
  28655. * @param lightIndex Index of the light in the enabled light list of the material
  28656. */
  28657. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  28658. /**
  28659. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  28660. * defined in the generator but impacting the effect).
  28661. * It implies the unifroms available on the materials are the standard BJS ones.
  28662. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  28663. * @param effect The effect we are binfing the information for
  28664. */
  28665. bindShadowLight(lightIndex: string, effect: Effect): void;
  28666. /**
  28667. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  28668. * (eq to shadow prjection matrix * light transform matrix)
  28669. * @returns The transform matrix used to create the shadow map
  28670. */
  28671. getTransformMatrix(): Matrix;
  28672. /**
  28673. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  28674. * Cube and 2D textures for instance.
  28675. */
  28676. recreateShadowMap(): void;
  28677. /**
  28678. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  28679. * @param onCompiled Callback triggered at the and of the effects compilation
  28680. * @param options Sets of optional options forcing the compilation with different modes
  28681. */
  28682. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  28683. useInstances: boolean;
  28684. }>): void;
  28685. /**
  28686. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  28687. * @param options Sets of optional options forcing the compilation with different modes
  28688. * @returns A promise that resolves when the compilation completes
  28689. */
  28690. forceCompilationAsync(options?: Partial<{
  28691. useInstances: boolean;
  28692. }>): Promise<void>;
  28693. /**
  28694. * Serializes the shadow generator setup to a json object.
  28695. * @returns The serialized JSON object
  28696. */
  28697. serialize(): any;
  28698. /**
  28699. * Disposes the Shadow map and related Textures and effects.
  28700. */
  28701. dispose(): void;
  28702. }
  28703. /**
  28704. * Default implementation IShadowGenerator.
  28705. * This is the main object responsible of generating shadows in the framework.
  28706. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  28707. */
  28708. export class ShadowGenerator implements IShadowGenerator {
  28709. /**
  28710. * Name of the shadow generator class
  28711. */
  28712. static CLASSNAME: string;
  28713. /**
  28714. * Shadow generator mode None: no filtering applied.
  28715. */
  28716. static readonly FILTER_NONE: number;
  28717. /**
  28718. * Shadow generator mode ESM: Exponential Shadow Mapping.
  28719. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  28720. */
  28721. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  28722. /**
  28723. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  28724. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  28725. */
  28726. static readonly FILTER_POISSONSAMPLING: number;
  28727. /**
  28728. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  28729. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  28730. */
  28731. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  28732. /**
  28733. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  28734. * edge artifacts on steep falloff.
  28735. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  28736. */
  28737. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  28738. /**
  28739. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  28740. * edge artifacts on steep falloff.
  28741. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  28742. */
  28743. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  28744. /**
  28745. * Shadow generator mode PCF: Percentage Closer Filtering
  28746. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  28747. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  28748. */
  28749. static readonly FILTER_PCF: number;
  28750. /**
  28751. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  28752. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  28753. * Contact Hardening
  28754. */
  28755. static readonly FILTER_PCSS: number;
  28756. /**
  28757. * Reserved for PCF and PCSS
  28758. * Highest Quality.
  28759. *
  28760. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  28761. *
  28762. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  28763. */
  28764. static readonly QUALITY_HIGH: number;
  28765. /**
  28766. * Reserved for PCF and PCSS
  28767. * Good tradeoff for quality/perf cross devices
  28768. *
  28769. * Execute PCF on a 3*3 kernel.
  28770. *
  28771. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  28772. */
  28773. static readonly QUALITY_MEDIUM: number;
  28774. /**
  28775. * Reserved for PCF and PCSS
  28776. * The lowest quality but the fastest.
  28777. *
  28778. * Execute PCF on a 1*1 kernel.
  28779. *
  28780. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  28781. */
  28782. static readonly QUALITY_LOW: number;
  28783. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  28784. id: string;
  28785. /** Gets or sets the custom shader name to use */
  28786. customShaderOptions: ICustomShaderOptions;
  28787. /**
  28788. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  28789. */
  28790. onBeforeShadowMapRenderObservable: Observable<Effect>;
  28791. /**
  28792. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  28793. */
  28794. onAfterShadowMapRenderObservable: Observable<Effect>;
  28795. /**
  28796. * Observable triggered before a mesh is rendered in the shadow map.
  28797. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  28798. */
  28799. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  28800. /**
  28801. * Observable triggered after a mesh is rendered in the shadow map.
  28802. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  28803. */
  28804. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  28805. protected _bias: number;
  28806. /**
  28807. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  28808. */
  28809. get bias(): number;
  28810. /**
  28811. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  28812. */
  28813. set bias(bias: number);
  28814. protected _normalBias: number;
  28815. /**
  28816. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  28817. */
  28818. get normalBias(): number;
  28819. /**
  28820. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  28821. */
  28822. set normalBias(normalBias: number);
  28823. protected _blurBoxOffset: number;
  28824. /**
  28825. * Gets the blur box offset: offset applied during the blur pass.
  28826. * Only useful if useKernelBlur = false
  28827. */
  28828. get blurBoxOffset(): number;
  28829. /**
  28830. * Sets the blur box offset: offset applied during the blur pass.
  28831. * Only useful if useKernelBlur = false
  28832. */
  28833. set blurBoxOffset(value: number);
  28834. protected _blurScale: number;
  28835. /**
  28836. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  28837. * 2 means half of the size.
  28838. */
  28839. get blurScale(): number;
  28840. /**
  28841. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  28842. * 2 means half of the size.
  28843. */
  28844. set blurScale(value: number);
  28845. protected _blurKernel: number;
  28846. /**
  28847. * Gets the blur kernel: kernel size of the blur pass.
  28848. * Only useful if useKernelBlur = true
  28849. */
  28850. get blurKernel(): number;
  28851. /**
  28852. * Sets the blur kernel: kernel size of the blur pass.
  28853. * Only useful if useKernelBlur = true
  28854. */
  28855. set blurKernel(value: number);
  28856. protected _useKernelBlur: boolean;
  28857. /**
  28858. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  28859. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  28860. */
  28861. get useKernelBlur(): boolean;
  28862. /**
  28863. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  28864. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  28865. */
  28866. set useKernelBlur(value: boolean);
  28867. protected _depthScale: number;
  28868. /**
  28869. * Gets the depth scale used in ESM mode.
  28870. */
  28871. get depthScale(): number;
  28872. /**
  28873. * Sets the depth scale used in ESM mode.
  28874. * This can override the scale stored on the light.
  28875. */
  28876. set depthScale(value: number);
  28877. protected _validateFilter(filter: number): number;
  28878. protected _filter: number;
  28879. /**
  28880. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  28881. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  28882. */
  28883. get filter(): number;
  28884. /**
  28885. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  28886. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  28887. */
  28888. set filter(value: number);
  28889. /**
  28890. * Gets if the current filter is set to Poisson Sampling.
  28891. */
  28892. get usePoissonSampling(): boolean;
  28893. /**
  28894. * Sets the current filter to Poisson Sampling.
  28895. */
  28896. set usePoissonSampling(value: boolean);
  28897. /**
  28898. * Gets if the current filter is set to ESM.
  28899. */
  28900. get useExponentialShadowMap(): boolean;
  28901. /**
  28902. * Sets the current filter is to ESM.
  28903. */
  28904. set useExponentialShadowMap(value: boolean);
  28905. /**
  28906. * Gets if the current filter is set to filtered ESM.
  28907. */
  28908. get useBlurExponentialShadowMap(): boolean;
  28909. /**
  28910. * Gets if the current filter is set to filtered ESM.
  28911. */
  28912. set useBlurExponentialShadowMap(value: boolean);
  28913. /**
  28914. * Gets if the current filter is set to "close ESM" (using the inverse of the
  28915. * exponential to prevent steep falloff artifacts).
  28916. */
  28917. get useCloseExponentialShadowMap(): boolean;
  28918. /**
  28919. * Sets the current filter to "close ESM" (using the inverse of the
  28920. * exponential to prevent steep falloff artifacts).
  28921. */
  28922. set useCloseExponentialShadowMap(value: boolean);
  28923. /**
  28924. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  28925. * exponential to prevent steep falloff artifacts).
  28926. */
  28927. get useBlurCloseExponentialShadowMap(): boolean;
  28928. /**
  28929. * Sets the current filter to filtered "close ESM" (using the inverse of the
  28930. * exponential to prevent steep falloff artifacts).
  28931. */
  28932. set useBlurCloseExponentialShadowMap(value: boolean);
  28933. /**
  28934. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  28935. */
  28936. get usePercentageCloserFiltering(): boolean;
  28937. /**
  28938. * Sets the current filter to "PCF" (percentage closer filtering).
  28939. */
  28940. set usePercentageCloserFiltering(value: boolean);
  28941. protected _filteringQuality: number;
  28942. /**
  28943. * Gets the PCF or PCSS Quality.
  28944. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  28945. */
  28946. get filteringQuality(): number;
  28947. /**
  28948. * Sets the PCF or PCSS Quality.
  28949. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  28950. */
  28951. set filteringQuality(filteringQuality: number);
  28952. /**
  28953. * Gets if the current filter is set to "PCSS" (contact hardening).
  28954. */
  28955. get useContactHardeningShadow(): boolean;
  28956. /**
  28957. * Sets the current filter to "PCSS" (contact hardening).
  28958. */
  28959. set useContactHardeningShadow(value: boolean);
  28960. protected _contactHardeningLightSizeUVRatio: number;
  28961. /**
  28962. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  28963. * Using a ratio helps keeping shape stability independently of the map size.
  28964. *
  28965. * It does not account for the light projection as it was having too much
  28966. * instability during the light setup or during light position changes.
  28967. *
  28968. * Only valid if useContactHardeningShadow is true.
  28969. */
  28970. get contactHardeningLightSizeUVRatio(): number;
  28971. /**
  28972. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  28973. * Using a ratio helps keeping shape stability independently of the map size.
  28974. *
  28975. * It does not account for the light projection as it was having too much
  28976. * instability during the light setup or during light position changes.
  28977. *
  28978. * Only valid if useContactHardeningShadow is true.
  28979. */
  28980. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  28981. protected _darkness: number;
  28982. /** Gets or sets the actual darkness of a shadow */
  28983. get darkness(): number;
  28984. set darkness(value: number);
  28985. /**
  28986. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  28987. * 0 means strongest and 1 would means no shadow.
  28988. * @returns the darkness.
  28989. */
  28990. getDarkness(): number;
  28991. /**
  28992. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  28993. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  28994. * @returns the shadow generator allowing fluent coding.
  28995. */
  28996. setDarkness(darkness: number): ShadowGenerator;
  28997. protected _transparencyShadow: boolean;
  28998. /** Gets or sets the ability to have transparent shadow */
  28999. get transparencyShadow(): boolean;
  29000. set transparencyShadow(value: boolean);
  29001. /**
  29002. * Sets the ability to have transparent shadow (boolean).
  29003. * @param transparent True if transparent else False
  29004. * @returns the shadow generator allowing fluent coding
  29005. */
  29006. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  29007. /**
  29008. * Enables or disables shadows with varying strength based on the transparency
  29009. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  29010. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  29011. * mesh.visibility * alphaTexture.a
  29012. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  29013. */
  29014. enableSoftTransparentShadow: boolean;
  29015. protected _shadowMap: Nullable<RenderTargetTexture>;
  29016. protected _shadowMap2: Nullable<RenderTargetTexture>;
  29017. /**
  29018. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  29019. * @returns The render target texture if present otherwise, null
  29020. */
  29021. getShadowMap(): Nullable<RenderTargetTexture>;
  29022. /**
  29023. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  29024. * @returns The render target texture if the shadow map is present otherwise, null
  29025. */
  29026. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  29027. /**
  29028. * Gets the class name of that object
  29029. * @returns "ShadowGenerator"
  29030. */
  29031. getClassName(): string;
  29032. /**
  29033. * Helper function to add a mesh and its descendants to the list of shadow casters.
  29034. * @param mesh Mesh to add
  29035. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  29036. * @returns the Shadow Generator itself
  29037. */
  29038. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  29039. /**
  29040. * Helper function to remove a mesh and its descendants from the list of shadow casters
  29041. * @param mesh Mesh to remove
  29042. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  29043. * @returns the Shadow Generator itself
  29044. */
  29045. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  29046. /**
  29047. * Controls the extent to which the shadows fade out at the edge of the frustum
  29048. */
  29049. frustumEdgeFalloff: number;
  29050. protected _light: IShadowLight;
  29051. /**
  29052. * Returns the associated light object.
  29053. * @returns the light generating the shadow
  29054. */
  29055. getLight(): IShadowLight;
  29056. /**
  29057. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  29058. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  29059. * It might on the other hand introduce peter panning.
  29060. */
  29061. forceBackFacesOnly: boolean;
  29062. protected _scene: Scene;
  29063. protected _lightDirection: Vector3;
  29064. protected _effect: Effect;
  29065. protected _viewMatrix: Matrix;
  29066. protected _projectionMatrix: Matrix;
  29067. protected _transformMatrix: Matrix;
  29068. protected _cachedPosition: Vector3;
  29069. protected _cachedDirection: Vector3;
  29070. protected _cachedDefines: string;
  29071. protected _currentRenderID: number;
  29072. protected _boxBlurPostprocess: Nullable<PostProcess>;
  29073. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  29074. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  29075. protected _blurPostProcesses: PostProcess[];
  29076. protected _mapSize: number;
  29077. protected _currentFaceIndex: number;
  29078. protected _currentFaceIndexCache: number;
  29079. protected _textureType: number;
  29080. protected _defaultTextureMatrix: Matrix;
  29081. protected _storedUniqueId: Nullable<number>;
  29082. /** @hidden */
  29083. static _SceneComponentInitialization: (scene: Scene) => void;
  29084. /**
  29085. * Gets or sets the size of the texture what stores the shadows
  29086. */
  29087. get mapSize(): number;
  29088. set mapSize(size: number);
  29089. /**
  29090. * Creates a ShadowGenerator object.
  29091. * A ShadowGenerator is the required tool to use the shadows.
  29092. * Each light casting shadows needs to use its own ShadowGenerator.
  29093. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  29094. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  29095. * @param light The light object generating the shadows.
  29096. * @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.
  29097. */
  29098. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  29099. protected _initializeGenerator(): void;
  29100. protected _createTargetRenderTexture(): void;
  29101. protected _initializeShadowMap(): void;
  29102. protected _initializeBlurRTTAndPostProcesses(): void;
  29103. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  29104. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  29105. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  29106. protected _applyFilterValues(): void;
  29107. /**
  29108. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  29109. * @param onCompiled Callback triggered at the and of the effects compilation
  29110. * @param options Sets of optional options forcing the compilation with different modes
  29111. */
  29112. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  29113. useInstances: boolean;
  29114. }>): void;
  29115. /**
  29116. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  29117. * @param options Sets of optional options forcing the compilation with different modes
  29118. * @returns A promise that resolves when the compilation completes
  29119. */
  29120. forceCompilationAsync(options?: Partial<{
  29121. useInstances: boolean;
  29122. }>): Promise<void>;
  29123. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  29124. private _prepareShadowDefines;
  29125. /**
  29126. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  29127. * @param subMesh The submesh we want to render in the shadow map
  29128. * @param useInstances Defines wether will draw in the map using instances
  29129. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  29130. * @returns true if ready otherwise, false
  29131. */
  29132. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  29133. /**
  29134. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  29135. * @param defines Defines of the material we want to update
  29136. * @param lightIndex Index of the light in the enabled light list of the material
  29137. */
  29138. prepareDefines(defines: any, lightIndex: number): void;
  29139. /**
  29140. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  29141. * defined in the generator but impacting the effect).
  29142. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  29143. * @param effect The effect we are binfing the information for
  29144. */
  29145. bindShadowLight(lightIndex: string, effect: Effect): void;
  29146. /**
  29147. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  29148. * (eq to shadow prjection matrix * light transform matrix)
  29149. * @returns The transform matrix used to create the shadow map
  29150. */
  29151. getTransformMatrix(): Matrix;
  29152. /**
  29153. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  29154. * Cube and 2D textures for instance.
  29155. */
  29156. recreateShadowMap(): void;
  29157. protected _disposeBlurPostProcesses(): void;
  29158. protected _disposeRTTandPostProcesses(): void;
  29159. /**
  29160. * Disposes the ShadowGenerator.
  29161. * Returns nothing.
  29162. */
  29163. dispose(): void;
  29164. /**
  29165. * Serializes the shadow generator setup to a json object.
  29166. * @returns The serialized JSON object
  29167. */
  29168. serialize(): any;
  29169. /**
  29170. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  29171. * @param parsedShadowGenerator The JSON object to parse
  29172. * @param scene The scene to create the shadow map for
  29173. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  29174. * @returns The parsed shadow generator
  29175. */
  29176. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  29177. }
  29178. }
  29179. declare module BABYLON {
  29180. /**
  29181. * Options to be used when creating a shadow depth material
  29182. */
  29183. export interface IIOptionShadowDepthMaterial {
  29184. /** Variables in the vertex shader code that need to have their names remapped.
  29185. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  29186. * "var_name" should be either: worldPos or vNormalW
  29187. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  29188. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  29189. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  29190. */
  29191. remappedVariables?: string[];
  29192. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  29193. standalone?: boolean;
  29194. }
  29195. /**
  29196. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  29197. */
  29198. export class ShadowDepthWrapper {
  29199. private _scene;
  29200. private _options?;
  29201. private _baseMaterial;
  29202. private _onEffectCreatedObserver;
  29203. private _subMeshToEffect;
  29204. private _subMeshToDepthEffect;
  29205. private _meshes;
  29206. /** @hidden */
  29207. _matriceNames: any;
  29208. /** Gets the standalone status of the wrapper */
  29209. get standalone(): boolean;
  29210. /** Gets the base material the wrapper is built upon */
  29211. get baseMaterial(): Material;
  29212. /**
  29213. * Instantiate a new shadow depth wrapper.
  29214. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  29215. * generate the shadow depth map. For more information, please refer to the documentation:
  29216. * https://doc.babylonjs.com/babylon101/shadows
  29217. * @param baseMaterial Material to wrap
  29218. * @param scene Define the scene the material belongs to
  29219. * @param options Options used to create the wrapper
  29220. */
  29221. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  29222. /**
  29223. * Gets the effect to use to generate the depth map
  29224. * @param subMesh subMesh to get the effect for
  29225. * @param shadowGenerator shadow generator to get the effect for
  29226. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  29227. */
  29228. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  29229. /**
  29230. * Specifies that the submesh is ready to be used for depth rendering
  29231. * @param subMesh submesh to check
  29232. * @param defines the list of defines to take into account when checking the effect
  29233. * @param shadowGenerator combined with subMesh, it defines the effect to check
  29234. * @param useInstances specifies that instances should be used
  29235. * @returns a boolean indicating that the submesh is ready or not
  29236. */
  29237. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  29238. /**
  29239. * Disposes the resources
  29240. */
  29241. dispose(): void;
  29242. private _makeEffect;
  29243. }
  29244. }
  29245. declare module BABYLON {
  29246. /**
  29247. * Options for compiling materials.
  29248. */
  29249. export interface IMaterialCompilationOptions {
  29250. /**
  29251. * Defines whether clip planes are enabled.
  29252. */
  29253. clipPlane: boolean;
  29254. /**
  29255. * Defines whether instances are enabled.
  29256. */
  29257. useInstances: boolean;
  29258. }
  29259. /**
  29260. * Options passed when calling customShaderNameResolve
  29261. */
  29262. export interface ICustomShaderNameResolveOptions {
  29263. /**
  29264. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  29265. */
  29266. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  29267. }
  29268. /**
  29269. * Base class for the main features of a material in Babylon.js
  29270. */
  29271. export class Material implements IAnimatable {
  29272. /**
  29273. * Returns the triangle fill mode
  29274. */
  29275. static readonly TriangleFillMode: number;
  29276. /**
  29277. * Returns the wireframe mode
  29278. */
  29279. static readonly WireFrameFillMode: number;
  29280. /**
  29281. * Returns the point fill mode
  29282. */
  29283. static readonly PointFillMode: number;
  29284. /**
  29285. * Returns the point list draw mode
  29286. */
  29287. static readonly PointListDrawMode: number;
  29288. /**
  29289. * Returns the line list draw mode
  29290. */
  29291. static readonly LineListDrawMode: number;
  29292. /**
  29293. * Returns the line loop draw mode
  29294. */
  29295. static readonly LineLoopDrawMode: number;
  29296. /**
  29297. * Returns the line strip draw mode
  29298. */
  29299. static readonly LineStripDrawMode: number;
  29300. /**
  29301. * Returns the triangle strip draw mode
  29302. */
  29303. static readonly TriangleStripDrawMode: number;
  29304. /**
  29305. * Returns the triangle fan draw mode
  29306. */
  29307. static readonly TriangleFanDrawMode: number;
  29308. /**
  29309. * Stores the clock-wise side orientation
  29310. */
  29311. static readonly ClockWiseSideOrientation: number;
  29312. /**
  29313. * Stores the counter clock-wise side orientation
  29314. */
  29315. static readonly CounterClockWiseSideOrientation: number;
  29316. /**
  29317. * The dirty texture flag value
  29318. */
  29319. static readonly TextureDirtyFlag: number;
  29320. /**
  29321. * The dirty light flag value
  29322. */
  29323. static readonly LightDirtyFlag: number;
  29324. /**
  29325. * The dirty fresnel flag value
  29326. */
  29327. static readonly FresnelDirtyFlag: number;
  29328. /**
  29329. * The dirty attribute flag value
  29330. */
  29331. static readonly AttributesDirtyFlag: number;
  29332. /**
  29333. * The dirty misc flag value
  29334. */
  29335. static readonly MiscDirtyFlag: number;
  29336. /**
  29337. * The dirty prepass flag value
  29338. */
  29339. static readonly PrePassDirtyFlag: number;
  29340. /**
  29341. * The all dirty flag value
  29342. */
  29343. static readonly AllDirtyFlag: number;
  29344. /**
  29345. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  29346. */
  29347. static readonly MATERIAL_OPAQUE: number;
  29348. /**
  29349. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  29350. */
  29351. static readonly MATERIAL_ALPHATEST: number;
  29352. /**
  29353. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  29354. */
  29355. static readonly MATERIAL_ALPHABLEND: number;
  29356. /**
  29357. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  29358. * They are also discarded below the alpha cutoff threshold to improve performances.
  29359. */
  29360. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  29361. /**
  29362. * The Whiteout method is used to blend normals.
  29363. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  29364. */
  29365. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  29366. /**
  29367. * The Reoriented Normal Mapping method is used to blend normals.
  29368. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  29369. */
  29370. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  29371. /**
  29372. * Custom callback helping to override the default shader used in the material.
  29373. */
  29374. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  29375. /**
  29376. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  29377. */
  29378. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  29379. /**
  29380. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  29381. * This means that the material can keep using a previous shader while a new one is being compiled.
  29382. * This is mostly used when shader parallel compilation is supported (true by default)
  29383. */
  29384. allowShaderHotSwapping: boolean;
  29385. /**
  29386. * The ID of the material
  29387. */
  29388. id: string;
  29389. /**
  29390. * Gets or sets the unique id of the material
  29391. */
  29392. uniqueId: number;
  29393. /**
  29394. * The name of the material
  29395. */
  29396. name: string;
  29397. /**
  29398. * Gets or sets user defined metadata
  29399. */
  29400. metadata: any;
  29401. /**
  29402. * For internal use only. Please do not use.
  29403. */
  29404. reservedDataStore: any;
  29405. /**
  29406. * Specifies if the ready state should be checked on each call
  29407. */
  29408. checkReadyOnEveryCall: boolean;
  29409. /**
  29410. * Specifies if the ready state should be checked once
  29411. */
  29412. checkReadyOnlyOnce: boolean;
  29413. /**
  29414. * The state of the material
  29415. */
  29416. state: string;
  29417. /**
  29418. * If the material can be rendered to several textures with MRT extension
  29419. */
  29420. get canRenderToMRT(): boolean;
  29421. /**
  29422. * The alpha value of the material
  29423. */
  29424. protected _alpha: number;
  29425. /**
  29426. * List of inspectable custom properties (used by the Inspector)
  29427. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  29428. */
  29429. inspectableCustomProperties: IInspectable[];
  29430. /**
  29431. * Sets the alpha value of the material
  29432. */
  29433. set alpha(value: number);
  29434. /**
  29435. * Gets the alpha value of the material
  29436. */
  29437. get alpha(): number;
  29438. /**
  29439. * Specifies if back face culling is enabled
  29440. */
  29441. protected _backFaceCulling: boolean;
  29442. /**
  29443. * Sets the back-face culling state
  29444. */
  29445. set backFaceCulling(value: boolean);
  29446. /**
  29447. * Gets the back-face culling state
  29448. */
  29449. get backFaceCulling(): boolean;
  29450. /**
  29451. * Stores the value for side orientation
  29452. */
  29453. sideOrientation: number;
  29454. /**
  29455. * Callback triggered when the material is compiled
  29456. */
  29457. onCompiled: Nullable<(effect: Effect) => void>;
  29458. /**
  29459. * Callback triggered when an error occurs
  29460. */
  29461. onError: Nullable<(effect: Effect, errors: string) => void>;
  29462. /**
  29463. * Callback triggered to get the render target textures
  29464. */
  29465. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  29466. /**
  29467. * Gets a boolean indicating that current material needs to register RTT
  29468. */
  29469. get hasRenderTargetTextures(): boolean;
  29470. /**
  29471. * Specifies if the material should be serialized
  29472. */
  29473. doNotSerialize: boolean;
  29474. /**
  29475. * @hidden
  29476. */
  29477. _storeEffectOnSubMeshes: boolean;
  29478. /**
  29479. * Stores the animations for the material
  29480. */
  29481. animations: Nullable<Array<Animation>>;
  29482. /**
  29483. * An event triggered when the material is disposed
  29484. */
  29485. onDisposeObservable: Observable<Material>;
  29486. /**
  29487. * An observer which watches for dispose events
  29488. */
  29489. private _onDisposeObserver;
  29490. private _onUnBindObservable;
  29491. /**
  29492. * Called during a dispose event
  29493. */
  29494. set onDispose(callback: () => void);
  29495. private _onBindObservable;
  29496. /**
  29497. * An event triggered when the material is bound
  29498. */
  29499. get onBindObservable(): Observable<AbstractMesh>;
  29500. /**
  29501. * An observer which watches for bind events
  29502. */
  29503. private _onBindObserver;
  29504. /**
  29505. * Called during a bind event
  29506. */
  29507. set onBind(callback: (Mesh: AbstractMesh) => void);
  29508. /**
  29509. * An event triggered when the material is unbound
  29510. */
  29511. get onUnBindObservable(): Observable<Material>;
  29512. protected _onEffectCreatedObservable: Nullable<Observable<{
  29513. effect: Effect;
  29514. subMesh: Nullable<SubMesh>;
  29515. }>>;
  29516. /**
  29517. * An event triggered when the effect is (re)created
  29518. */
  29519. get onEffectCreatedObservable(): Observable<{
  29520. effect: Effect;
  29521. subMesh: Nullable<SubMesh>;
  29522. }>;
  29523. /**
  29524. * Stores the value of the alpha mode
  29525. */
  29526. private _alphaMode;
  29527. /**
  29528. * Sets the value of the alpha mode.
  29529. *
  29530. * | Value | Type | Description |
  29531. * | --- | --- | --- |
  29532. * | 0 | ALPHA_DISABLE | |
  29533. * | 1 | ALPHA_ADD | |
  29534. * | 2 | ALPHA_COMBINE | |
  29535. * | 3 | ALPHA_SUBTRACT | |
  29536. * | 4 | ALPHA_MULTIPLY | |
  29537. * | 5 | ALPHA_MAXIMIZED | |
  29538. * | 6 | ALPHA_ONEONE | |
  29539. * | 7 | ALPHA_PREMULTIPLIED | |
  29540. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  29541. * | 9 | ALPHA_INTERPOLATE | |
  29542. * | 10 | ALPHA_SCREENMODE | |
  29543. *
  29544. */
  29545. set alphaMode(value: number);
  29546. /**
  29547. * Gets the value of the alpha mode
  29548. */
  29549. get alphaMode(): number;
  29550. /**
  29551. * Stores the state of the need depth pre-pass value
  29552. */
  29553. private _needDepthPrePass;
  29554. /**
  29555. * Sets the need depth pre-pass value
  29556. */
  29557. set needDepthPrePass(value: boolean);
  29558. /**
  29559. * Gets the depth pre-pass value
  29560. */
  29561. get needDepthPrePass(): boolean;
  29562. /**
  29563. * Specifies if depth writing should be disabled
  29564. */
  29565. disableDepthWrite: boolean;
  29566. /**
  29567. * Specifies if color writing should be disabled
  29568. */
  29569. disableColorWrite: boolean;
  29570. /**
  29571. * Specifies if depth writing should be forced
  29572. */
  29573. forceDepthWrite: boolean;
  29574. /**
  29575. * Specifies the depth function that should be used. 0 means the default engine function
  29576. */
  29577. depthFunction: number;
  29578. /**
  29579. * Specifies if there should be a separate pass for culling
  29580. */
  29581. separateCullingPass: boolean;
  29582. /**
  29583. * Stores the state specifing if fog should be enabled
  29584. */
  29585. private _fogEnabled;
  29586. /**
  29587. * Sets the state for enabling fog
  29588. */
  29589. set fogEnabled(value: boolean);
  29590. /**
  29591. * Gets the value of the fog enabled state
  29592. */
  29593. get fogEnabled(): boolean;
  29594. /**
  29595. * Stores the size of points
  29596. */
  29597. pointSize: number;
  29598. /**
  29599. * Stores the z offset value
  29600. */
  29601. zOffset: number;
  29602. get wireframe(): boolean;
  29603. /**
  29604. * Sets the state of wireframe mode
  29605. */
  29606. set wireframe(value: boolean);
  29607. /**
  29608. * Gets the value specifying if point clouds are enabled
  29609. */
  29610. get pointsCloud(): boolean;
  29611. /**
  29612. * Sets the state of point cloud mode
  29613. */
  29614. set pointsCloud(value: boolean);
  29615. /**
  29616. * Gets the material fill mode
  29617. */
  29618. get fillMode(): number;
  29619. /**
  29620. * Sets the material fill mode
  29621. */
  29622. set fillMode(value: number);
  29623. /**
  29624. * @hidden
  29625. * Stores the effects for the material
  29626. */
  29627. _effect: Nullable<Effect>;
  29628. /**
  29629. * Specifies if uniform buffers should be used
  29630. */
  29631. private _useUBO;
  29632. /**
  29633. * Stores a reference to the scene
  29634. */
  29635. private _scene;
  29636. /**
  29637. * Stores the fill mode state
  29638. */
  29639. private _fillMode;
  29640. /**
  29641. * Specifies if the depth write state should be cached
  29642. */
  29643. private _cachedDepthWriteState;
  29644. /**
  29645. * Specifies if the color write state should be cached
  29646. */
  29647. private _cachedColorWriteState;
  29648. /**
  29649. * Specifies if the depth function state should be cached
  29650. */
  29651. private _cachedDepthFunctionState;
  29652. /**
  29653. * Stores the uniform buffer
  29654. */
  29655. protected _uniformBuffer: UniformBuffer;
  29656. /** @hidden */
  29657. _indexInSceneMaterialArray: number;
  29658. /** @hidden */
  29659. meshMap: Nullable<{
  29660. [id: string]: AbstractMesh | undefined;
  29661. }>;
  29662. /**
  29663. * Creates a material instance
  29664. * @param name defines the name of the material
  29665. * @param scene defines the scene to reference
  29666. * @param doNotAdd specifies if the material should be added to the scene
  29667. */
  29668. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  29669. /**
  29670. * Returns a string representation of the current material
  29671. * @param fullDetails defines a boolean indicating which levels of logging is desired
  29672. * @returns a string with material information
  29673. */
  29674. toString(fullDetails?: boolean): string;
  29675. /**
  29676. * Gets the class name of the material
  29677. * @returns a string with the class name of the material
  29678. */
  29679. getClassName(): string;
  29680. /**
  29681. * Specifies if updates for the material been locked
  29682. */
  29683. get isFrozen(): boolean;
  29684. /**
  29685. * Locks updates for the material
  29686. */
  29687. freeze(): void;
  29688. /**
  29689. * Unlocks updates for the material
  29690. */
  29691. unfreeze(): void;
  29692. /**
  29693. * Specifies if the material is ready to be used
  29694. * @param mesh defines the mesh to check
  29695. * @param useInstances specifies if instances should be used
  29696. * @returns a boolean indicating if the material is ready to be used
  29697. */
  29698. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  29699. /**
  29700. * Specifies that the submesh is ready to be used
  29701. * @param mesh defines the mesh to check
  29702. * @param subMesh defines which submesh to check
  29703. * @param useInstances specifies that instances should be used
  29704. * @returns a boolean indicating that the submesh is ready or not
  29705. */
  29706. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  29707. /**
  29708. * Returns the material effect
  29709. * @returns the effect associated with the material
  29710. */
  29711. getEffect(): Nullable<Effect>;
  29712. /**
  29713. * Returns the current scene
  29714. * @returns a Scene
  29715. */
  29716. getScene(): Scene;
  29717. /**
  29718. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  29719. */
  29720. protected _forceAlphaTest: boolean;
  29721. /**
  29722. * The transparency mode of the material.
  29723. */
  29724. protected _transparencyMode: Nullable<number>;
  29725. /**
  29726. * Gets the current transparency mode.
  29727. */
  29728. get transparencyMode(): Nullable<number>;
  29729. /**
  29730. * Sets the transparency mode of the material.
  29731. *
  29732. * | Value | Type | Description |
  29733. * | ----- | ----------------------------------- | ----------- |
  29734. * | 0 | OPAQUE | |
  29735. * | 1 | ALPHATEST | |
  29736. * | 2 | ALPHABLEND | |
  29737. * | 3 | ALPHATESTANDBLEND | |
  29738. *
  29739. */
  29740. set transparencyMode(value: Nullable<number>);
  29741. /**
  29742. * Returns true if alpha blending should be disabled.
  29743. */
  29744. protected get _disableAlphaBlending(): boolean;
  29745. /**
  29746. * Specifies whether or not this material should be rendered in alpha blend mode.
  29747. * @returns a boolean specifying if alpha blending is needed
  29748. */
  29749. needAlphaBlending(): boolean;
  29750. /**
  29751. * Specifies if the mesh will require alpha blending
  29752. * @param mesh defines the mesh to check
  29753. * @returns a boolean specifying if alpha blending is needed for the mesh
  29754. */
  29755. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  29756. /**
  29757. * Specifies whether or not this material should be rendered in alpha test mode.
  29758. * @returns a boolean specifying if an alpha test is needed.
  29759. */
  29760. needAlphaTesting(): boolean;
  29761. /**
  29762. * Specifies if material alpha testing should be turned on for the mesh
  29763. * @param mesh defines the mesh to check
  29764. */
  29765. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  29766. /**
  29767. * Gets the texture used for the alpha test
  29768. * @returns the texture to use for alpha testing
  29769. */
  29770. getAlphaTestTexture(): Nullable<BaseTexture>;
  29771. /**
  29772. * Marks the material to indicate that it needs to be re-calculated
  29773. */
  29774. markDirty(): void;
  29775. /** @hidden */
  29776. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  29777. /**
  29778. * Binds the material to the mesh
  29779. * @param world defines the world transformation matrix
  29780. * @param mesh defines the mesh to bind the material to
  29781. */
  29782. bind(world: Matrix, mesh?: Mesh): void;
  29783. /**
  29784. * Binds the submesh to the material
  29785. * @param world defines the world transformation matrix
  29786. * @param mesh defines the mesh containing the submesh
  29787. * @param subMesh defines the submesh to bind the material to
  29788. */
  29789. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  29790. /**
  29791. * Binds the world matrix to the material
  29792. * @param world defines the world transformation matrix
  29793. */
  29794. bindOnlyWorldMatrix(world: Matrix): void;
  29795. /**
  29796. * Binds the scene's uniform buffer to the effect.
  29797. * @param effect defines the effect to bind to the scene uniform buffer
  29798. * @param sceneUbo defines the uniform buffer storing scene data
  29799. */
  29800. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  29801. /**
  29802. * Binds the view matrix to the effect
  29803. * @param effect defines the effect to bind the view matrix to
  29804. */
  29805. bindView(effect: Effect): void;
  29806. /**
  29807. * Binds the view projection matrix to the effect
  29808. * @param effect defines the effect to bind the view projection matrix to
  29809. */
  29810. bindViewProjection(effect: Effect): void;
  29811. /**
  29812. * Processes to execute after binding the material to a mesh
  29813. * @param mesh defines the rendered mesh
  29814. */
  29815. protected _afterBind(mesh?: Mesh): void;
  29816. /**
  29817. * Unbinds the material from the mesh
  29818. */
  29819. unbind(): void;
  29820. /**
  29821. * Gets the active textures from the material
  29822. * @returns an array of textures
  29823. */
  29824. getActiveTextures(): BaseTexture[];
  29825. /**
  29826. * Specifies if the material uses a texture
  29827. * @param texture defines the texture to check against the material
  29828. * @returns a boolean specifying if the material uses the texture
  29829. */
  29830. hasTexture(texture: BaseTexture): boolean;
  29831. /**
  29832. * Makes a duplicate of the material, and gives it a new name
  29833. * @param name defines the new name for the duplicated material
  29834. * @returns the cloned material
  29835. */
  29836. clone(name: string): Nullable<Material>;
  29837. /**
  29838. * Gets the meshes bound to the material
  29839. * @returns an array of meshes bound to the material
  29840. */
  29841. getBindedMeshes(): AbstractMesh[];
  29842. /**
  29843. * Force shader compilation
  29844. * @param mesh defines the mesh associated with this material
  29845. * @param onCompiled defines a function to execute once the material is compiled
  29846. * @param options defines the options to configure the compilation
  29847. * @param onError defines a function to execute if the material fails compiling
  29848. */
  29849. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  29850. /**
  29851. * Force shader compilation
  29852. * @param mesh defines the mesh that will use this material
  29853. * @param options defines additional options for compiling the shaders
  29854. * @returns a promise that resolves when the compilation completes
  29855. */
  29856. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  29857. private static readonly _AllDirtyCallBack;
  29858. private static readonly _ImageProcessingDirtyCallBack;
  29859. private static readonly _TextureDirtyCallBack;
  29860. private static readonly _FresnelDirtyCallBack;
  29861. private static readonly _MiscDirtyCallBack;
  29862. private static readonly _PrePassDirtyCallBack;
  29863. private static readonly _LightsDirtyCallBack;
  29864. private static readonly _AttributeDirtyCallBack;
  29865. private static _FresnelAndMiscDirtyCallBack;
  29866. private static _TextureAndMiscDirtyCallBack;
  29867. private static readonly _DirtyCallbackArray;
  29868. private static readonly _RunDirtyCallBacks;
  29869. /**
  29870. * Marks a define in the material to indicate that it needs to be re-computed
  29871. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  29872. */
  29873. markAsDirty(flag: number): void;
  29874. /**
  29875. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  29876. * @param func defines a function which checks material defines against the submeshes
  29877. */
  29878. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  29879. /**
  29880. * Indicates that the scene should check if the rendering now needs a prepass
  29881. */
  29882. protected _markScenePrePassDirty(): void;
  29883. /**
  29884. * Indicates that we need to re-calculated for all submeshes
  29885. */
  29886. protected _markAllSubMeshesAsAllDirty(): void;
  29887. /**
  29888. * Indicates that image processing needs to be re-calculated for all submeshes
  29889. */
  29890. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  29891. /**
  29892. * Indicates that textures need to be re-calculated for all submeshes
  29893. */
  29894. protected _markAllSubMeshesAsTexturesDirty(): void;
  29895. /**
  29896. * Indicates that fresnel needs to be re-calculated for all submeshes
  29897. */
  29898. protected _markAllSubMeshesAsFresnelDirty(): void;
  29899. /**
  29900. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  29901. */
  29902. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  29903. /**
  29904. * Indicates that lights need to be re-calculated for all submeshes
  29905. */
  29906. protected _markAllSubMeshesAsLightsDirty(): void;
  29907. /**
  29908. * Indicates that attributes need to be re-calculated for all submeshes
  29909. */
  29910. protected _markAllSubMeshesAsAttributesDirty(): void;
  29911. /**
  29912. * Indicates that misc needs to be re-calculated for all submeshes
  29913. */
  29914. protected _markAllSubMeshesAsMiscDirty(): void;
  29915. /**
  29916. * Indicates that prepass needs to be re-calculated for all submeshes
  29917. */
  29918. protected _markAllSubMeshesAsPrePassDirty(): void;
  29919. /**
  29920. * Indicates that textures and misc need to be re-calculated for all submeshes
  29921. */
  29922. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  29923. /**
  29924. * Sets the required values to the prepass renderer.
  29925. * @param prePassRenderer defines the prepass renderer to setup.
  29926. * @returns true if the pre pass is needed.
  29927. */
  29928. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  29929. /**
  29930. * Disposes the material
  29931. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  29932. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  29933. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  29934. */
  29935. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  29936. /** @hidden */
  29937. private releaseVertexArrayObject;
  29938. /**
  29939. * Serializes this material
  29940. * @returns the serialized material object
  29941. */
  29942. serialize(): any;
  29943. /**
  29944. * Creates a material from parsed material data
  29945. * @param parsedMaterial defines parsed material data
  29946. * @param scene defines the hosting scene
  29947. * @param rootUrl defines the root URL to use to load textures
  29948. * @returns a new material
  29949. */
  29950. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  29951. }
  29952. }
  29953. declare module BABYLON {
  29954. /**
  29955. * A multi-material is used to apply different materials to different parts of the same object without the need of
  29956. * separate meshes. This can be use to improve performances.
  29957. * @see https://doc.babylonjs.com/how_to/multi_materials
  29958. */
  29959. export class MultiMaterial extends Material {
  29960. private _subMaterials;
  29961. /**
  29962. * Gets or Sets the list of Materials used within the multi material.
  29963. * They need to be ordered according to the submeshes order in the associated mesh
  29964. */
  29965. get subMaterials(): Nullable<Material>[];
  29966. set subMaterials(value: Nullable<Material>[]);
  29967. /**
  29968. * Function used to align with Node.getChildren()
  29969. * @returns the list of Materials used within the multi material
  29970. */
  29971. getChildren(): Nullable<Material>[];
  29972. /**
  29973. * Instantiates a new Multi Material
  29974. * A multi-material is used to apply different materials to different parts of the same object without the need of
  29975. * separate meshes. This can be use to improve performances.
  29976. * @see https://doc.babylonjs.com/how_to/multi_materials
  29977. * @param name Define the name in the scene
  29978. * @param scene Define the scene the material belongs to
  29979. */
  29980. constructor(name: string, scene: Scene);
  29981. private _hookArray;
  29982. /**
  29983. * Get one of the submaterial by its index in the submaterials array
  29984. * @param index The index to look the sub material at
  29985. * @returns The Material if the index has been defined
  29986. */
  29987. getSubMaterial(index: number): Nullable<Material>;
  29988. /**
  29989. * Get the list of active textures for the whole sub materials list.
  29990. * @returns All the textures that will be used during the rendering
  29991. */
  29992. getActiveTextures(): BaseTexture[];
  29993. /**
  29994. * Gets the current class name of the material e.g. "MultiMaterial"
  29995. * Mainly use in serialization.
  29996. * @returns the class name
  29997. */
  29998. getClassName(): string;
  29999. /**
  30000. * Checks if the material is ready to render the requested sub mesh
  30001. * @param mesh Define the mesh the submesh belongs to
  30002. * @param subMesh Define the sub mesh to look readyness for
  30003. * @param useInstances Define whether or not the material is used with instances
  30004. * @returns true if ready, otherwise false
  30005. */
  30006. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  30007. /**
  30008. * Clones the current material and its related sub materials
  30009. * @param name Define the name of the newly cloned material
  30010. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  30011. * @returns the cloned material
  30012. */
  30013. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  30014. /**
  30015. * Serializes the materials into a JSON representation.
  30016. * @returns the JSON representation
  30017. */
  30018. serialize(): any;
  30019. /**
  30020. * Dispose the material and release its associated resources
  30021. * @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)
  30022. * @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)
  30023. * @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)
  30024. */
  30025. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  30026. /**
  30027. * Creates a MultiMaterial from parsed MultiMaterial data.
  30028. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  30029. * @param scene defines the hosting scene
  30030. * @returns a new MultiMaterial
  30031. */
  30032. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  30033. }
  30034. }
  30035. declare module BABYLON {
  30036. /**
  30037. * Defines a subdivision inside a mesh
  30038. */
  30039. export class SubMesh implements ICullable {
  30040. /** the material index to use */
  30041. materialIndex: number;
  30042. /** vertex index start */
  30043. verticesStart: number;
  30044. /** vertices count */
  30045. verticesCount: number;
  30046. /** index start */
  30047. indexStart: number;
  30048. /** indices count */
  30049. indexCount: number;
  30050. /** @hidden */
  30051. _materialDefines: Nullable<MaterialDefines>;
  30052. /** @hidden */
  30053. _materialEffect: Nullable<Effect>;
  30054. /** @hidden */
  30055. _effectOverride: Nullable<Effect>;
  30056. /**
  30057. * Gets material defines used by the effect associated to the sub mesh
  30058. */
  30059. get materialDefines(): Nullable<MaterialDefines>;
  30060. /**
  30061. * Sets material defines used by the effect associated to the sub mesh
  30062. */
  30063. set materialDefines(defines: Nullable<MaterialDefines>);
  30064. /**
  30065. * Gets associated effect
  30066. */
  30067. get effect(): Nullable<Effect>;
  30068. /**
  30069. * Sets associated effect (effect used to render this submesh)
  30070. * @param effect defines the effect to associate with
  30071. * @param defines defines the set of defines used to compile this effect
  30072. */
  30073. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  30074. /** @hidden */
  30075. _linesIndexCount: number;
  30076. private _mesh;
  30077. private _renderingMesh;
  30078. private _boundingInfo;
  30079. private _linesIndexBuffer;
  30080. /** @hidden */
  30081. _lastColliderWorldVertices: Nullable<Vector3[]>;
  30082. /** @hidden */
  30083. _trianglePlanes: Plane[];
  30084. /** @hidden */
  30085. _lastColliderTransformMatrix: Nullable<Matrix>;
  30086. /** @hidden */
  30087. _renderId: number;
  30088. /** @hidden */
  30089. _alphaIndex: number;
  30090. /** @hidden */
  30091. _distanceToCamera: number;
  30092. /** @hidden */
  30093. _id: number;
  30094. private _currentMaterial;
  30095. /**
  30096. * Add a new submesh to a mesh
  30097. * @param materialIndex defines the material index to use
  30098. * @param verticesStart defines vertex index start
  30099. * @param verticesCount defines vertices count
  30100. * @param indexStart defines index start
  30101. * @param indexCount defines indices count
  30102. * @param mesh defines the parent mesh
  30103. * @param renderingMesh defines an optional rendering mesh
  30104. * @param createBoundingBox defines if bounding box should be created for this submesh
  30105. * @returns the new submesh
  30106. */
  30107. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  30108. /**
  30109. * Creates a new submesh
  30110. * @param materialIndex defines the material index to use
  30111. * @param verticesStart defines vertex index start
  30112. * @param verticesCount defines vertices count
  30113. * @param indexStart defines index start
  30114. * @param indexCount defines indices count
  30115. * @param mesh defines the parent mesh
  30116. * @param renderingMesh defines an optional rendering mesh
  30117. * @param createBoundingBox defines if bounding box should be created for this submesh
  30118. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  30119. */
  30120. constructor(
  30121. /** the material index to use */
  30122. materialIndex: number,
  30123. /** vertex index start */
  30124. verticesStart: number,
  30125. /** vertices count */
  30126. verticesCount: number,
  30127. /** index start */
  30128. indexStart: number,
  30129. /** indices count */
  30130. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  30131. /**
  30132. * Returns true if this submesh covers the entire parent mesh
  30133. * @ignorenaming
  30134. */
  30135. get IsGlobal(): boolean;
  30136. /**
  30137. * Returns the submesh BoudingInfo object
  30138. * @returns current bounding info (or mesh's one if the submesh is global)
  30139. */
  30140. getBoundingInfo(): BoundingInfo;
  30141. /**
  30142. * Sets the submesh BoundingInfo
  30143. * @param boundingInfo defines the new bounding info to use
  30144. * @returns the SubMesh
  30145. */
  30146. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  30147. /**
  30148. * Returns the mesh of the current submesh
  30149. * @return the parent mesh
  30150. */
  30151. getMesh(): AbstractMesh;
  30152. /**
  30153. * Returns the rendering mesh of the submesh
  30154. * @returns the rendering mesh (could be different from parent mesh)
  30155. */
  30156. getRenderingMesh(): Mesh;
  30157. /**
  30158. * Returns the replacement mesh of the submesh
  30159. * @returns the replacement mesh (could be different from parent mesh)
  30160. */
  30161. getReplacementMesh(): Nullable<AbstractMesh>;
  30162. /**
  30163. * Returns the effective mesh of the submesh
  30164. * @returns the effective mesh (could be different from parent mesh)
  30165. */
  30166. getEffectiveMesh(): AbstractMesh;
  30167. /**
  30168. * Returns the submesh material
  30169. * @returns null or the current material
  30170. */
  30171. getMaterial(): Nullable<Material>;
  30172. private _IsMultiMaterial;
  30173. /**
  30174. * Sets a new updated BoundingInfo object to the submesh
  30175. * @param data defines an optional position array to use to determine the bounding info
  30176. * @returns the SubMesh
  30177. */
  30178. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  30179. /** @hidden */
  30180. _checkCollision(collider: Collider): boolean;
  30181. /**
  30182. * Updates the submesh BoundingInfo
  30183. * @param world defines the world matrix to use to update the bounding info
  30184. * @returns the submesh
  30185. */
  30186. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  30187. /**
  30188. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  30189. * @param frustumPlanes defines the frustum planes
  30190. * @returns true if the submesh is intersecting with the frustum
  30191. */
  30192. isInFrustum(frustumPlanes: Plane[]): boolean;
  30193. /**
  30194. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  30195. * @param frustumPlanes defines the frustum planes
  30196. * @returns true if the submesh is inside the frustum
  30197. */
  30198. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  30199. /**
  30200. * Renders the submesh
  30201. * @param enableAlphaMode defines if alpha needs to be used
  30202. * @returns the submesh
  30203. */
  30204. render(enableAlphaMode: boolean): SubMesh;
  30205. /**
  30206. * @hidden
  30207. */
  30208. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  30209. /**
  30210. * Checks if the submesh intersects with a ray
  30211. * @param ray defines the ray to test
  30212. * @returns true is the passed ray intersects the submesh bounding box
  30213. */
  30214. canIntersects(ray: Ray): boolean;
  30215. /**
  30216. * Intersects current submesh with a ray
  30217. * @param ray defines the ray to test
  30218. * @param positions defines mesh's positions array
  30219. * @param indices defines mesh's indices array
  30220. * @param fastCheck defines if the first intersection will be used (and not the closest)
  30221. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  30222. * @returns intersection info or null if no intersection
  30223. */
  30224. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  30225. /** @hidden */
  30226. private _intersectLines;
  30227. /** @hidden */
  30228. private _intersectUnIndexedLines;
  30229. /** @hidden */
  30230. private _intersectTriangles;
  30231. /** @hidden */
  30232. private _intersectUnIndexedTriangles;
  30233. /** @hidden */
  30234. _rebuild(): void;
  30235. /**
  30236. * Creates a new submesh from the passed mesh
  30237. * @param newMesh defines the new hosting mesh
  30238. * @param newRenderingMesh defines an optional rendering mesh
  30239. * @returns the new submesh
  30240. */
  30241. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  30242. /**
  30243. * Release associated resources
  30244. */
  30245. dispose(): void;
  30246. /**
  30247. * Gets the class name
  30248. * @returns the string "SubMesh".
  30249. */
  30250. getClassName(): string;
  30251. /**
  30252. * Creates a new submesh from indices data
  30253. * @param materialIndex the index of the main mesh material
  30254. * @param startIndex the index where to start the copy in the mesh indices array
  30255. * @param indexCount the number of indices to copy then from the startIndex
  30256. * @param mesh the main mesh to create the submesh from
  30257. * @param renderingMesh the optional rendering mesh
  30258. * @returns a new submesh
  30259. */
  30260. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  30261. }
  30262. }
  30263. declare module BABYLON {
  30264. /**
  30265. * Class used to represent data loading progression
  30266. */
  30267. export class SceneLoaderFlags {
  30268. private static _ForceFullSceneLoadingForIncremental;
  30269. private static _ShowLoadingScreen;
  30270. private static _CleanBoneMatrixWeights;
  30271. private static _loggingLevel;
  30272. /**
  30273. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  30274. */
  30275. static get ForceFullSceneLoadingForIncremental(): boolean;
  30276. static set ForceFullSceneLoadingForIncremental(value: boolean);
  30277. /**
  30278. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  30279. */
  30280. static get ShowLoadingScreen(): boolean;
  30281. static set ShowLoadingScreen(value: boolean);
  30282. /**
  30283. * Defines the current logging level (while loading the scene)
  30284. * @ignorenaming
  30285. */
  30286. static get loggingLevel(): number;
  30287. static set loggingLevel(value: number);
  30288. /**
  30289. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  30290. */
  30291. static get CleanBoneMatrixWeights(): boolean;
  30292. static set CleanBoneMatrixWeights(value: boolean);
  30293. }
  30294. }
  30295. declare module BABYLON {
  30296. /**
  30297. * Class used to store geometry data (vertex buffers + index buffer)
  30298. */
  30299. export class Geometry implements IGetSetVerticesData {
  30300. /**
  30301. * Gets or sets the ID of the geometry
  30302. */
  30303. id: string;
  30304. /**
  30305. * Gets or sets the unique ID of the geometry
  30306. */
  30307. uniqueId: number;
  30308. /**
  30309. * Gets the delay loading state of the geometry (none by default which means not delayed)
  30310. */
  30311. delayLoadState: number;
  30312. /**
  30313. * Gets the file containing the data to load when running in delay load state
  30314. */
  30315. delayLoadingFile: Nullable<string>;
  30316. /**
  30317. * Callback called when the geometry is updated
  30318. */
  30319. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  30320. private _scene;
  30321. private _engine;
  30322. private _meshes;
  30323. private _totalVertices;
  30324. /** @hidden */
  30325. _indices: IndicesArray;
  30326. /** @hidden */
  30327. _vertexBuffers: {
  30328. [key: string]: VertexBuffer;
  30329. };
  30330. private _isDisposed;
  30331. private _extend;
  30332. private _boundingBias;
  30333. /** @hidden */
  30334. _delayInfo: Array<string>;
  30335. private _indexBuffer;
  30336. private _indexBufferIsUpdatable;
  30337. /** @hidden */
  30338. _boundingInfo: Nullable<BoundingInfo>;
  30339. /** @hidden */
  30340. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  30341. /** @hidden */
  30342. _softwareSkinningFrameId: number;
  30343. private _vertexArrayObjects;
  30344. private _updatable;
  30345. /** @hidden */
  30346. _positions: Nullable<Vector3[]>;
  30347. private _positionsCache;
  30348. /**
  30349. * 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
  30350. */
  30351. get boundingBias(): Vector2;
  30352. /**
  30353. * 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
  30354. */
  30355. set boundingBias(value: Vector2);
  30356. /**
  30357. * Static function used to attach a new empty geometry to a mesh
  30358. * @param mesh defines the mesh to attach the geometry to
  30359. * @returns the new Geometry
  30360. */
  30361. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  30362. /** Get the list of meshes using this geometry */
  30363. get meshes(): Mesh[];
  30364. /**
  30365. * If set to true (false by defaut), the bounding info applied to the meshes sharing this geometry will be the bounding info defined at the class level
  30366. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  30367. */
  30368. useBoundingInfoFromGeometry: boolean;
  30369. /**
  30370. * Creates a new geometry
  30371. * @param id defines the unique ID
  30372. * @param scene defines the hosting scene
  30373. * @param vertexData defines the VertexData used to get geometry data
  30374. * @param updatable defines if geometry must be updatable (false by default)
  30375. * @param mesh defines the mesh that will be associated with the geometry
  30376. */
  30377. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  30378. /**
  30379. * Gets the current extend of the geometry
  30380. */
  30381. get extend(): {
  30382. minimum: Vector3;
  30383. maximum: Vector3;
  30384. };
  30385. /**
  30386. * Gets the hosting scene
  30387. * @returns the hosting Scene
  30388. */
  30389. getScene(): Scene;
  30390. /**
  30391. * Gets the hosting engine
  30392. * @returns the hosting Engine
  30393. */
  30394. getEngine(): Engine;
  30395. /**
  30396. * Defines if the geometry is ready to use
  30397. * @returns true if the geometry is ready to be used
  30398. */
  30399. isReady(): boolean;
  30400. /**
  30401. * Gets a value indicating that the geometry should not be serialized
  30402. */
  30403. get doNotSerialize(): boolean;
  30404. /** @hidden */
  30405. _rebuild(): void;
  30406. /**
  30407. * Affects all geometry data in one call
  30408. * @param vertexData defines the geometry data
  30409. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  30410. */
  30411. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  30412. /**
  30413. * Set specific vertex data
  30414. * @param kind defines the data kind (Position, normal, etc...)
  30415. * @param data defines the vertex data to use
  30416. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  30417. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  30418. */
  30419. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  30420. /**
  30421. * Removes a specific vertex data
  30422. * @param kind defines the data kind (Position, normal, etc...)
  30423. */
  30424. removeVerticesData(kind: string): void;
  30425. /**
  30426. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  30427. * @param buffer defines the vertex buffer to use
  30428. * @param totalVertices defines the total number of vertices for position kind (could be null)
  30429. */
  30430. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  30431. /**
  30432. * Update a specific vertex buffer
  30433. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  30434. * It will do nothing if the buffer is not updatable
  30435. * @param kind defines the data kind (Position, normal, etc...)
  30436. * @param data defines the data to use
  30437. * @param offset defines the offset in the target buffer where to store the data
  30438. * @param useBytes set to true if the offset is in bytes
  30439. */
  30440. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  30441. /**
  30442. * Update a specific vertex buffer
  30443. * This function will create a new buffer if the current one is not updatable
  30444. * @param kind defines the data kind (Position, normal, etc...)
  30445. * @param data defines the data to use
  30446. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  30447. */
  30448. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  30449. private _updateBoundingInfo;
  30450. /** @hidden */
  30451. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  30452. /**
  30453. * Gets total number of vertices
  30454. * @returns the total number of vertices
  30455. */
  30456. getTotalVertices(): number;
  30457. /**
  30458. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  30459. * @param kind defines the data kind (Position, normal, etc...)
  30460. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  30461. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  30462. * @returns a float array containing vertex data
  30463. */
  30464. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  30465. /**
  30466. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  30467. * @param kind defines the data kind (Position, normal, etc...)
  30468. * @returns true if the vertex buffer with the specified kind is updatable
  30469. */
  30470. isVertexBufferUpdatable(kind: string): boolean;
  30471. /**
  30472. * Gets a specific vertex buffer
  30473. * @param kind defines the data kind (Position, normal, etc...)
  30474. * @returns a VertexBuffer
  30475. */
  30476. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  30477. /**
  30478. * Returns all vertex buffers
  30479. * @return an object holding all vertex buffers indexed by kind
  30480. */
  30481. getVertexBuffers(): Nullable<{
  30482. [key: string]: VertexBuffer;
  30483. }>;
  30484. /**
  30485. * Gets a boolean indicating if specific vertex buffer is present
  30486. * @param kind defines the data kind (Position, normal, etc...)
  30487. * @returns true if data is present
  30488. */
  30489. isVerticesDataPresent(kind: string): boolean;
  30490. /**
  30491. * Gets a list of all attached data kinds (Position, normal, etc...)
  30492. * @returns a list of string containing all kinds
  30493. */
  30494. getVerticesDataKinds(): string[];
  30495. /**
  30496. * Update index buffer
  30497. * @param indices defines the indices to store in the index buffer
  30498. * @param offset defines the offset in the target buffer where to store the data
  30499. * @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)
  30500. */
  30501. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  30502. /**
  30503. * Creates a new index buffer
  30504. * @param indices defines the indices to store in the index buffer
  30505. * @param totalVertices defines the total number of vertices (could be null)
  30506. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  30507. */
  30508. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  30509. /**
  30510. * Return the total number of indices
  30511. * @returns the total number of indices
  30512. */
  30513. getTotalIndices(): number;
  30514. /**
  30515. * Gets the index buffer array
  30516. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  30517. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  30518. * @returns the index buffer array
  30519. */
  30520. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  30521. /**
  30522. * Gets the index buffer
  30523. * @return the index buffer
  30524. */
  30525. getIndexBuffer(): Nullable<DataBuffer>;
  30526. /** @hidden */
  30527. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  30528. /**
  30529. * Release the associated resources for a specific mesh
  30530. * @param mesh defines the source mesh
  30531. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  30532. */
  30533. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  30534. /**
  30535. * Apply current geometry to a given mesh
  30536. * @param mesh defines the mesh to apply geometry to
  30537. */
  30538. applyToMesh(mesh: Mesh): void;
  30539. private _updateExtend;
  30540. private _applyToMesh;
  30541. private notifyUpdate;
  30542. /**
  30543. * Load the geometry if it was flagged as delay loaded
  30544. * @param scene defines the hosting scene
  30545. * @param onLoaded defines a callback called when the geometry is loaded
  30546. */
  30547. load(scene: Scene, onLoaded?: () => void): void;
  30548. private _queueLoad;
  30549. /**
  30550. * Invert the geometry to move from a right handed system to a left handed one.
  30551. */
  30552. toLeftHanded(): void;
  30553. /** @hidden */
  30554. _resetPointsArrayCache(): void;
  30555. /** @hidden */
  30556. _generatePointsArray(): boolean;
  30557. /**
  30558. * Gets a value indicating if the geometry is disposed
  30559. * @returns true if the geometry was disposed
  30560. */
  30561. isDisposed(): boolean;
  30562. private _disposeVertexArrayObjects;
  30563. /**
  30564. * Free all associated resources
  30565. */
  30566. dispose(): void;
  30567. /**
  30568. * Clone the current geometry into a new geometry
  30569. * @param id defines the unique ID of the new geometry
  30570. * @returns a new geometry object
  30571. */
  30572. copy(id: string): Geometry;
  30573. /**
  30574. * Serialize the current geometry info (and not the vertices data) into a JSON object
  30575. * @return a JSON representation of the current geometry data (without the vertices data)
  30576. */
  30577. serialize(): any;
  30578. private toNumberArray;
  30579. /**
  30580. * Serialize all vertices data into a JSON oject
  30581. * @returns a JSON representation of the current geometry data
  30582. */
  30583. serializeVerticeData(): any;
  30584. /**
  30585. * Extracts a clone of a mesh geometry
  30586. * @param mesh defines the source mesh
  30587. * @param id defines the unique ID of the new geometry object
  30588. * @returns the new geometry object
  30589. */
  30590. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  30591. /**
  30592. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  30593. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  30594. * Be aware Math.random() could cause collisions, but:
  30595. * "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"
  30596. * @returns a string containing a new GUID
  30597. */
  30598. static RandomId(): string;
  30599. /** @hidden */
  30600. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  30601. private static _CleanMatricesWeights;
  30602. /**
  30603. * Create a new geometry from persisted data (Using .babylon file format)
  30604. * @param parsedVertexData defines the persisted data
  30605. * @param scene defines the hosting scene
  30606. * @param rootUrl defines the root url to use to load assets (like delayed data)
  30607. * @returns the new geometry object
  30608. */
  30609. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  30610. }
  30611. }
  30612. declare module BABYLON {
  30613. /**
  30614. * Defines a target to use with MorphTargetManager
  30615. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  30616. */
  30617. export class MorphTarget implements IAnimatable {
  30618. /** defines the name of the target */
  30619. name: string;
  30620. /**
  30621. * Gets or sets the list of animations
  30622. */
  30623. animations: Animation[];
  30624. private _scene;
  30625. private _positions;
  30626. private _normals;
  30627. private _tangents;
  30628. private _uvs;
  30629. private _influence;
  30630. private _uniqueId;
  30631. /**
  30632. * Observable raised when the influence changes
  30633. */
  30634. onInfluenceChanged: Observable<boolean>;
  30635. /** @hidden */
  30636. _onDataLayoutChanged: Observable<void>;
  30637. /**
  30638. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  30639. */
  30640. get influence(): number;
  30641. set influence(influence: number);
  30642. /**
  30643. * Gets or sets the id of the morph Target
  30644. */
  30645. id: string;
  30646. private _animationPropertiesOverride;
  30647. /**
  30648. * Gets or sets the animation properties override
  30649. */
  30650. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  30651. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  30652. /**
  30653. * Creates a new MorphTarget
  30654. * @param name defines the name of the target
  30655. * @param influence defines the influence to use
  30656. * @param scene defines the scene the morphtarget belongs to
  30657. */
  30658. constructor(
  30659. /** defines the name of the target */
  30660. name: string, influence?: number, scene?: Nullable<Scene>);
  30661. /**
  30662. * Gets the unique ID of this manager
  30663. */
  30664. get uniqueId(): number;
  30665. /**
  30666. * Gets a boolean defining if the target contains position data
  30667. */
  30668. get hasPositions(): boolean;
  30669. /**
  30670. * Gets a boolean defining if the target contains normal data
  30671. */
  30672. get hasNormals(): boolean;
  30673. /**
  30674. * Gets a boolean defining if the target contains tangent data
  30675. */
  30676. get hasTangents(): boolean;
  30677. /**
  30678. * Gets a boolean defining if the target contains texture coordinates data
  30679. */
  30680. get hasUVs(): boolean;
  30681. /**
  30682. * Affects position data to this target
  30683. * @param data defines the position data to use
  30684. */
  30685. setPositions(data: Nullable<FloatArray>): void;
  30686. /**
  30687. * Gets the position data stored in this target
  30688. * @returns a FloatArray containing the position data (or null if not present)
  30689. */
  30690. getPositions(): Nullable<FloatArray>;
  30691. /**
  30692. * Affects normal data to this target
  30693. * @param data defines the normal data to use
  30694. */
  30695. setNormals(data: Nullable<FloatArray>): void;
  30696. /**
  30697. * Gets the normal data stored in this target
  30698. * @returns a FloatArray containing the normal data (or null if not present)
  30699. */
  30700. getNormals(): Nullable<FloatArray>;
  30701. /**
  30702. * Affects tangent data to this target
  30703. * @param data defines the tangent data to use
  30704. */
  30705. setTangents(data: Nullable<FloatArray>): void;
  30706. /**
  30707. * Gets the tangent data stored in this target
  30708. * @returns a FloatArray containing the tangent data (or null if not present)
  30709. */
  30710. getTangents(): Nullable<FloatArray>;
  30711. /**
  30712. * Affects texture coordinates data to this target
  30713. * @param data defines the texture coordinates data to use
  30714. */
  30715. setUVs(data: Nullable<FloatArray>): void;
  30716. /**
  30717. * Gets the texture coordinates data stored in this target
  30718. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  30719. */
  30720. getUVs(): Nullable<FloatArray>;
  30721. /**
  30722. * Clone the current target
  30723. * @returns a new MorphTarget
  30724. */
  30725. clone(): MorphTarget;
  30726. /**
  30727. * Serializes the current target into a Serialization object
  30728. * @returns the serialized object
  30729. */
  30730. serialize(): any;
  30731. /**
  30732. * Returns the string "MorphTarget"
  30733. * @returns "MorphTarget"
  30734. */
  30735. getClassName(): string;
  30736. /**
  30737. * Creates a new target from serialized data
  30738. * @param serializationObject defines the serialized data to use
  30739. * @returns a new MorphTarget
  30740. */
  30741. static Parse(serializationObject: any): MorphTarget;
  30742. /**
  30743. * Creates a MorphTarget from mesh data
  30744. * @param mesh defines the source mesh
  30745. * @param name defines the name to use for the new target
  30746. * @param influence defines the influence to attach to the target
  30747. * @returns a new MorphTarget
  30748. */
  30749. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  30750. }
  30751. }
  30752. declare module BABYLON {
  30753. /**
  30754. * This class is used to deform meshes using morphing between different targets
  30755. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  30756. */
  30757. export class MorphTargetManager {
  30758. private _targets;
  30759. private _targetInfluenceChangedObservers;
  30760. private _targetDataLayoutChangedObservers;
  30761. private _activeTargets;
  30762. private _scene;
  30763. private _influences;
  30764. private _supportsNormals;
  30765. private _supportsTangents;
  30766. private _supportsUVs;
  30767. private _vertexCount;
  30768. private _uniqueId;
  30769. private _tempInfluences;
  30770. /**
  30771. * Gets or sets a boolean indicating if normals must be morphed
  30772. */
  30773. enableNormalMorphing: boolean;
  30774. /**
  30775. * Gets or sets a boolean indicating if tangents must be morphed
  30776. */
  30777. enableTangentMorphing: boolean;
  30778. /**
  30779. * Gets or sets a boolean indicating if UV must be morphed
  30780. */
  30781. enableUVMorphing: boolean;
  30782. /**
  30783. * Creates a new MorphTargetManager
  30784. * @param scene defines the current scene
  30785. */
  30786. constructor(scene?: Nullable<Scene>);
  30787. /**
  30788. * Gets the unique ID of this manager
  30789. */
  30790. get uniqueId(): number;
  30791. /**
  30792. * Gets the number of vertices handled by this manager
  30793. */
  30794. get vertexCount(): number;
  30795. /**
  30796. * Gets a boolean indicating if this manager supports morphing of normals
  30797. */
  30798. get supportsNormals(): boolean;
  30799. /**
  30800. * Gets a boolean indicating if this manager supports morphing of tangents
  30801. */
  30802. get supportsTangents(): boolean;
  30803. /**
  30804. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  30805. */
  30806. get supportsUVs(): boolean;
  30807. /**
  30808. * Gets the number of targets stored in this manager
  30809. */
  30810. get numTargets(): number;
  30811. /**
  30812. * Gets the number of influencers (ie. the number of targets with influences > 0)
  30813. */
  30814. get numInfluencers(): number;
  30815. /**
  30816. * Gets the list of influences (one per target)
  30817. */
  30818. get influences(): Float32Array;
  30819. /**
  30820. * Gets the active target at specified index. An active target is a target with an influence > 0
  30821. * @param index defines the index to check
  30822. * @returns the requested target
  30823. */
  30824. getActiveTarget(index: number): MorphTarget;
  30825. /**
  30826. * Gets the target at specified index
  30827. * @param index defines the index to check
  30828. * @returns the requested target
  30829. */
  30830. getTarget(index: number): MorphTarget;
  30831. /**
  30832. * Add a new target to this manager
  30833. * @param target defines the target to add
  30834. */
  30835. addTarget(target: MorphTarget): void;
  30836. /**
  30837. * Removes a target from the manager
  30838. * @param target defines the target to remove
  30839. */
  30840. removeTarget(target: MorphTarget): void;
  30841. /**
  30842. * Clone the current manager
  30843. * @returns a new MorphTargetManager
  30844. */
  30845. clone(): MorphTargetManager;
  30846. /**
  30847. * Serializes the current manager into a Serialization object
  30848. * @returns the serialized object
  30849. */
  30850. serialize(): any;
  30851. private _syncActiveTargets;
  30852. /**
  30853. * Syncrhonize the targets with all the meshes using this morph target manager
  30854. */
  30855. synchronize(): void;
  30856. /**
  30857. * Creates a new MorphTargetManager from serialized data
  30858. * @param serializationObject defines the serialized data
  30859. * @param scene defines the hosting scene
  30860. * @returns the new MorphTargetManager
  30861. */
  30862. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  30863. }
  30864. }
  30865. declare module BABYLON {
  30866. /**
  30867. * Class used to represent a specific level of detail of a mesh
  30868. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  30869. */
  30870. export class MeshLODLevel {
  30871. /** Defines the distance where this level should start being displayed */
  30872. distance: number;
  30873. /** Defines the mesh to use to render this level */
  30874. mesh: Nullable<Mesh>;
  30875. /**
  30876. * Creates a new LOD level
  30877. * @param distance defines the distance where this level should star being displayed
  30878. * @param mesh defines the mesh to use to render this level
  30879. */
  30880. constructor(
  30881. /** Defines the distance where this level should start being displayed */
  30882. distance: number,
  30883. /** Defines the mesh to use to render this level */
  30884. mesh: Nullable<Mesh>);
  30885. }
  30886. }
  30887. declare module BABYLON {
  30888. /**
  30889. * Helper class used to generate a canvas to manipulate images
  30890. */
  30891. export class CanvasGenerator {
  30892. /**
  30893. * Create a new canvas (or offscreen canvas depending on the context)
  30894. * @param width defines the expected width
  30895. * @param height defines the expected height
  30896. * @return a new canvas or offscreen canvas
  30897. */
  30898. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  30899. }
  30900. }
  30901. declare module BABYLON {
  30902. /**
  30903. * Mesh representing the gorund
  30904. */
  30905. export class GroundMesh extends Mesh {
  30906. /** If octree should be generated */
  30907. generateOctree: boolean;
  30908. private _heightQuads;
  30909. /** @hidden */
  30910. _subdivisionsX: number;
  30911. /** @hidden */
  30912. _subdivisionsY: number;
  30913. /** @hidden */
  30914. _width: number;
  30915. /** @hidden */
  30916. _height: number;
  30917. /** @hidden */
  30918. _minX: number;
  30919. /** @hidden */
  30920. _maxX: number;
  30921. /** @hidden */
  30922. _minZ: number;
  30923. /** @hidden */
  30924. _maxZ: number;
  30925. constructor(name: string, scene: Scene);
  30926. /**
  30927. * "GroundMesh"
  30928. * @returns "GroundMesh"
  30929. */
  30930. getClassName(): string;
  30931. /**
  30932. * The minimum of x and y subdivisions
  30933. */
  30934. get subdivisions(): number;
  30935. /**
  30936. * X subdivisions
  30937. */
  30938. get subdivisionsX(): number;
  30939. /**
  30940. * Y subdivisions
  30941. */
  30942. get subdivisionsY(): number;
  30943. /**
  30944. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  30945. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  30946. * @param chunksCount the number of subdivisions for x and y
  30947. * @param octreeBlocksSize (Default: 32)
  30948. */
  30949. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  30950. /**
  30951. * Returns a height (y) value in the Worl system :
  30952. * the ground altitude at the coordinates (x, z) expressed in the World system.
  30953. * @param x x coordinate
  30954. * @param z z coordinate
  30955. * @returns the ground y position if (x, z) are outside the ground surface.
  30956. */
  30957. getHeightAtCoordinates(x: number, z: number): number;
  30958. /**
  30959. * Returns a normalized vector (Vector3) orthogonal to the ground
  30960. * at the ground coordinates (x, z) expressed in the World system.
  30961. * @param x x coordinate
  30962. * @param z z coordinate
  30963. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  30964. */
  30965. getNormalAtCoordinates(x: number, z: number): Vector3;
  30966. /**
  30967. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  30968. * at the ground coordinates (x, z) expressed in the World system.
  30969. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  30970. * @param x x coordinate
  30971. * @param z z coordinate
  30972. * @param ref vector to store the result
  30973. * @returns the GroundMesh.
  30974. */
  30975. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  30976. /**
  30977. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  30978. * if the ground has been updated.
  30979. * This can be used in the render loop.
  30980. * @returns the GroundMesh.
  30981. */
  30982. updateCoordinateHeights(): GroundMesh;
  30983. private _getFacetAt;
  30984. private _initHeightQuads;
  30985. private _computeHeightQuads;
  30986. /**
  30987. * Serializes this ground mesh
  30988. * @param serializationObject object to write serialization to
  30989. */
  30990. serialize(serializationObject: any): void;
  30991. /**
  30992. * Parses a serialized ground mesh
  30993. * @param parsedMesh the serialized mesh
  30994. * @param scene the scene to create the ground mesh in
  30995. * @returns the created ground mesh
  30996. */
  30997. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  30998. }
  30999. }
  31000. declare module BABYLON {
  31001. /**
  31002. * Interface for Physics-Joint data
  31003. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  31004. */
  31005. export interface PhysicsJointData {
  31006. /**
  31007. * The main pivot of the joint
  31008. */
  31009. mainPivot?: Vector3;
  31010. /**
  31011. * The connected pivot of the joint
  31012. */
  31013. connectedPivot?: Vector3;
  31014. /**
  31015. * The main axis of the joint
  31016. */
  31017. mainAxis?: Vector3;
  31018. /**
  31019. * The connected axis of the joint
  31020. */
  31021. connectedAxis?: Vector3;
  31022. /**
  31023. * The collision of the joint
  31024. */
  31025. collision?: boolean;
  31026. /**
  31027. * Native Oimo/Cannon/Energy data
  31028. */
  31029. nativeParams?: any;
  31030. }
  31031. /**
  31032. * This is a holder class for the physics joint created by the physics plugin
  31033. * It holds a set of functions to control the underlying joint
  31034. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  31035. */
  31036. export class PhysicsJoint {
  31037. /**
  31038. * The type of the physics joint
  31039. */
  31040. type: number;
  31041. /**
  31042. * The data for the physics joint
  31043. */
  31044. jointData: PhysicsJointData;
  31045. private _physicsJoint;
  31046. protected _physicsPlugin: IPhysicsEnginePlugin;
  31047. /**
  31048. * Initializes the physics joint
  31049. * @param type The type of the physics joint
  31050. * @param jointData The data for the physics joint
  31051. */
  31052. constructor(
  31053. /**
  31054. * The type of the physics joint
  31055. */
  31056. type: number,
  31057. /**
  31058. * The data for the physics joint
  31059. */
  31060. jointData: PhysicsJointData);
  31061. /**
  31062. * Gets the physics joint
  31063. */
  31064. get physicsJoint(): any;
  31065. /**
  31066. * Sets the physics joint
  31067. */
  31068. set physicsJoint(newJoint: any);
  31069. /**
  31070. * Sets the physics plugin
  31071. */
  31072. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  31073. /**
  31074. * Execute a function that is physics-plugin specific.
  31075. * @param {Function} func the function that will be executed.
  31076. * It accepts two parameters: the physics world and the physics joint
  31077. */
  31078. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  31079. /**
  31080. * Distance-Joint type
  31081. */
  31082. static DistanceJoint: number;
  31083. /**
  31084. * Hinge-Joint type
  31085. */
  31086. static HingeJoint: number;
  31087. /**
  31088. * Ball-and-Socket joint type
  31089. */
  31090. static BallAndSocketJoint: number;
  31091. /**
  31092. * Wheel-Joint type
  31093. */
  31094. static WheelJoint: number;
  31095. /**
  31096. * Slider-Joint type
  31097. */
  31098. static SliderJoint: number;
  31099. /**
  31100. * Prismatic-Joint type
  31101. */
  31102. static PrismaticJoint: number;
  31103. /**
  31104. * Universal-Joint type
  31105. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  31106. */
  31107. static UniversalJoint: number;
  31108. /**
  31109. * Hinge-Joint 2 type
  31110. */
  31111. static Hinge2Joint: number;
  31112. /**
  31113. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  31114. */
  31115. static PointToPointJoint: number;
  31116. /**
  31117. * Spring-Joint type
  31118. */
  31119. static SpringJoint: number;
  31120. /**
  31121. * Lock-Joint type
  31122. */
  31123. static LockJoint: number;
  31124. }
  31125. /**
  31126. * A class representing a physics distance joint
  31127. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  31128. */
  31129. export class DistanceJoint extends PhysicsJoint {
  31130. /**
  31131. *
  31132. * @param jointData The data for the Distance-Joint
  31133. */
  31134. constructor(jointData: DistanceJointData);
  31135. /**
  31136. * Update the predefined distance.
  31137. * @param maxDistance The maximum preferred distance
  31138. * @param minDistance The minimum preferred distance
  31139. */
  31140. updateDistance(maxDistance: number, minDistance?: number): void;
  31141. }
  31142. /**
  31143. * Represents a Motor-Enabled Joint
  31144. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  31145. */
  31146. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  31147. /**
  31148. * Initializes the Motor-Enabled Joint
  31149. * @param type The type of the joint
  31150. * @param jointData The physica joint data for the joint
  31151. */
  31152. constructor(type: number, jointData: PhysicsJointData);
  31153. /**
  31154. * Set the motor values.
  31155. * Attention, this function is plugin specific. Engines won't react 100% the same.
  31156. * @param force the force to apply
  31157. * @param maxForce max force for this motor.
  31158. */
  31159. setMotor(force?: number, maxForce?: number): void;
  31160. /**
  31161. * Set the motor's limits.
  31162. * Attention, this function is plugin specific. Engines won't react 100% the same.
  31163. * @param upperLimit The upper limit of the motor
  31164. * @param lowerLimit The lower limit of the motor
  31165. */
  31166. setLimit(upperLimit: number, lowerLimit?: number): void;
  31167. }
  31168. /**
  31169. * This class represents a single physics Hinge-Joint
  31170. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  31171. */
  31172. export class HingeJoint extends MotorEnabledJoint {
  31173. /**
  31174. * Initializes the Hinge-Joint
  31175. * @param jointData The joint data for the Hinge-Joint
  31176. */
  31177. constructor(jointData: PhysicsJointData);
  31178. /**
  31179. * Set the motor values.
  31180. * Attention, this function is plugin specific. Engines won't react 100% the same.
  31181. * @param {number} force the force to apply
  31182. * @param {number} maxForce max force for this motor.
  31183. */
  31184. setMotor(force?: number, maxForce?: number): void;
  31185. /**
  31186. * Set the motor's limits.
  31187. * Attention, this function is plugin specific. Engines won't react 100% the same.
  31188. * @param upperLimit The upper limit of the motor
  31189. * @param lowerLimit The lower limit of the motor
  31190. */
  31191. setLimit(upperLimit: number, lowerLimit?: number): void;
  31192. }
  31193. /**
  31194. * This class represents a dual hinge physics joint (same as wheel joint)
  31195. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  31196. */
  31197. export class Hinge2Joint extends MotorEnabledJoint {
  31198. /**
  31199. * Initializes the Hinge2-Joint
  31200. * @param jointData The joint data for the Hinge2-Joint
  31201. */
  31202. constructor(jointData: PhysicsJointData);
  31203. /**
  31204. * Set the motor values.
  31205. * Attention, this function is plugin specific. Engines won't react 100% the same.
  31206. * @param {number} targetSpeed the speed the motor is to reach
  31207. * @param {number} maxForce max force for this motor.
  31208. * @param {motorIndex} the motor's index, 0 or 1.
  31209. */
  31210. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  31211. /**
  31212. * Set the motor limits.
  31213. * Attention, this function is plugin specific. Engines won't react 100% the same.
  31214. * @param {number} upperLimit the upper limit
  31215. * @param {number} lowerLimit lower limit
  31216. * @param {motorIndex} the motor's index, 0 or 1.
  31217. */
  31218. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  31219. }
  31220. /**
  31221. * Interface for a motor enabled joint
  31222. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  31223. */
  31224. export interface IMotorEnabledJoint {
  31225. /**
  31226. * Physics joint
  31227. */
  31228. physicsJoint: any;
  31229. /**
  31230. * Sets the motor of the motor-enabled joint
  31231. * @param force The force of the motor
  31232. * @param maxForce The maximum force of the motor
  31233. * @param motorIndex The index of the motor
  31234. */
  31235. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  31236. /**
  31237. * Sets the limit of the motor
  31238. * @param upperLimit The upper limit of the motor
  31239. * @param lowerLimit The lower limit of the motor
  31240. * @param motorIndex The index of the motor
  31241. */
  31242. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  31243. }
  31244. /**
  31245. * Joint data for a Distance-Joint
  31246. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  31247. */
  31248. export interface DistanceJointData extends PhysicsJointData {
  31249. /**
  31250. * Max distance the 2 joint objects can be apart
  31251. */
  31252. maxDistance: number;
  31253. }
  31254. /**
  31255. * Joint data from a spring joint
  31256. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  31257. */
  31258. export interface SpringJointData extends PhysicsJointData {
  31259. /**
  31260. * Length of the spring
  31261. */
  31262. length: number;
  31263. /**
  31264. * Stiffness of the spring
  31265. */
  31266. stiffness: number;
  31267. /**
  31268. * Damping of the spring
  31269. */
  31270. damping: number;
  31271. /** this callback will be called when applying the force to the impostors. */
  31272. forceApplicationCallback: () => void;
  31273. }
  31274. }
  31275. declare module BABYLON {
  31276. /**
  31277. * Holds the data for the raycast result
  31278. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  31279. */
  31280. export class PhysicsRaycastResult {
  31281. private _hasHit;
  31282. private _hitDistance;
  31283. private _hitNormalWorld;
  31284. private _hitPointWorld;
  31285. private _rayFromWorld;
  31286. private _rayToWorld;
  31287. /**
  31288. * Gets if there was a hit
  31289. */
  31290. get hasHit(): boolean;
  31291. /**
  31292. * Gets the distance from the hit
  31293. */
  31294. get hitDistance(): number;
  31295. /**
  31296. * Gets the hit normal/direction in the world
  31297. */
  31298. get hitNormalWorld(): Vector3;
  31299. /**
  31300. * Gets the hit point in the world
  31301. */
  31302. get hitPointWorld(): Vector3;
  31303. /**
  31304. * Gets the ray "start point" of the ray in the world
  31305. */
  31306. get rayFromWorld(): Vector3;
  31307. /**
  31308. * Gets the ray "end point" of the ray in the world
  31309. */
  31310. get rayToWorld(): Vector3;
  31311. /**
  31312. * Sets the hit data (normal & point in world space)
  31313. * @param hitNormalWorld defines the normal in world space
  31314. * @param hitPointWorld defines the point in world space
  31315. */
  31316. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  31317. /**
  31318. * Sets the distance from the start point to the hit point
  31319. * @param distance
  31320. */
  31321. setHitDistance(distance: number): void;
  31322. /**
  31323. * Calculates the distance manually
  31324. */
  31325. calculateHitDistance(): void;
  31326. /**
  31327. * Resets all the values to default
  31328. * @param from The from point on world space
  31329. * @param to The to point on world space
  31330. */
  31331. reset(from?: Vector3, to?: Vector3): void;
  31332. }
  31333. /**
  31334. * Interface for the size containing width and height
  31335. */
  31336. interface IXYZ {
  31337. /**
  31338. * X
  31339. */
  31340. x: number;
  31341. /**
  31342. * Y
  31343. */
  31344. y: number;
  31345. /**
  31346. * Z
  31347. */
  31348. z: number;
  31349. }
  31350. }
  31351. declare module BABYLON {
  31352. /**
  31353. * Interface used to describe a physics joint
  31354. */
  31355. export interface PhysicsImpostorJoint {
  31356. /** Defines the main impostor to which the joint is linked */
  31357. mainImpostor: PhysicsImpostor;
  31358. /** Defines the impostor that is connected to the main impostor using this joint */
  31359. connectedImpostor: PhysicsImpostor;
  31360. /** Defines the joint itself */
  31361. joint: PhysicsJoint;
  31362. }
  31363. /** @hidden */
  31364. export interface IPhysicsEnginePlugin {
  31365. world: any;
  31366. name: string;
  31367. setGravity(gravity: Vector3): void;
  31368. setTimeStep(timeStep: number): void;
  31369. getTimeStep(): number;
  31370. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  31371. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  31372. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  31373. generatePhysicsBody(impostor: PhysicsImpostor): void;
  31374. removePhysicsBody(impostor: PhysicsImpostor): void;
  31375. generateJoint(joint: PhysicsImpostorJoint): void;
  31376. removeJoint(joint: PhysicsImpostorJoint): void;
  31377. isSupported(): boolean;
  31378. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  31379. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  31380. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  31381. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  31382. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  31383. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  31384. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  31385. getBodyMass(impostor: PhysicsImpostor): number;
  31386. getBodyFriction(impostor: PhysicsImpostor): number;
  31387. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  31388. getBodyRestitution(impostor: PhysicsImpostor): number;
  31389. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  31390. getBodyPressure?(impostor: PhysicsImpostor): number;
  31391. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  31392. getBodyStiffness?(impostor: PhysicsImpostor): number;
  31393. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  31394. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  31395. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  31396. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  31397. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  31398. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  31399. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  31400. sleepBody(impostor: PhysicsImpostor): void;
  31401. wakeUpBody(impostor: PhysicsImpostor): void;
  31402. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  31403. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  31404. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  31405. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  31406. getRadius(impostor: PhysicsImpostor): number;
  31407. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  31408. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  31409. dispose(): void;
  31410. }
  31411. /**
  31412. * Interface used to define a physics engine
  31413. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  31414. */
  31415. export interface IPhysicsEngine {
  31416. /**
  31417. * Gets the gravity vector used by the simulation
  31418. */
  31419. gravity: Vector3;
  31420. /**
  31421. * Sets the gravity vector used by the simulation
  31422. * @param gravity defines the gravity vector to use
  31423. */
  31424. setGravity(gravity: Vector3): void;
  31425. /**
  31426. * Set the time step of the physics engine.
  31427. * Default is 1/60.
  31428. * To slow it down, enter 1/600 for example.
  31429. * To speed it up, 1/30
  31430. * @param newTimeStep the new timestep to apply to this world.
  31431. */
  31432. setTimeStep(newTimeStep: number): void;
  31433. /**
  31434. * Get the time step of the physics engine.
  31435. * @returns the current time step
  31436. */
  31437. getTimeStep(): number;
  31438. /**
  31439. * Set the sub time step of the physics engine.
  31440. * Default is 0 meaning there is no sub steps
  31441. * To increase physics resolution precision, set a small value (like 1 ms)
  31442. * @param subTimeStep defines the new sub timestep used for physics resolution.
  31443. */
  31444. setSubTimeStep(subTimeStep: number): void;
  31445. /**
  31446. * Get the sub time step of the physics engine.
  31447. * @returns the current sub time step
  31448. */
  31449. getSubTimeStep(): number;
  31450. /**
  31451. * Release all resources
  31452. */
  31453. dispose(): void;
  31454. /**
  31455. * Gets the name of the current physics plugin
  31456. * @returns the name of the plugin
  31457. */
  31458. getPhysicsPluginName(): string;
  31459. /**
  31460. * Adding a new impostor for the impostor tracking.
  31461. * This will be done by the impostor itself.
  31462. * @param impostor the impostor to add
  31463. */
  31464. addImpostor(impostor: PhysicsImpostor): void;
  31465. /**
  31466. * Remove an impostor from the engine.
  31467. * This impostor and its mesh will not longer be updated by the physics engine.
  31468. * @param impostor the impostor to remove
  31469. */
  31470. removeImpostor(impostor: PhysicsImpostor): void;
  31471. /**
  31472. * Add a joint to the physics engine
  31473. * @param mainImpostor defines the main impostor to which the joint is added.
  31474. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  31475. * @param joint defines the joint that will connect both impostors.
  31476. */
  31477. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  31478. /**
  31479. * Removes a joint from the simulation
  31480. * @param mainImpostor defines the impostor used with the joint
  31481. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  31482. * @param joint defines the joint to remove
  31483. */
  31484. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  31485. /**
  31486. * Gets the current plugin used to run the simulation
  31487. * @returns current plugin
  31488. */
  31489. getPhysicsPlugin(): IPhysicsEnginePlugin;
  31490. /**
  31491. * Gets the list of physic impostors
  31492. * @returns an array of PhysicsImpostor
  31493. */
  31494. getImpostors(): Array<PhysicsImpostor>;
  31495. /**
  31496. * Gets the impostor for a physics enabled object
  31497. * @param object defines the object impersonated by the impostor
  31498. * @returns the PhysicsImpostor or null if not found
  31499. */
  31500. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  31501. /**
  31502. * Gets the impostor for a physics body object
  31503. * @param body defines physics body used by the impostor
  31504. * @returns the PhysicsImpostor or null if not found
  31505. */
  31506. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  31507. /**
  31508. * Does a raycast in the physics world
  31509. * @param from when should the ray start?
  31510. * @param to when should the ray end?
  31511. * @returns PhysicsRaycastResult
  31512. */
  31513. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  31514. /**
  31515. * Called by the scene. No need to call it.
  31516. * @param delta defines the timespam between frames
  31517. */
  31518. _step(delta: number): void;
  31519. }
  31520. }
  31521. declare module BABYLON {
  31522. /**
  31523. * The interface for the physics imposter parameters
  31524. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  31525. */
  31526. export interface PhysicsImpostorParameters {
  31527. /**
  31528. * The mass of the physics imposter
  31529. */
  31530. mass: number;
  31531. /**
  31532. * The friction of the physics imposter
  31533. */
  31534. friction?: number;
  31535. /**
  31536. * The coefficient of restitution of the physics imposter
  31537. */
  31538. restitution?: number;
  31539. /**
  31540. * The native options of the physics imposter
  31541. */
  31542. nativeOptions?: any;
  31543. /**
  31544. * Specifies if the parent should be ignored
  31545. */
  31546. ignoreParent?: boolean;
  31547. /**
  31548. * Specifies if bi-directional transformations should be disabled
  31549. */
  31550. disableBidirectionalTransformation?: boolean;
  31551. /**
  31552. * The pressure inside the physics imposter, soft object only
  31553. */
  31554. pressure?: number;
  31555. /**
  31556. * The stiffness the physics imposter, soft object only
  31557. */
  31558. stiffness?: number;
  31559. /**
  31560. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  31561. */
  31562. velocityIterations?: number;
  31563. /**
  31564. * The number of iterations used in maintaining consistent vertex positions, soft object only
  31565. */
  31566. positionIterations?: number;
  31567. /**
  31568. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  31569. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  31570. * Add to fix multiple points
  31571. */
  31572. fixedPoints?: number;
  31573. /**
  31574. * The collision margin around a soft object
  31575. */
  31576. margin?: number;
  31577. /**
  31578. * The collision margin around a soft object
  31579. */
  31580. damping?: number;
  31581. /**
  31582. * The path for a rope based on an extrusion
  31583. */
  31584. path?: any;
  31585. /**
  31586. * The shape of an extrusion used for a rope based on an extrusion
  31587. */
  31588. shape?: any;
  31589. }
  31590. /**
  31591. * Interface for a physics-enabled object
  31592. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  31593. */
  31594. export interface IPhysicsEnabledObject {
  31595. /**
  31596. * The position of the physics-enabled object
  31597. */
  31598. position: Vector3;
  31599. /**
  31600. * The rotation of the physics-enabled object
  31601. */
  31602. rotationQuaternion: Nullable<Quaternion>;
  31603. /**
  31604. * The scale of the physics-enabled object
  31605. */
  31606. scaling: Vector3;
  31607. /**
  31608. * The rotation of the physics-enabled object
  31609. */
  31610. rotation?: Vector3;
  31611. /**
  31612. * The parent of the physics-enabled object
  31613. */
  31614. parent?: any;
  31615. /**
  31616. * The bounding info of the physics-enabled object
  31617. * @returns The bounding info of the physics-enabled object
  31618. */
  31619. getBoundingInfo(): BoundingInfo;
  31620. /**
  31621. * Computes the world matrix
  31622. * @param force Specifies if the world matrix should be computed by force
  31623. * @returns A world matrix
  31624. */
  31625. computeWorldMatrix(force: boolean): Matrix;
  31626. /**
  31627. * Gets the world matrix
  31628. * @returns A world matrix
  31629. */
  31630. getWorldMatrix?(): Matrix;
  31631. /**
  31632. * Gets the child meshes
  31633. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  31634. * @returns An array of abstract meshes
  31635. */
  31636. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  31637. /**
  31638. * Gets the vertex data
  31639. * @param kind The type of vertex data
  31640. * @returns A nullable array of numbers, or a float32 array
  31641. */
  31642. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  31643. /**
  31644. * Gets the indices from the mesh
  31645. * @returns A nullable array of index arrays
  31646. */
  31647. getIndices?(): Nullable<IndicesArray>;
  31648. /**
  31649. * Gets the scene from the mesh
  31650. * @returns the indices array or null
  31651. */
  31652. getScene?(): Scene;
  31653. /**
  31654. * Gets the absolute position from the mesh
  31655. * @returns the absolute position
  31656. */
  31657. getAbsolutePosition(): Vector3;
  31658. /**
  31659. * Gets the absolute pivot point from the mesh
  31660. * @returns the absolute pivot point
  31661. */
  31662. getAbsolutePivotPoint(): Vector3;
  31663. /**
  31664. * Rotates the mesh
  31665. * @param axis The axis of rotation
  31666. * @param amount The amount of rotation
  31667. * @param space The space of the rotation
  31668. * @returns The rotation transform node
  31669. */
  31670. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  31671. /**
  31672. * Translates the mesh
  31673. * @param axis The axis of translation
  31674. * @param distance The distance of translation
  31675. * @param space The space of the translation
  31676. * @returns The transform node
  31677. */
  31678. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  31679. /**
  31680. * Sets the absolute position of the mesh
  31681. * @param absolutePosition The absolute position of the mesh
  31682. * @returns The transform node
  31683. */
  31684. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  31685. /**
  31686. * Gets the class name of the mesh
  31687. * @returns The class name
  31688. */
  31689. getClassName(): string;
  31690. }
  31691. /**
  31692. * Represents a physics imposter
  31693. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  31694. */
  31695. export class PhysicsImpostor {
  31696. /**
  31697. * The physics-enabled object used as the physics imposter
  31698. */
  31699. object: IPhysicsEnabledObject;
  31700. /**
  31701. * The type of the physics imposter
  31702. */
  31703. type: number;
  31704. private _options;
  31705. private _scene?;
  31706. /**
  31707. * The default object size of the imposter
  31708. */
  31709. static DEFAULT_OBJECT_SIZE: Vector3;
  31710. /**
  31711. * The identity quaternion of the imposter
  31712. */
  31713. static IDENTITY_QUATERNION: Quaternion;
  31714. /** @hidden */
  31715. _pluginData: any;
  31716. private _physicsEngine;
  31717. private _physicsBody;
  31718. private _bodyUpdateRequired;
  31719. private _onBeforePhysicsStepCallbacks;
  31720. private _onAfterPhysicsStepCallbacks;
  31721. /** @hidden */
  31722. _onPhysicsCollideCallbacks: Array<{
  31723. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor, point: Nullable<Vector3>) => void;
  31724. otherImpostors: Array<PhysicsImpostor>;
  31725. }>;
  31726. private _deltaPosition;
  31727. private _deltaRotation;
  31728. private _deltaRotationConjugated;
  31729. /** @hidden */
  31730. _isFromLine: boolean;
  31731. private _parent;
  31732. private _isDisposed;
  31733. private static _tmpVecs;
  31734. private static _tmpQuat;
  31735. /**
  31736. * Specifies if the physics imposter is disposed
  31737. */
  31738. get isDisposed(): boolean;
  31739. /**
  31740. * Gets the mass of the physics imposter
  31741. */
  31742. get mass(): number;
  31743. set mass(value: number);
  31744. /**
  31745. * Gets the coefficient of friction
  31746. */
  31747. get friction(): number;
  31748. /**
  31749. * Sets the coefficient of friction
  31750. */
  31751. set friction(value: number);
  31752. /**
  31753. * Gets the coefficient of restitution
  31754. */
  31755. get restitution(): number;
  31756. /**
  31757. * Sets the coefficient of restitution
  31758. */
  31759. set restitution(value: number);
  31760. /**
  31761. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  31762. */
  31763. get pressure(): number;
  31764. /**
  31765. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  31766. */
  31767. set pressure(value: number);
  31768. /**
  31769. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  31770. */
  31771. get stiffness(): number;
  31772. /**
  31773. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  31774. */
  31775. set stiffness(value: number);
  31776. /**
  31777. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  31778. */
  31779. get velocityIterations(): number;
  31780. /**
  31781. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  31782. */
  31783. set velocityIterations(value: number);
  31784. /**
  31785. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  31786. */
  31787. get positionIterations(): number;
  31788. /**
  31789. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  31790. */
  31791. set positionIterations(value: number);
  31792. /**
  31793. * The unique id of the physics imposter
  31794. * set by the physics engine when adding this impostor to the array
  31795. */
  31796. uniqueId: number;
  31797. /**
  31798. * @hidden
  31799. */
  31800. soft: boolean;
  31801. /**
  31802. * @hidden
  31803. */
  31804. segments: number;
  31805. private _joints;
  31806. /**
  31807. * Initializes the physics imposter
  31808. * @param object The physics-enabled object used as the physics imposter
  31809. * @param type The type of the physics imposter
  31810. * @param _options The options for the physics imposter
  31811. * @param _scene The Babylon scene
  31812. */
  31813. constructor(
  31814. /**
  31815. * The physics-enabled object used as the physics imposter
  31816. */
  31817. object: IPhysicsEnabledObject,
  31818. /**
  31819. * The type of the physics imposter
  31820. */
  31821. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  31822. /**
  31823. * This function will completly initialize this impostor.
  31824. * It will create a new body - but only if this mesh has no parent.
  31825. * If it has, this impostor will not be used other than to define the impostor
  31826. * of the child mesh.
  31827. * @hidden
  31828. */
  31829. _init(): void;
  31830. private _getPhysicsParent;
  31831. /**
  31832. * Should a new body be generated.
  31833. * @returns boolean specifying if body initialization is required
  31834. */
  31835. isBodyInitRequired(): boolean;
  31836. /**
  31837. * Sets the updated scaling
  31838. * @param updated Specifies if the scaling is updated
  31839. */
  31840. setScalingUpdated(): void;
  31841. /**
  31842. * Force a regeneration of this or the parent's impostor's body.
  31843. * Use under cautious - This will remove all joints already implemented.
  31844. */
  31845. forceUpdate(): void;
  31846. /**
  31847. * Gets the body that holds this impostor. Either its own, or its parent.
  31848. */
  31849. get physicsBody(): any;
  31850. /**
  31851. * Get the parent of the physics imposter
  31852. * @returns Physics imposter or null
  31853. */
  31854. get parent(): Nullable<PhysicsImpostor>;
  31855. /**
  31856. * Sets the parent of the physics imposter
  31857. */
  31858. set parent(value: Nullable<PhysicsImpostor>);
  31859. /**
  31860. * Set the physics body. Used mainly by the physics engine/plugin
  31861. */
  31862. set physicsBody(physicsBody: any);
  31863. /**
  31864. * Resets the update flags
  31865. */
  31866. resetUpdateFlags(): void;
  31867. /**
  31868. * Gets the object extend size
  31869. * @returns the object extend size
  31870. */
  31871. getObjectExtendSize(): Vector3;
  31872. /**
  31873. * Gets the object center
  31874. * @returns The object center
  31875. */
  31876. getObjectCenter(): Vector3;
  31877. /**
  31878. * Get a specific parameter from the options parameters
  31879. * @param paramName The object parameter name
  31880. * @returns The object parameter
  31881. */
  31882. getParam(paramName: string): any;
  31883. /**
  31884. * Sets a specific parameter in the options given to the physics plugin
  31885. * @param paramName The parameter name
  31886. * @param value The value of the parameter
  31887. */
  31888. setParam(paramName: string, value: number): void;
  31889. /**
  31890. * Specifically change the body's mass option. Won't recreate the physics body object
  31891. * @param mass The mass of the physics imposter
  31892. */
  31893. setMass(mass: number): void;
  31894. /**
  31895. * Gets the linear velocity
  31896. * @returns linear velocity or null
  31897. */
  31898. getLinearVelocity(): Nullable<Vector3>;
  31899. /**
  31900. * Sets the linear velocity
  31901. * @param velocity linear velocity or null
  31902. */
  31903. setLinearVelocity(velocity: Nullable<Vector3>): void;
  31904. /**
  31905. * Gets the angular velocity
  31906. * @returns angular velocity or null
  31907. */
  31908. getAngularVelocity(): Nullable<Vector3>;
  31909. /**
  31910. * Sets the angular velocity
  31911. * @param velocity The velocity or null
  31912. */
  31913. setAngularVelocity(velocity: Nullable<Vector3>): void;
  31914. /**
  31915. * Execute a function with the physics plugin native code
  31916. * Provide a function the will have two variables - the world object and the physics body object
  31917. * @param func The function to execute with the physics plugin native code
  31918. */
  31919. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  31920. /**
  31921. * Register a function that will be executed before the physics world is stepping forward
  31922. * @param func The function to execute before the physics world is stepped forward
  31923. */
  31924. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  31925. /**
  31926. * Unregister a function that will be executed before the physics world is stepping forward
  31927. * @param func The function to execute before the physics world is stepped forward
  31928. */
  31929. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  31930. /**
  31931. * Register a function that will be executed after the physics step
  31932. * @param func The function to execute after physics step
  31933. */
  31934. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  31935. /**
  31936. * Unregisters a function that will be executed after the physics step
  31937. * @param func The function to execute after physics step
  31938. */
  31939. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  31940. /**
  31941. * register a function that will be executed when this impostor collides against a different body
  31942. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  31943. * @param func Callback that is executed on collision
  31944. */
  31945. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  31946. /**
  31947. * Unregisters the physics imposter on contact
  31948. * @param collideAgainst The physics object to collide against
  31949. * @param func Callback to execute on collision
  31950. */
  31951. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  31952. private _tmpQuat;
  31953. private _tmpQuat2;
  31954. /**
  31955. * Get the parent rotation
  31956. * @returns The parent rotation
  31957. */
  31958. getParentsRotation(): Quaternion;
  31959. /**
  31960. * this function is executed by the physics engine.
  31961. */
  31962. beforeStep: () => void;
  31963. /**
  31964. * this function is executed by the physics engine
  31965. */
  31966. afterStep: () => void;
  31967. /**
  31968. * Legacy collision detection event support
  31969. */
  31970. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  31971. /**
  31972. * event and body object due to cannon's event-based architecture.
  31973. */
  31974. onCollide: (e: {
  31975. body: any;
  31976. point: Nullable<Vector3>;
  31977. }) => void;
  31978. /**
  31979. * Apply a force
  31980. * @param force The force to apply
  31981. * @param contactPoint The contact point for the force
  31982. * @returns The physics imposter
  31983. */
  31984. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  31985. /**
  31986. * Apply an impulse
  31987. * @param force The impulse force
  31988. * @param contactPoint The contact point for the impulse force
  31989. * @returns The physics imposter
  31990. */
  31991. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  31992. /**
  31993. * A help function to create a joint
  31994. * @param otherImpostor A physics imposter used to create a joint
  31995. * @param jointType The type of joint
  31996. * @param jointData The data for the joint
  31997. * @returns The physics imposter
  31998. */
  31999. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  32000. /**
  32001. * Add a joint to this impostor with a different impostor
  32002. * @param otherImpostor A physics imposter used to add a joint
  32003. * @param joint The joint to add
  32004. * @returns The physics imposter
  32005. */
  32006. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  32007. /**
  32008. * Add an anchor to a cloth impostor
  32009. * @param otherImpostor rigid impostor to anchor to
  32010. * @param width ratio across width from 0 to 1
  32011. * @param height ratio up height from 0 to 1
  32012. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  32013. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  32014. * @returns impostor the soft imposter
  32015. */
  32016. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  32017. /**
  32018. * Add a hook to a rope impostor
  32019. * @param otherImpostor rigid impostor to anchor to
  32020. * @param length ratio across rope from 0 to 1
  32021. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  32022. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  32023. * @returns impostor the rope imposter
  32024. */
  32025. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  32026. /**
  32027. * Will keep this body still, in a sleep mode.
  32028. * @returns the physics imposter
  32029. */
  32030. sleep(): PhysicsImpostor;
  32031. /**
  32032. * Wake the body up.
  32033. * @returns The physics imposter
  32034. */
  32035. wakeUp(): PhysicsImpostor;
  32036. /**
  32037. * Clones the physics imposter
  32038. * @param newObject The physics imposter clones to this physics-enabled object
  32039. * @returns A nullable physics imposter
  32040. */
  32041. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  32042. /**
  32043. * Disposes the physics imposter
  32044. */
  32045. dispose(): void;
  32046. /**
  32047. * Sets the delta position
  32048. * @param position The delta position amount
  32049. */
  32050. setDeltaPosition(position: Vector3): void;
  32051. /**
  32052. * Sets the delta rotation
  32053. * @param rotation The delta rotation amount
  32054. */
  32055. setDeltaRotation(rotation: Quaternion): void;
  32056. /**
  32057. * Gets the box size of the physics imposter and stores the result in the input parameter
  32058. * @param result Stores the box size
  32059. * @returns The physics imposter
  32060. */
  32061. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  32062. /**
  32063. * Gets the radius of the physics imposter
  32064. * @returns Radius of the physics imposter
  32065. */
  32066. getRadius(): number;
  32067. /**
  32068. * Sync a bone with this impostor
  32069. * @param bone The bone to sync to the impostor.
  32070. * @param boneMesh The mesh that the bone is influencing.
  32071. * @param jointPivot The pivot of the joint / bone in local space.
  32072. * @param distToJoint Optional distance from the impostor to the joint.
  32073. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  32074. */
  32075. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  32076. /**
  32077. * Sync impostor to a bone
  32078. * @param bone The bone that the impostor will be synced to.
  32079. * @param boneMesh The mesh that the bone is influencing.
  32080. * @param jointPivot The pivot of the joint / bone in local space.
  32081. * @param distToJoint Optional distance from the impostor to the joint.
  32082. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  32083. * @param boneAxis Optional vector3 axis the bone is aligned with
  32084. */
  32085. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  32086. /**
  32087. * No-Imposter type
  32088. */
  32089. static NoImpostor: number;
  32090. /**
  32091. * Sphere-Imposter type
  32092. */
  32093. static SphereImpostor: number;
  32094. /**
  32095. * Box-Imposter type
  32096. */
  32097. static BoxImpostor: number;
  32098. /**
  32099. * Plane-Imposter type
  32100. */
  32101. static PlaneImpostor: number;
  32102. /**
  32103. * Mesh-imposter type
  32104. */
  32105. static MeshImpostor: number;
  32106. /**
  32107. * Capsule-Impostor type (Ammo.js plugin only)
  32108. */
  32109. static CapsuleImpostor: number;
  32110. /**
  32111. * Cylinder-Imposter type
  32112. */
  32113. static CylinderImpostor: number;
  32114. /**
  32115. * Particle-Imposter type
  32116. */
  32117. static ParticleImpostor: number;
  32118. /**
  32119. * Heightmap-Imposter type
  32120. */
  32121. static HeightmapImpostor: number;
  32122. /**
  32123. * ConvexHull-Impostor type (Ammo.js plugin only)
  32124. */
  32125. static ConvexHullImpostor: number;
  32126. /**
  32127. * Custom-Imposter type (Ammo.js plugin only)
  32128. */
  32129. static CustomImpostor: number;
  32130. /**
  32131. * Rope-Imposter type
  32132. */
  32133. static RopeImpostor: number;
  32134. /**
  32135. * Cloth-Imposter type
  32136. */
  32137. static ClothImpostor: number;
  32138. /**
  32139. * Softbody-Imposter type
  32140. */
  32141. static SoftbodyImpostor: number;
  32142. }
  32143. }
  32144. declare module BABYLON {
  32145. /**
  32146. * @hidden
  32147. **/
  32148. export class _CreationDataStorage {
  32149. closePath?: boolean;
  32150. closeArray?: boolean;
  32151. idx: number[];
  32152. dashSize: number;
  32153. gapSize: number;
  32154. path3D: Path3D;
  32155. pathArray: Vector3[][];
  32156. arc: number;
  32157. radius: number;
  32158. cap: number;
  32159. tessellation: number;
  32160. }
  32161. /**
  32162. * @hidden
  32163. **/
  32164. class _InstanceDataStorage {
  32165. visibleInstances: any;
  32166. batchCache: _InstancesBatch;
  32167. instancesBufferSize: number;
  32168. instancesBuffer: Nullable<Buffer>;
  32169. instancesData: Float32Array;
  32170. overridenInstanceCount: number;
  32171. isFrozen: boolean;
  32172. previousBatch: Nullable<_InstancesBatch>;
  32173. hardwareInstancedRendering: boolean;
  32174. sideOrientation: number;
  32175. manualUpdate: boolean;
  32176. previousRenderId: number;
  32177. }
  32178. /**
  32179. * @hidden
  32180. **/
  32181. export class _InstancesBatch {
  32182. mustReturn: boolean;
  32183. visibleInstances: Nullable<InstancedMesh[]>[];
  32184. renderSelf: boolean[];
  32185. hardwareInstancedRendering: boolean[];
  32186. }
  32187. /**
  32188. * @hidden
  32189. **/
  32190. class _ThinInstanceDataStorage {
  32191. instancesCount: number;
  32192. matrixBuffer: Nullable<Buffer>;
  32193. matrixBufferSize: number;
  32194. matrixData: Nullable<Float32Array>;
  32195. boundingVectors: Array<Vector3>;
  32196. worldMatrices: Nullable<Matrix[]>;
  32197. }
  32198. /**
  32199. * Class used to represent renderable models
  32200. */
  32201. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  32202. /**
  32203. * Mesh side orientation : usually the external or front surface
  32204. */
  32205. static readonly FRONTSIDE: number;
  32206. /**
  32207. * Mesh side orientation : usually the internal or back surface
  32208. */
  32209. static readonly BACKSIDE: number;
  32210. /**
  32211. * Mesh side orientation : both internal and external or front and back surfaces
  32212. */
  32213. static readonly DOUBLESIDE: number;
  32214. /**
  32215. * Mesh side orientation : by default, `FRONTSIDE`
  32216. */
  32217. static readonly DEFAULTSIDE: number;
  32218. /**
  32219. * Mesh cap setting : no cap
  32220. */
  32221. static readonly NO_CAP: number;
  32222. /**
  32223. * Mesh cap setting : one cap at the beginning of the mesh
  32224. */
  32225. static readonly CAP_START: number;
  32226. /**
  32227. * Mesh cap setting : one cap at the end of the mesh
  32228. */
  32229. static readonly CAP_END: number;
  32230. /**
  32231. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  32232. */
  32233. static readonly CAP_ALL: number;
  32234. /**
  32235. * Mesh pattern setting : no flip or rotate
  32236. */
  32237. static readonly NO_FLIP: number;
  32238. /**
  32239. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  32240. */
  32241. static readonly FLIP_TILE: number;
  32242. /**
  32243. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  32244. */
  32245. static readonly ROTATE_TILE: number;
  32246. /**
  32247. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  32248. */
  32249. static readonly FLIP_ROW: number;
  32250. /**
  32251. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  32252. */
  32253. static readonly ROTATE_ROW: number;
  32254. /**
  32255. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  32256. */
  32257. static readonly FLIP_N_ROTATE_TILE: number;
  32258. /**
  32259. * Mesh pattern setting : rotate pattern and rotate
  32260. */
  32261. static readonly FLIP_N_ROTATE_ROW: number;
  32262. /**
  32263. * Mesh tile positioning : part tiles same on left/right or top/bottom
  32264. */
  32265. static readonly CENTER: number;
  32266. /**
  32267. * Mesh tile positioning : part tiles on left
  32268. */
  32269. static readonly LEFT: number;
  32270. /**
  32271. * Mesh tile positioning : part tiles on right
  32272. */
  32273. static readonly RIGHT: number;
  32274. /**
  32275. * Mesh tile positioning : part tiles on top
  32276. */
  32277. static readonly TOP: number;
  32278. /**
  32279. * Mesh tile positioning : part tiles on bottom
  32280. */
  32281. static readonly BOTTOM: number;
  32282. /**
  32283. * Gets the default side orientation.
  32284. * @param orientation the orientation to value to attempt to get
  32285. * @returns the default orientation
  32286. * @hidden
  32287. */
  32288. static _GetDefaultSideOrientation(orientation?: number): number;
  32289. private _internalMeshDataInfo;
  32290. get computeBonesUsingShaders(): boolean;
  32291. set computeBonesUsingShaders(value: boolean);
  32292. /**
  32293. * An event triggered before rendering the mesh
  32294. */
  32295. get onBeforeRenderObservable(): Observable<Mesh>;
  32296. /**
  32297. * An event triggered before binding the mesh
  32298. */
  32299. get onBeforeBindObservable(): Observable<Mesh>;
  32300. /**
  32301. * An event triggered after rendering the mesh
  32302. */
  32303. get onAfterRenderObservable(): Observable<Mesh>;
  32304. /**
  32305. * An event triggered before drawing the mesh
  32306. */
  32307. get onBeforeDrawObservable(): Observable<Mesh>;
  32308. private _onBeforeDrawObserver;
  32309. /**
  32310. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  32311. */
  32312. set onBeforeDraw(callback: () => void);
  32313. get hasInstances(): boolean;
  32314. get hasThinInstances(): boolean;
  32315. /**
  32316. * Gets the delay loading state of the mesh (when delay loading is turned on)
  32317. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  32318. */
  32319. delayLoadState: number;
  32320. /**
  32321. * Gets the list of instances created from this mesh
  32322. * it is not supposed to be modified manually.
  32323. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  32324. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  32325. */
  32326. instances: InstancedMesh[];
  32327. /**
  32328. * Gets the file containing delay loading data for this mesh
  32329. */
  32330. delayLoadingFile: string;
  32331. /** @hidden */
  32332. _binaryInfo: any;
  32333. /**
  32334. * User defined function used to change how LOD level selection is done
  32335. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  32336. */
  32337. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  32338. /**
  32339. * Gets or sets the morph target manager
  32340. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  32341. */
  32342. get morphTargetManager(): Nullable<MorphTargetManager>;
  32343. set morphTargetManager(value: Nullable<MorphTargetManager>);
  32344. /** @hidden */
  32345. _creationDataStorage: Nullable<_CreationDataStorage>;
  32346. /** @hidden */
  32347. _geometry: Nullable<Geometry>;
  32348. /** @hidden */
  32349. _delayInfo: Array<string>;
  32350. /** @hidden */
  32351. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  32352. /** @hidden */
  32353. _instanceDataStorage: _InstanceDataStorage;
  32354. /** @hidden */
  32355. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  32356. private _effectiveMaterial;
  32357. /** @hidden */
  32358. _shouldGenerateFlatShading: boolean;
  32359. /** @hidden */
  32360. _originalBuilderSideOrientation: number;
  32361. /**
  32362. * Use this property to change the original side orientation defined at construction time
  32363. */
  32364. overrideMaterialSideOrientation: Nullable<number>;
  32365. /**
  32366. * Gets the source mesh (the one used to clone this one from)
  32367. */
  32368. get source(): Nullable<Mesh>;
  32369. /**
  32370. * Gets the list of clones of this mesh
  32371. * The scene must have been constructed with useClonedMeshMap=true for this to work!
  32372. * Note that useClonedMeshMap=true is the default setting
  32373. */
  32374. get cloneMeshMap(): Nullable<{
  32375. [id: string]: Mesh | undefined;
  32376. }>;
  32377. /**
  32378. * Gets or sets a boolean indicating that this mesh does not use index buffer
  32379. */
  32380. get isUnIndexed(): boolean;
  32381. set isUnIndexed(value: boolean);
  32382. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  32383. get worldMatrixInstancedBuffer(): Float32Array;
  32384. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  32385. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  32386. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  32387. /**
  32388. * @constructor
  32389. * @param name The value used by scene.getMeshByName() to do a lookup.
  32390. * @param scene The scene to add this mesh to.
  32391. * @param parent The parent of this mesh, if it has one
  32392. * @param source An optional Mesh from which geometry is shared, cloned.
  32393. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  32394. * When false, achieved by calling a clone(), also passing False.
  32395. * This will make creation of children, recursive.
  32396. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  32397. */
  32398. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  32399. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  32400. doNotInstantiate: boolean;
  32401. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  32402. /**
  32403. * Gets the class name
  32404. * @returns the string "Mesh".
  32405. */
  32406. getClassName(): string;
  32407. /** @hidden */
  32408. get _isMesh(): boolean;
  32409. /**
  32410. * Returns a description of this mesh
  32411. * @param fullDetails define if full details about this mesh must be used
  32412. * @returns a descriptive string representing this mesh
  32413. */
  32414. toString(fullDetails?: boolean): string;
  32415. /** @hidden */
  32416. _unBindEffect(): void;
  32417. /**
  32418. * Gets a boolean indicating if this mesh has LOD
  32419. */
  32420. get hasLODLevels(): boolean;
  32421. /**
  32422. * Gets the list of MeshLODLevel associated with the current mesh
  32423. * @returns an array of MeshLODLevel
  32424. */
  32425. getLODLevels(): MeshLODLevel[];
  32426. private _sortLODLevels;
  32427. /**
  32428. * Add a mesh as LOD level triggered at the given distance.
  32429. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  32430. * @param distance The distance from the center of the object to show this level
  32431. * @param mesh The mesh to be added as LOD level (can be null)
  32432. * @return This mesh (for chaining)
  32433. */
  32434. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  32435. /**
  32436. * Returns the LOD level mesh at the passed distance or null if not found.
  32437. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  32438. * @param distance The distance from the center of the object to show this level
  32439. * @returns a Mesh or `null`
  32440. */
  32441. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  32442. /**
  32443. * Remove a mesh from the LOD array
  32444. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  32445. * @param mesh defines the mesh to be removed
  32446. * @return This mesh (for chaining)
  32447. */
  32448. removeLODLevel(mesh: Mesh): Mesh;
  32449. /**
  32450. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  32451. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  32452. * @param camera defines the camera to use to compute distance
  32453. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  32454. * @return This mesh (for chaining)
  32455. */
  32456. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  32457. /**
  32458. * Gets the mesh internal Geometry object
  32459. */
  32460. get geometry(): Nullable<Geometry>;
  32461. /**
  32462. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  32463. * @returns the total number of vertices
  32464. */
  32465. getTotalVertices(): number;
  32466. /**
  32467. * Returns the content of an associated vertex buffer
  32468. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  32469. * - VertexBuffer.PositionKind
  32470. * - VertexBuffer.UVKind
  32471. * - VertexBuffer.UV2Kind
  32472. * - VertexBuffer.UV3Kind
  32473. * - VertexBuffer.UV4Kind
  32474. * - VertexBuffer.UV5Kind
  32475. * - VertexBuffer.UV6Kind
  32476. * - VertexBuffer.ColorKind
  32477. * - VertexBuffer.MatricesIndicesKind
  32478. * - VertexBuffer.MatricesIndicesExtraKind
  32479. * - VertexBuffer.MatricesWeightsKind
  32480. * - VertexBuffer.MatricesWeightsExtraKind
  32481. * @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
  32482. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  32483. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  32484. */
  32485. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  32486. /**
  32487. * Returns the mesh VertexBuffer object from the requested `kind`
  32488. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  32489. * - VertexBuffer.PositionKind
  32490. * - VertexBuffer.NormalKind
  32491. * - VertexBuffer.UVKind
  32492. * - VertexBuffer.UV2Kind
  32493. * - VertexBuffer.UV3Kind
  32494. * - VertexBuffer.UV4Kind
  32495. * - VertexBuffer.UV5Kind
  32496. * - VertexBuffer.UV6Kind
  32497. * - VertexBuffer.ColorKind
  32498. * - VertexBuffer.MatricesIndicesKind
  32499. * - VertexBuffer.MatricesIndicesExtraKind
  32500. * - VertexBuffer.MatricesWeightsKind
  32501. * - VertexBuffer.MatricesWeightsExtraKind
  32502. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  32503. */
  32504. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  32505. /**
  32506. * Tests if a specific vertex buffer is associated with this mesh
  32507. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  32508. * - VertexBuffer.PositionKind
  32509. * - VertexBuffer.NormalKind
  32510. * - VertexBuffer.UVKind
  32511. * - VertexBuffer.UV2Kind
  32512. * - VertexBuffer.UV3Kind
  32513. * - VertexBuffer.UV4Kind
  32514. * - VertexBuffer.UV5Kind
  32515. * - VertexBuffer.UV6Kind
  32516. * - VertexBuffer.ColorKind
  32517. * - VertexBuffer.MatricesIndicesKind
  32518. * - VertexBuffer.MatricesIndicesExtraKind
  32519. * - VertexBuffer.MatricesWeightsKind
  32520. * - VertexBuffer.MatricesWeightsExtraKind
  32521. * @returns a boolean
  32522. */
  32523. isVerticesDataPresent(kind: string): boolean;
  32524. /**
  32525. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  32526. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  32527. * - VertexBuffer.PositionKind
  32528. * - VertexBuffer.UVKind
  32529. * - VertexBuffer.UV2Kind
  32530. * - VertexBuffer.UV3Kind
  32531. * - VertexBuffer.UV4Kind
  32532. * - VertexBuffer.UV5Kind
  32533. * - VertexBuffer.UV6Kind
  32534. * - VertexBuffer.ColorKind
  32535. * - VertexBuffer.MatricesIndicesKind
  32536. * - VertexBuffer.MatricesIndicesExtraKind
  32537. * - VertexBuffer.MatricesWeightsKind
  32538. * - VertexBuffer.MatricesWeightsExtraKind
  32539. * @returns a boolean
  32540. */
  32541. isVertexBufferUpdatable(kind: string): boolean;
  32542. /**
  32543. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  32544. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  32545. * - VertexBuffer.PositionKind
  32546. * - VertexBuffer.NormalKind
  32547. * - VertexBuffer.UVKind
  32548. * - VertexBuffer.UV2Kind
  32549. * - VertexBuffer.UV3Kind
  32550. * - VertexBuffer.UV4Kind
  32551. * - VertexBuffer.UV5Kind
  32552. * - VertexBuffer.UV6Kind
  32553. * - VertexBuffer.ColorKind
  32554. * - VertexBuffer.MatricesIndicesKind
  32555. * - VertexBuffer.MatricesIndicesExtraKind
  32556. * - VertexBuffer.MatricesWeightsKind
  32557. * - VertexBuffer.MatricesWeightsExtraKind
  32558. * @returns an array of strings
  32559. */
  32560. getVerticesDataKinds(): string[];
  32561. /**
  32562. * Returns a positive integer : the total number of indices in this mesh geometry.
  32563. * @returns the numner of indices or zero if the mesh has no geometry.
  32564. */
  32565. getTotalIndices(): number;
  32566. /**
  32567. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  32568. * @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.
  32569. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  32570. * @returns the indices array or an empty array if the mesh has no geometry
  32571. */
  32572. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  32573. get isBlocked(): boolean;
  32574. /**
  32575. * Determine if the current mesh is ready to be rendered
  32576. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  32577. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  32578. * @returns true if all associated assets are ready (material, textures, shaders)
  32579. */
  32580. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  32581. /**
  32582. * 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.
  32583. */
  32584. get areNormalsFrozen(): boolean;
  32585. /**
  32586. * 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.
  32587. * @returns the current mesh
  32588. */
  32589. freezeNormals(): Mesh;
  32590. /**
  32591. * 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
  32592. * @returns the current mesh
  32593. */
  32594. unfreezeNormals(): Mesh;
  32595. /**
  32596. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  32597. */
  32598. set overridenInstanceCount(count: number);
  32599. /** @hidden */
  32600. _preActivate(): Mesh;
  32601. /** @hidden */
  32602. _preActivateForIntermediateRendering(renderId: number): Mesh;
  32603. /** @hidden */
  32604. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  32605. protected _afterComputeWorldMatrix(): void;
  32606. /** @hidden */
  32607. _postActivate(): void;
  32608. /**
  32609. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  32610. * This means the mesh underlying bounding box and sphere are recomputed.
  32611. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  32612. * @returns the current mesh
  32613. */
  32614. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  32615. /** @hidden */
  32616. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  32617. /**
  32618. * This function will subdivide the mesh into multiple submeshes
  32619. * @param count defines the expected number of submeshes
  32620. */
  32621. subdivide(count: number): void;
  32622. /**
  32623. * Copy a FloatArray into a specific associated vertex buffer
  32624. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  32625. * - VertexBuffer.PositionKind
  32626. * - VertexBuffer.UVKind
  32627. * - VertexBuffer.UV2Kind
  32628. * - VertexBuffer.UV3Kind
  32629. * - VertexBuffer.UV4Kind
  32630. * - VertexBuffer.UV5Kind
  32631. * - VertexBuffer.UV6Kind
  32632. * - VertexBuffer.ColorKind
  32633. * - VertexBuffer.MatricesIndicesKind
  32634. * - VertexBuffer.MatricesIndicesExtraKind
  32635. * - VertexBuffer.MatricesWeightsKind
  32636. * - VertexBuffer.MatricesWeightsExtraKind
  32637. * @param data defines the data source
  32638. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  32639. * @param stride defines the data stride size (can be null)
  32640. * @returns the current mesh
  32641. */
  32642. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  32643. /**
  32644. * Delete a vertex buffer associated with this mesh
  32645. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  32646. * - VertexBuffer.PositionKind
  32647. * - VertexBuffer.UVKind
  32648. * - VertexBuffer.UV2Kind
  32649. * - VertexBuffer.UV3Kind
  32650. * - VertexBuffer.UV4Kind
  32651. * - VertexBuffer.UV5Kind
  32652. * - VertexBuffer.UV6Kind
  32653. * - VertexBuffer.ColorKind
  32654. * - VertexBuffer.MatricesIndicesKind
  32655. * - VertexBuffer.MatricesIndicesExtraKind
  32656. * - VertexBuffer.MatricesWeightsKind
  32657. * - VertexBuffer.MatricesWeightsExtraKind
  32658. */
  32659. removeVerticesData(kind: string): void;
  32660. /**
  32661. * Flags an associated vertex buffer as updatable
  32662. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  32663. * - VertexBuffer.PositionKind
  32664. * - VertexBuffer.UVKind
  32665. * - VertexBuffer.UV2Kind
  32666. * - VertexBuffer.UV3Kind
  32667. * - VertexBuffer.UV4Kind
  32668. * - VertexBuffer.UV5Kind
  32669. * - VertexBuffer.UV6Kind
  32670. * - VertexBuffer.ColorKind
  32671. * - VertexBuffer.MatricesIndicesKind
  32672. * - VertexBuffer.MatricesIndicesExtraKind
  32673. * - VertexBuffer.MatricesWeightsKind
  32674. * - VertexBuffer.MatricesWeightsExtraKind
  32675. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  32676. */
  32677. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  32678. /**
  32679. * Sets the mesh global Vertex Buffer
  32680. * @param buffer defines the buffer to use
  32681. * @returns the current mesh
  32682. */
  32683. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  32684. /**
  32685. * Update a specific associated vertex buffer
  32686. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  32687. * - VertexBuffer.PositionKind
  32688. * - VertexBuffer.UVKind
  32689. * - VertexBuffer.UV2Kind
  32690. * - VertexBuffer.UV3Kind
  32691. * - VertexBuffer.UV4Kind
  32692. * - VertexBuffer.UV5Kind
  32693. * - VertexBuffer.UV6Kind
  32694. * - VertexBuffer.ColorKind
  32695. * - VertexBuffer.MatricesIndicesKind
  32696. * - VertexBuffer.MatricesIndicesExtraKind
  32697. * - VertexBuffer.MatricesWeightsKind
  32698. * - VertexBuffer.MatricesWeightsExtraKind
  32699. * @param data defines the data source
  32700. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  32701. * @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)
  32702. * @returns the current mesh
  32703. */
  32704. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  32705. /**
  32706. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  32707. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  32708. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  32709. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  32710. * @returns the current mesh
  32711. */
  32712. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  32713. /**
  32714. * Creates a un-shared specific occurence of the geometry for the mesh.
  32715. * @returns the current mesh
  32716. */
  32717. makeGeometryUnique(): Mesh;
  32718. /**
  32719. * Set the index buffer of this mesh
  32720. * @param indices defines the source data
  32721. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  32722. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  32723. * @returns the current mesh
  32724. */
  32725. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  32726. /**
  32727. * Update the current index buffer
  32728. * @param indices defines the source data
  32729. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  32730. * @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)
  32731. * @returns the current mesh
  32732. */
  32733. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  32734. /**
  32735. * Invert the geometry to move from a right handed system to a left handed one.
  32736. * @returns the current mesh
  32737. */
  32738. toLeftHanded(): Mesh;
  32739. /** @hidden */
  32740. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  32741. /** @hidden */
  32742. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  32743. /**
  32744. * Registers for this mesh a javascript function called just before the rendering process
  32745. * @param func defines the function to call before rendering this mesh
  32746. * @returns the current mesh
  32747. */
  32748. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  32749. /**
  32750. * Disposes a previously registered javascript function called before the rendering
  32751. * @param func defines the function to remove
  32752. * @returns the current mesh
  32753. */
  32754. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  32755. /**
  32756. * Registers for this mesh a javascript function called just after the rendering is complete
  32757. * @param func defines the function to call after rendering this mesh
  32758. * @returns the current mesh
  32759. */
  32760. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  32761. /**
  32762. * Disposes a previously registered javascript function called after the rendering.
  32763. * @param func defines the function to remove
  32764. * @returns the current mesh
  32765. */
  32766. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  32767. /** @hidden */
  32768. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  32769. /** @hidden */
  32770. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  32771. /** @hidden */
  32772. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  32773. /** @hidden */
  32774. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  32775. /** @hidden */
  32776. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  32777. /** @hidden */
  32778. _rebuild(): void;
  32779. /** @hidden */
  32780. _freeze(): void;
  32781. /** @hidden */
  32782. _unFreeze(): void;
  32783. /**
  32784. * 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
  32785. * @param subMesh defines the subMesh to render
  32786. * @param enableAlphaMode defines if alpha mode can be changed
  32787. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  32788. * @returns the current mesh
  32789. */
  32790. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  32791. private _onBeforeDraw;
  32792. /**
  32793. * Renormalize the mesh and patch it up if there are no weights
  32794. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  32795. * However in the case of zero weights then we set just a single influence to 1.
  32796. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  32797. */
  32798. cleanMatrixWeights(): void;
  32799. private normalizeSkinFourWeights;
  32800. private normalizeSkinWeightsAndExtra;
  32801. /**
  32802. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  32803. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  32804. * the user know there was an issue with importing the mesh
  32805. * @returns a validation object with skinned, valid and report string
  32806. */
  32807. validateSkinning(): {
  32808. skinned: boolean;
  32809. valid: boolean;
  32810. report: string;
  32811. };
  32812. /** @hidden */
  32813. _checkDelayState(): Mesh;
  32814. private _queueLoad;
  32815. /**
  32816. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  32817. * A mesh is in the frustum if its bounding box intersects the frustum
  32818. * @param frustumPlanes defines the frustum to test
  32819. * @returns true if the mesh is in the frustum planes
  32820. */
  32821. isInFrustum(frustumPlanes: Plane[]): boolean;
  32822. /**
  32823. * Sets the mesh material by the material or multiMaterial `id` property
  32824. * @param id is a string identifying the material or the multiMaterial
  32825. * @returns the current mesh
  32826. */
  32827. setMaterialByID(id: string): Mesh;
  32828. /**
  32829. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  32830. * @returns an array of IAnimatable
  32831. */
  32832. getAnimatables(): IAnimatable[];
  32833. /**
  32834. * Modifies the mesh geometry according to the passed transformation matrix.
  32835. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  32836. * The mesh normals are modified using the same transformation.
  32837. * Note that, under the hood, this method sets a new VertexBuffer each call.
  32838. * @param transform defines the transform matrix to use
  32839. * @see https://doc.babylonjs.com/resources/baking_transformations
  32840. * @returns the current mesh
  32841. */
  32842. bakeTransformIntoVertices(transform: Matrix): Mesh;
  32843. /**
  32844. * Modifies the mesh geometry according to its own current World Matrix.
  32845. * The mesh World Matrix is then reset.
  32846. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  32847. * Note that, under the hood, this method sets a new VertexBuffer each call.
  32848. * @see https://doc.babylonjs.com/resources/baking_transformations
  32849. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  32850. * @returns the current mesh
  32851. */
  32852. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  32853. /** @hidden */
  32854. get _positions(): Nullable<Vector3[]>;
  32855. /** @hidden */
  32856. _resetPointsArrayCache(): Mesh;
  32857. /** @hidden */
  32858. _generatePointsArray(): boolean;
  32859. /**
  32860. * Returns a new Mesh object generated from the current mesh properties.
  32861. * This method must not get confused with createInstance()
  32862. * @param name is a string, the name given to the new mesh
  32863. * @param newParent can be any Node object (default `null`)
  32864. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  32865. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  32866. * @returns a new mesh
  32867. */
  32868. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  32869. /**
  32870. * Releases resources associated with this mesh.
  32871. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  32872. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  32873. */
  32874. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  32875. /** @hidden */
  32876. _disposeInstanceSpecificData(): void;
  32877. /** @hidden */
  32878. _disposeThinInstanceSpecificData(): void;
  32879. /**
  32880. * Modifies the mesh geometry according to a displacement map.
  32881. * 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.
  32882. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  32883. * @param url is a string, the URL from the image file is to be downloaded.
  32884. * @param minHeight is the lower limit of the displacement.
  32885. * @param maxHeight is the upper limit of the displacement.
  32886. * @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.
  32887. * @param uvOffset is an optional vector2 used to offset UV.
  32888. * @param uvScale is an optional vector2 used to scale UV.
  32889. * @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.
  32890. * @returns the Mesh.
  32891. */
  32892. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  32893. /**
  32894. * Modifies the mesh geometry according to a displacementMap buffer.
  32895. * 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.
  32896. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  32897. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  32898. * @param heightMapWidth is the width of the buffer image.
  32899. * @param heightMapHeight is the height of the buffer image.
  32900. * @param minHeight is the lower limit of the displacement.
  32901. * @param maxHeight is the upper limit of the displacement.
  32902. * @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.
  32903. * @param uvOffset is an optional vector2 used to offset UV.
  32904. * @param uvScale is an optional vector2 used to scale UV.
  32905. * @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.
  32906. * @returns the Mesh.
  32907. */
  32908. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  32909. /**
  32910. * Modify the mesh to get a flat shading rendering.
  32911. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  32912. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  32913. * @returns current mesh
  32914. */
  32915. convertToFlatShadedMesh(): Mesh;
  32916. /**
  32917. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  32918. * In other words, more vertices, no more indices and a single bigger VBO.
  32919. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  32920. * @returns current mesh
  32921. */
  32922. convertToUnIndexedMesh(): Mesh;
  32923. /**
  32924. * Inverses facet orientations.
  32925. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  32926. * @param flipNormals will also inverts the normals
  32927. * @returns current mesh
  32928. */
  32929. flipFaces(flipNormals?: boolean): Mesh;
  32930. /**
  32931. * Increase the number of facets and hence vertices in a mesh
  32932. * Vertex normals are interpolated from existing vertex normals
  32933. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  32934. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  32935. */
  32936. increaseVertices(numberPerEdge: number): void;
  32937. /**
  32938. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  32939. * This will undo any application of covertToFlatShadedMesh
  32940. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  32941. */
  32942. forceSharedVertices(): void;
  32943. /** @hidden */
  32944. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  32945. /** @hidden */
  32946. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  32947. /**
  32948. * Creates a new InstancedMesh object from the mesh model.
  32949. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  32950. * @param name defines the name of the new instance
  32951. * @returns a new InstancedMesh
  32952. */
  32953. createInstance(name: string): InstancedMesh;
  32954. /**
  32955. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  32956. * After this call, all the mesh instances have the same submeshes than the current mesh.
  32957. * @returns the current mesh
  32958. */
  32959. synchronizeInstances(): Mesh;
  32960. /**
  32961. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  32962. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  32963. * This should be used together with the simplification to avoid disappearing triangles.
  32964. * @param successCallback an optional success callback to be called after the optimization finished.
  32965. * @returns the current mesh
  32966. */
  32967. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  32968. /**
  32969. * Serialize current mesh
  32970. * @param serializationObject defines the object which will receive the serialization data
  32971. */
  32972. serialize(serializationObject: any): void;
  32973. /** @hidden */
  32974. _syncGeometryWithMorphTargetManager(): void;
  32975. /** @hidden */
  32976. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  32977. /**
  32978. * Returns a new Mesh object parsed from the source provided.
  32979. * @param parsedMesh is the source
  32980. * @param scene defines the hosting scene
  32981. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  32982. * @returns a new Mesh
  32983. */
  32984. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  32985. /**
  32986. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  32987. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  32988. * @param name defines the name of the mesh to create
  32989. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  32990. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  32991. * @param closePath creates a seam between the first and the last points of each path of the path array
  32992. * @param offset is taken in account only if the `pathArray` is containing a single path
  32993. * @param scene defines the hosting scene
  32994. * @param updatable defines if the mesh must be flagged as updatable
  32995. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  32996. * @param instance defines 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)
  32997. * @returns a new Mesh
  32998. */
  32999. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  33000. /**
  33001. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  33002. * @param name defines the name of the mesh to create
  33003. * @param radius sets the radius size (float) of the polygon (default 0.5)
  33004. * @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
  33005. * @param scene defines the hosting scene
  33006. * @param updatable defines if the mesh must be flagged as updatable
  33007. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  33008. * @returns a new Mesh
  33009. */
  33010. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  33011. /**
  33012. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  33013. * @param name defines the name of the mesh to create
  33014. * @param size sets the size (float) of each box side (default 1)
  33015. * @param scene defines the hosting scene
  33016. * @param updatable defines if the mesh must be flagged as updatable
  33017. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  33018. * @returns a new Mesh
  33019. */
  33020. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  33021. /**
  33022. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  33023. * @param name defines the name of the mesh to create
  33024. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  33025. * @param diameter sets the diameter size (float) of the sphere (default 1)
  33026. * @param scene defines the hosting scene
  33027. * @param updatable defines if the mesh must be flagged as updatable
  33028. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  33029. * @returns a new Mesh
  33030. */
  33031. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  33032. /**
  33033. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  33034. * @param name defines the name of the mesh to create
  33035. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  33036. * @param diameter sets the diameter size (float) of the sphere (default 1)
  33037. * @param scene defines the hosting scene
  33038. * @returns a new Mesh
  33039. */
  33040. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  33041. /**
  33042. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  33043. * @param name defines the name of the mesh to create
  33044. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  33045. * @param diameterTop set the top cap diameter (floats, default 1)
  33046. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  33047. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  33048. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  33049. * @param scene defines the hosting scene
  33050. * @param updatable defines if the mesh must be flagged as updatable
  33051. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  33052. * @returns a new Mesh
  33053. */
  33054. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  33055. /**
  33056. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  33057. * @param name defines the name of the mesh to create
  33058. * @param diameter sets the diameter size (float) of the torus (default 1)
  33059. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  33060. * @param tessellation sets the number of torus sides (postive integer, default 16)
  33061. * @param scene defines the hosting scene
  33062. * @param updatable defines if the mesh must be flagged as updatable
  33063. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  33064. * @returns a new Mesh
  33065. */
  33066. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  33067. /**
  33068. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  33069. * @param name defines the name of the mesh to create
  33070. * @param radius sets the global radius size (float) of the torus knot (default 2)
  33071. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  33072. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  33073. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  33074. * @param p the number of windings on X axis (positive integers, default 2)
  33075. * @param q the number of windings on Y axis (positive integers, default 3)
  33076. * @param scene defines the hosting scene
  33077. * @param updatable defines if the mesh must be flagged as updatable
  33078. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  33079. * @returns a new Mesh
  33080. */
  33081. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  33082. /**
  33083. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  33084. * @param name defines the name of the mesh to create
  33085. * @param points is an array successive Vector3
  33086. * @param scene defines the hosting scene
  33087. * @param updatable defines if the mesh must be flagged as updatable
  33088. * @param 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).
  33089. * @returns a new Mesh
  33090. */
  33091. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  33092. /**
  33093. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  33094. * @param name defines the name of the mesh to create
  33095. * @param points is an array successive Vector3
  33096. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  33097. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  33098. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  33099. * @param scene defines the hosting scene
  33100. * @param updatable defines if the mesh must be flagged as updatable
  33101. * @param 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)
  33102. * @returns a new Mesh
  33103. */
  33104. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  33105. /**
  33106. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  33107. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  33108. * 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.
  33109. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  33110. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  33111. * Remember you can only change the shape positions, not their number when updating a polygon.
  33112. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  33113. * @param name defines the name of the mesh to create
  33114. * @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
  33115. * @param scene defines the hosting scene
  33116. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  33117. * @param updatable defines if the mesh must be flagged as updatable
  33118. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  33119. * @param earcutInjection can be used to inject your own earcut reference
  33120. * @returns a new Mesh
  33121. */
  33122. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  33123. /**
  33124. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  33125. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  33126. * @param name defines the name of the mesh to create
  33127. * @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
  33128. * @param depth defines the height of extrusion
  33129. * @param scene defines the hosting scene
  33130. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  33131. * @param updatable defines if the mesh must be flagged as updatable
  33132. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  33133. * @param earcutInjection can be used to inject your own earcut reference
  33134. * @returns a new Mesh
  33135. */
  33136. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  33137. /**
  33138. * Creates an extruded shape mesh.
  33139. * 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
  33140. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  33141. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  33142. * @param name defines the name of the mesh to create
  33143. * @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
  33144. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  33145. * @param scale is the value to scale the shape
  33146. * @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
  33147. * @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
  33148. * @param scene defines the hosting scene
  33149. * @param updatable defines if the mesh must be flagged as updatable
  33150. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  33151. * @param 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)
  33152. * @returns a new Mesh
  33153. */
  33154. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  33155. /**
  33156. * Creates an custom extruded shape mesh.
  33157. * The custom extrusion is a parametric shape.
  33158. * It has no predefined shape. Its final shape will depend on the input parameters.
  33159. * Please consider using the same method from the MeshBuilder class instead
  33160. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  33161. * @param name defines the name of the mesh to create
  33162. * @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
  33163. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  33164. * @param scaleFunction is a custom Javascript function called on each path point
  33165. * @param rotationFunction is a custom Javascript function called on each path point
  33166. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  33167. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  33168. * @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
  33169. * @param scene defines the hosting scene
  33170. * @param updatable defines if the mesh must be flagged as updatable
  33171. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  33172. * @param 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)
  33173. * @returns a new Mesh
  33174. */
  33175. 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;
  33176. /**
  33177. * Creates lathe mesh.
  33178. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  33179. * Please consider using the same method from the MeshBuilder class instead
  33180. * @param name defines the name of the mesh to create
  33181. * @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
  33182. * @param radius is the radius value of the lathe
  33183. * @param tessellation is the side number of the lathe.
  33184. * @param scene defines the hosting scene
  33185. * @param updatable defines if the mesh must be flagged as updatable
  33186. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  33187. * @returns a new Mesh
  33188. */
  33189. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  33190. /**
  33191. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  33192. * @param name defines the name of the mesh to create
  33193. * @param size sets the size (float) of both sides of the plane at once (default 1)
  33194. * @param scene defines the hosting scene
  33195. * @param updatable defines if the mesh must be flagged as updatable
  33196. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  33197. * @returns a new Mesh
  33198. */
  33199. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  33200. /**
  33201. * Creates a ground mesh.
  33202. * Please consider using the same method from the MeshBuilder class instead
  33203. * @param name defines the name of the mesh to create
  33204. * @param width set the width of the ground
  33205. * @param height set the height of the ground
  33206. * @param subdivisions sets the number of subdivisions per side
  33207. * @param scene defines the hosting scene
  33208. * @param updatable defines if the mesh must be flagged as updatable
  33209. * @returns a new Mesh
  33210. */
  33211. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  33212. /**
  33213. * Creates a tiled ground mesh.
  33214. * Please consider using the same method from the MeshBuilder class instead
  33215. * @param name defines the name of the mesh to create
  33216. * @param xmin set the ground minimum X coordinate
  33217. * @param zmin set the ground minimum Y coordinate
  33218. * @param xmax set the ground maximum X coordinate
  33219. * @param zmax set the ground maximum Z coordinate
  33220. * @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
  33221. * @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
  33222. * @param scene defines the hosting scene
  33223. * @param updatable defines if the mesh must be flagged as updatable
  33224. * @returns a new Mesh
  33225. */
  33226. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  33227. w: number;
  33228. h: number;
  33229. }, precision: {
  33230. w: number;
  33231. h: number;
  33232. }, scene: Scene, updatable?: boolean): Mesh;
  33233. /**
  33234. * Creates a ground mesh from a height map.
  33235. * Please consider using the same method from the MeshBuilder class instead
  33236. * @see https://doc.babylonjs.com/babylon101/height_map
  33237. * @param name defines the name of the mesh to create
  33238. * @param url sets the URL of the height map image resource
  33239. * @param width set the ground width size
  33240. * @param height set the ground height size
  33241. * @param subdivisions sets the number of subdivision per side
  33242. * @param minHeight is the minimum altitude on the ground
  33243. * @param maxHeight is the maximum altitude on the ground
  33244. * @param scene defines the hosting scene
  33245. * @param updatable defines if the mesh must be flagged as updatable
  33246. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  33247. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  33248. * @returns a new Mesh
  33249. */
  33250. 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;
  33251. /**
  33252. * Creates a tube mesh.
  33253. * The tube is a parametric shape.
  33254. * It has no predefined shape. Its final shape will depend on the input parameters.
  33255. * Please consider using the same method from the MeshBuilder class instead
  33256. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  33257. * @param name defines the name of the mesh to create
  33258. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  33259. * @param radius sets the tube radius size
  33260. * @param tessellation is the number of sides on the tubular surface
  33261. * @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
  33262. * @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
  33263. * @param scene defines the hosting scene
  33264. * @param updatable defines if the mesh must be flagged as updatable
  33265. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  33266. * @param 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)
  33267. * @returns a new Mesh
  33268. */
  33269. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  33270. (i: number, distance: number): number;
  33271. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  33272. /**
  33273. * Creates a polyhedron mesh.
  33274. * Please consider using the same method from the MeshBuilder class instead.
  33275. * * 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
  33276. * * The parameter `size` (positive float, default 1) sets the polygon size
  33277. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  33278. * * 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`
  33279. * * 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
  33280. * * 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)`)
  33281. * * 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
  33282. * * 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
  33283. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  33284. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  33285. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  33286. * @param name defines the name of the mesh to create
  33287. * @param options defines the options used to create the mesh
  33288. * @param scene defines the hosting scene
  33289. * @returns a new Mesh
  33290. */
  33291. static CreatePolyhedron(name: string, options: {
  33292. type?: number;
  33293. size?: number;
  33294. sizeX?: number;
  33295. sizeY?: number;
  33296. sizeZ?: number;
  33297. custom?: any;
  33298. faceUV?: Vector4[];
  33299. faceColors?: Color4[];
  33300. updatable?: boolean;
  33301. sideOrientation?: number;
  33302. }, scene: Scene): Mesh;
  33303. /**
  33304. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  33305. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  33306. * * 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`)
  33307. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  33308. * * 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
  33309. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  33310. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  33311. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  33312. * @param name defines the name of the mesh
  33313. * @param options defines the options used to create the mesh
  33314. * @param scene defines the hosting scene
  33315. * @returns a new Mesh
  33316. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  33317. */
  33318. static CreateIcoSphere(name: string, options: {
  33319. radius?: number;
  33320. flat?: boolean;
  33321. subdivisions?: number;
  33322. sideOrientation?: number;
  33323. updatable?: boolean;
  33324. }, scene: Scene): Mesh;
  33325. /**
  33326. * Creates a decal mesh.
  33327. * Please consider using the same method from the MeshBuilder class instead.
  33328. * A decal is a mesh usually applied as a model onto the surface of another mesh
  33329. * @param name defines the name of the mesh
  33330. * @param sourceMesh defines the mesh receiving the decal
  33331. * @param position sets the position of the decal in world coordinates
  33332. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  33333. * @param size sets the decal scaling
  33334. * @param angle sets the angle to rotate the decal
  33335. * @returns a new Mesh
  33336. */
  33337. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  33338. /** Creates a Capsule Mesh
  33339. * @param name defines the name of the mesh.
  33340. * @param options the constructors options used to shape the mesh.
  33341. * @param scene defines the scene the mesh is scoped to.
  33342. * @returns the capsule mesh
  33343. * @see https://doc.babylonjs.com/how_to/capsule_shape
  33344. */
  33345. static CreateCapsule(name: string, options: ICreateCapsuleOptions, scene: Scene): Mesh;
  33346. /**
  33347. * Prepare internal position array for software CPU skinning
  33348. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  33349. */
  33350. setPositionsForCPUSkinning(): Float32Array;
  33351. /**
  33352. * Prepare internal normal array for software CPU skinning
  33353. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  33354. */
  33355. setNormalsForCPUSkinning(): Float32Array;
  33356. /**
  33357. * Updates the vertex buffer by applying transformation from the bones
  33358. * @param skeleton defines the skeleton to apply to current mesh
  33359. * @returns the current mesh
  33360. */
  33361. applySkeleton(skeleton: Skeleton): Mesh;
  33362. /**
  33363. * 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
  33364. * @param meshes defines the list of meshes to scan
  33365. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  33366. */
  33367. static MinMax(meshes: AbstractMesh[]): {
  33368. min: Vector3;
  33369. max: Vector3;
  33370. };
  33371. /**
  33372. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  33373. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  33374. * @returns a vector3
  33375. */
  33376. static Center(meshesOrMinMaxVector: {
  33377. min: Vector3;
  33378. max: Vector3;
  33379. } | AbstractMesh[]): Vector3;
  33380. /**
  33381. * Merge the array of meshes into a single mesh for performance reasons.
  33382. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  33383. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  33384. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  33385. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  33386. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  33387. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  33388. * @returns a new mesh
  33389. */
  33390. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  33391. /** @hidden */
  33392. addInstance(instance: InstancedMesh): void;
  33393. /** @hidden */
  33394. removeInstance(instance: InstancedMesh): void;
  33395. }
  33396. }
  33397. declare module BABYLON {
  33398. /**
  33399. * The options Interface for creating a Capsule Mesh
  33400. */
  33401. export interface ICreateCapsuleOptions {
  33402. /** The Orientation of the capsule. Default : Vector3.Up() */
  33403. orientation?: Vector3;
  33404. /** Number of sub segments on the tube section of the capsule running parallel to orientation. */
  33405. subdivisions: number;
  33406. /** Number of cylindrical segments on the capsule. */
  33407. tessellation: number;
  33408. /** Height or Length of the capsule. */
  33409. height: number;
  33410. /** Radius of the capsule. */
  33411. radius: number;
  33412. /** Number of sub segments on the cap sections of the capsule running parallel to orientation. */
  33413. capSubdivisions: number;
  33414. /** Overwrite for the top radius. */
  33415. radiusTop?: number;
  33416. /** Overwrite for the bottom radius. */
  33417. radiusBottom?: number;
  33418. /** Overwrite for the top capSubdivisions. */
  33419. topCapSubdivisions?: number;
  33420. /** Overwrite for the bottom capSubdivisions. */
  33421. bottomCapSubdivisions?: number;
  33422. }
  33423. /**
  33424. * Class containing static functions to help procedurally build meshes
  33425. */
  33426. export class CapsuleBuilder {
  33427. /**
  33428. * Creates a capsule or a pill mesh
  33429. * @param name defines the name of the mesh
  33430. * @param options The constructors options.
  33431. * @param scene The scene the mesh is scoped to.
  33432. * @returns Capsule Mesh
  33433. */
  33434. static CreateCapsule(name: string, options: ICreateCapsuleOptions | undefined, scene: any): Mesh;
  33435. }
  33436. }
  33437. declare module BABYLON {
  33438. /**
  33439. * Define an interface for all classes that will get and set the data on vertices
  33440. */
  33441. export interface IGetSetVerticesData {
  33442. /**
  33443. * Gets a boolean indicating if specific vertex data is present
  33444. * @param kind defines the vertex data kind to use
  33445. * @returns true is data kind is present
  33446. */
  33447. isVerticesDataPresent(kind: string): boolean;
  33448. /**
  33449. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  33450. * @param kind defines the data kind (Position, normal, etc...)
  33451. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  33452. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  33453. * @returns a float array containing vertex data
  33454. */
  33455. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  33456. /**
  33457. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  33458. * @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.
  33459. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  33460. * @returns the indices array or an empty array if the mesh has no geometry
  33461. */
  33462. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  33463. /**
  33464. * Set specific vertex data
  33465. * @param kind defines the data kind (Position, normal, etc...)
  33466. * @param data defines the vertex data to use
  33467. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  33468. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  33469. */
  33470. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  33471. /**
  33472. * Update a specific associated vertex buffer
  33473. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  33474. * - VertexBuffer.PositionKind
  33475. * - VertexBuffer.UVKind
  33476. * - VertexBuffer.UV2Kind
  33477. * - VertexBuffer.UV3Kind
  33478. * - VertexBuffer.UV4Kind
  33479. * - VertexBuffer.UV5Kind
  33480. * - VertexBuffer.UV6Kind
  33481. * - VertexBuffer.ColorKind
  33482. * - VertexBuffer.MatricesIndicesKind
  33483. * - VertexBuffer.MatricesIndicesExtraKind
  33484. * - VertexBuffer.MatricesWeightsKind
  33485. * - VertexBuffer.MatricesWeightsExtraKind
  33486. * @param data defines the data source
  33487. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  33488. * @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)
  33489. */
  33490. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  33491. /**
  33492. * Creates a new index buffer
  33493. * @param indices defines the indices to store in the index buffer
  33494. * @param totalVertices defines the total number of vertices (could be null)
  33495. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  33496. */
  33497. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  33498. }
  33499. /**
  33500. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  33501. */
  33502. export class VertexData {
  33503. /**
  33504. * Mesh side orientation : usually the external or front surface
  33505. */
  33506. static readonly FRONTSIDE: number;
  33507. /**
  33508. * Mesh side orientation : usually the internal or back surface
  33509. */
  33510. static readonly BACKSIDE: number;
  33511. /**
  33512. * Mesh side orientation : both internal and external or front and back surfaces
  33513. */
  33514. static readonly DOUBLESIDE: number;
  33515. /**
  33516. * Mesh side orientation : by default, `FRONTSIDE`
  33517. */
  33518. static readonly DEFAULTSIDE: number;
  33519. /**
  33520. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  33521. */
  33522. positions: Nullable<FloatArray>;
  33523. /**
  33524. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  33525. */
  33526. normals: Nullable<FloatArray>;
  33527. /**
  33528. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  33529. */
  33530. tangents: Nullable<FloatArray>;
  33531. /**
  33532. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  33533. */
  33534. uvs: Nullable<FloatArray>;
  33535. /**
  33536. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  33537. */
  33538. uvs2: Nullable<FloatArray>;
  33539. /**
  33540. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  33541. */
  33542. uvs3: Nullable<FloatArray>;
  33543. /**
  33544. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  33545. */
  33546. uvs4: Nullable<FloatArray>;
  33547. /**
  33548. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  33549. */
  33550. uvs5: Nullable<FloatArray>;
  33551. /**
  33552. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  33553. */
  33554. uvs6: Nullable<FloatArray>;
  33555. /**
  33556. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  33557. */
  33558. colors: Nullable<FloatArray>;
  33559. /**
  33560. * 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).
  33561. */
  33562. matricesIndices: Nullable<FloatArray>;
  33563. /**
  33564. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  33565. */
  33566. matricesWeights: Nullable<FloatArray>;
  33567. /**
  33568. * An array extending the number of possible indices
  33569. */
  33570. matricesIndicesExtra: Nullable<FloatArray>;
  33571. /**
  33572. * An array extending the number of possible weights when the number of indices is extended
  33573. */
  33574. matricesWeightsExtra: Nullable<FloatArray>;
  33575. /**
  33576. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  33577. */
  33578. indices: Nullable<IndicesArray>;
  33579. /**
  33580. * Uses the passed data array to set the set the values for the specified kind of data
  33581. * @param data a linear array of floating numbers
  33582. * @param kind the type of data that is being set, eg positions, colors etc
  33583. */
  33584. set(data: FloatArray, kind: string): void;
  33585. /**
  33586. * Associates the vertexData to the passed Mesh.
  33587. * Sets it as updatable or not (default `false`)
  33588. * @param mesh the mesh the vertexData is applied to
  33589. * @param updatable when used and having the value true allows new data to update the vertexData
  33590. * @returns the VertexData
  33591. */
  33592. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  33593. /**
  33594. * Associates the vertexData to the passed Geometry.
  33595. * Sets it as updatable or not (default `false`)
  33596. * @param geometry the geometry the vertexData is applied to
  33597. * @param updatable when used and having the value true allows new data to update the vertexData
  33598. * @returns VertexData
  33599. */
  33600. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  33601. /**
  33602. * Updates the associated mesh
  33603. * @param mesh the mesh to be updated
  33604. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  33605. * @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
  33606. * @returns VertexData
  33607. */
  33608. updateMesh(mesh: Mesh): VertexData;
  33609. /**
  33610. * Updates the associated geometry
  33611. * @param geometry the geometry to be updated
  33612. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  33613. * @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
  33614. * @returns VertexData.
  33615. */
  33616. updateGeometry(geometry: Geometry): VertexData;
  33617. private _applyTo;
  33618. private _update;
  33619. /**
  33620. * Transforms each position and each normal of the vertexData according to the passed Matrix
  33621. * @param matrix the transforming matrix
  33622. * @returns the VertexData
  33623. */
  33624. transform(matrix: Matrix): VertexData;
  33625. /**
  33626. * Merges the passed VertexData into the current one
  33627. * @param other the VertexData to be merged into the current one
  33628. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  33629. * @returns the modified VertexData
  33630. */
  33631. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  33632. private _mergeElement;
  33633. private _validate;
  33634. /**
  33635. * Serializes the VertexData
  33636. * @returns a serialized object
  33637. */
  33638. serialize(): any;
  33639. /**
  33640. * Extracts the vertexData from a mesh
  33641. * @param mesh the mesh from which to extract the VertexData
  33642. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  33643. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  33644. * @returns the object VertexData associated to the passed mesh
  33645. */
  33646. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  33647. /**
  33648. * Extracts the vertexData from the geometry
  33649. * @param geometry the geometry from which to extract the VertexData
  33650. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  33651. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  33652. * @returns the object VertexData associated to the passed mesh
  33653. */
  33654. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  33655. private static _ExtractFrom;
  33656. /**
  33657. * Creates the VertexData for a Ribbon
  33658. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  33659. * * pathArray array of paths, each of which an array of successive Vector3
  33660. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  33661. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  33662. * * 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
  33663. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  33664. * * 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)
  33665. * * 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)
  33666. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  33667. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  33668. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  33669. * @returns the VertexData of the ribbon
  33670. */
  33671. static CreateRibbon(options: {
  33672. pathArray: Vector3[][];
  33673. closeArray?: boolean;
  33674. closePath?: boolean;
  33675. offset?: number;
  33676. sideOrientation?: number;
  33677. frontUVs?: Vector4;
  33678. backUVs?: Vector4;
  33679. invertUV?: boolean;
  33680. uvs?: Vector2[];
  33681. colors?: Color4[];
  33682. }): VertexData;
  33683. /**
  33684. * Creates the VertexData for a box
  33685. * @param options an object used to set the following optional parameters for the box, required but can be empty
  33686. * * size sets the width, height and depth of the box to the value of size, optional default 1
  33687. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  33688. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  33689. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  33690. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  33691. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  33692. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  33693. * * 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)
  33694. * * 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)
  33695. * @returns the VertexData of the box
  33696. */
  33697. static CreateBox(options: {
  33698. size?: number;
  33699. width?: number;
  33700. height?: number;
  33701. depth?: number;
  33702. faceUV?: Vector4[];
  33703. faceColors?: Color4[];
  33704. sideOrientation?: number;
  33705. frontUVs?: Vector4;
  33706. backUVs?: Vector4;
  33707. }): VertexData;
  33708. /**
  33709. * Creates the VertexData for a tiled box
  33710. * @param options an object used to set the following optional parameters for the box, required but can be empty
  33711. * * faceTiles sets the pattern, tile size and number of tiles for a face
  33712. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  33713. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  33714. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  33715. * @returns the VertexData of the box
  33716. */
  33717. static CreateTiledBox(options: {
  33718. pattern?: number;
  33719. width?: number;
  33720. height?: number;
  33721. depth?: number;
  33722. tileSize?: number;
  33723. tileWidth?: number;
  33724. tileHeight?: number;
  33725. alignHorizontal?: number;
  33726. alignVertical?: number;
  33727. faceUV?: Vector4[];
  33728. faceColors?: Color4[];
  33729. sideOrientation?: number;
  33730. }): VertexData;
  33731. /**
  33732. * Creates the VertexData for a tiled plane
  33733. * @param options an object used to set the following optional parameters for the box, required but can be empty
  33734. * * pattern a limited pattern arrangement depending on the number
  33735. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  33736. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  33737. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  33738. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  33739. * * 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)
  33740. * * 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)
  33741. * @returns the VertexData of the tiled plane
  33742. */
  33743. static CreateTiledPlane(options: {
  33744. pattern?: number;
  33745. tileSize?: number;
  33746. tileWidth?: number;
  33747. tileHeight?: number;
  33748. size?: number;
  33749. width?: number;
  33750. height?: number;
  33751. alignHorizontal?: number;
  33752. alignVertical?: number;
  33753. sideOrientation?: number;
  33754. frontUVs?: Vector4;
  33755. backUVs?: Vector4;
  33756. }): VertexData;
  33757. /**
  33758. * Creates the VertexData for an ellipsoid, defaults to a sphere
  33759. * @param options an object used to set the following optional parameters for the box, required but can be empty
  33760. * * segments sets the number of horizontal strips optional, default 32
  33761. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  33762. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  33763. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  33764. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  33765. * * 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
  33766. * * 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
  33767. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  33768. * * 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)
  33769. * * 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)
  33770. * @returns the VertexData of the ellipsoid
  33771. */
  33772. static CreateSphere(options: {
  33773. segments?: number;
  33774. diameter?: number;
  33775. diameterX?: number;
  33776. diameterY?: number;
  33777. diameterZ?: number;
  33778. arc?: number;
  33779. slice?: number;
  33780. sideOrientation?: number;
  33781. frontUVs?: Vector4;
  33782. backUVs?: Vector4;
  33783. }): VertexData;
  33784. /**
  33785. * Creates the VertexData for a cylinder, cone or prism
  33786. * @param options an object used to set the following optional parameters for the box, required but can be empty
  33787. * * height sets the height (y direction) of the cylinder, optional, default 2
  33788. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  33789. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  33790. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  33791. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  33792. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  33793. * * 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
  33794. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  33795. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  33796. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  33797. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  33798. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  33799. * * 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)
  33800. * * 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)
  33801. * @returns the VertexData of the cylinder, cone or prism
  33802. */
  33803. static CreateCylinder(options: {
  33804. height?: number;
  33805. diameterTop?: number;
  33806. diameterBottom?: number;
  33807. diameter?: number;
  33808. tessellation?: number;
  33809. subdivisions?: number;
  33810. arc?: number;
  33811. faceColors?: Color4[];
  33812. faceUV?: Vector4[];
  33813. hasRings?: boolean;
  33814. enclose?: boolean;
  33815. sideOrientation?: number;
  33816. frontUVs?: Vector4;
  33817. backUVs?: Vector4;
  33818. }): VertexData;
  33819. /**
  33820. * Creates the VertexData for a torus
  33821. * @param options an object used to set the following optional parameters for the box, required but can be empty
  33822. * * diameter the diameter of the torus, optional default 1
  33823. * * thickness the diameter of the tube forming the torus, optional default 0.5
  33824. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  33825. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  33826. * * 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)
  33827. * * 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)
  33828. * @returns the VertexData of the torus
  33829. */
  33830. static CreateTorus(options: {
  33831. diameter?: number;
  33832. thickness?: number;
  33833. tessellation?: number;
  33834. sideOrientation?: number;
  33835. frontUVs?: Vector4;
  33836. backUVs?: Vector4;
  33837. }): VertexData;
  33838. /**
  33839. * Creates the VertexData of the LineSystem
  33840. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  33841. * - lines an array of lines, each line being an array of successive Vector3
  33842. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  33843. * @returns the VertexData of the LineSystem
  33844. */
  33845. static CreateLineSystem(options: {
  33846. lines: Vector3[][];
  33847. colors?: Nullable<Color4[][]>;
  33848. }): VertexData;
  33849. /**
  33850. * Create the VertexData for a DashedLines
  33851. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  33852. * - points an array successive Vector3
  33853. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  33854. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  33855. * - dashNb the intended total number of dashes, optional, default 200
  33856. * @returns the VertexData for the DashedLines
  33857. */
  33858. static CreateDashedLines(options: {
  33859. points: Vector3[];
  33860. dashSize?: number;
  33861. gapSize?: number;
  33862. dashNb?: number;
  33863. }): VertexData;
  33864. /**
  33865. * Creates the VertexData for a Ground
  33866. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  33867. * - width the width (x direction) of the ground, optional, default 1
  33868. * - height the height (z direction) of the ground, optional, default 1
  33869. * - subdivisions the number of subdivisions per side, optional, default 1
  33870. * @returns the VertexData of the Ground
  33871. */
  33872. static CreateGround(options: {
  33873. width?: number;
  33874. height?: number;
  33875. subdivisions?: number;
  33876. subdivisionsX?: number;
  33877. subdivisionsY?: number;
  33878. }): VertexData;
  33879. /**
  33880. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  33881. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  33882. * * xmin the ground minimum X coordinate, optional, default -1
  33883. * * zmin the ground minimum Z coordinate, optional, default -1
  33884. * * xmax the ground maximum X coordinate, optional, default 1
  33885. * * zmax the ground maximum Z coordinate, optional, default 1
  33886. * * 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}
  33887. * * 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}
  33888. * @returns the VertexData of the TiledGround
  33889. */
  33890. static CreateTiledGround(options: {
  33891. xmin: number;
  33892. zmin: number;
  33893. xmax: number;
  33894. zmax: number;
  33895. subdivisions?: {
  33896. w: number;
  33897. h: number;
  33898. };
  33899. precision?: {
  33900. w: number;
  33901. h: number;
  33902. };
  33903. }): VertexData;
  33904. /**
  33905. * Creates the VertexData of the Ground designed from a heightmap
  33906. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  33907. * * width the width (x direction) of the ground
  33908. * * height the height (z direction) of the ground
  33909. * * subdivisions the number of subdivisions per side
  33910. * * minHeight the minimum altitude on the ground, optional, default 0
  33911. * * maxHeight the maximum altitude on the ground, optional default 1
  33912. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  33913. * * buffer the array holding the image color data
  33914. * * bufferWidth the width of image
  33915. * * bufferHeight the height of image
  33916. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  33917. * @returns the VertexData of the Ground designed from a heightmap
  33918. */
  33919. static CreateGroundFromHeightMap(options: {
  33920. width: number;
  33921. height: number;
  33922. subdivisions: number;
  33923. minHeight: number;
  33924. maxHeight: number;
  33925. colorFilter: Color3;
  33926. buffer: Uint8Array;
  33927. bufferWidth: number;
  33928. bufferHeight: number;
  33929. alphaFilter: number;
  33930. }): VertexData;
  33931. /**
  33932. * Creates the VertexData for a Plane
  33933. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  33934. * * size sets the width and height of the plane to the value of size, optional default 1
  33935. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  33936. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  33937. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  33938. * * 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)
  33939. * * 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)
  33940. * @returns the VertexData of the box
  33941. */
  33942. static CreatePlane(options: {
  33943. size?: number;
  33944. width?: number;
  33945. height?: number;
  33946. sideOrientation?: number;
  33947. frontUVs?: Vector4;
  33948. backUVs?: Vector4;
  33949. }): VertexData;
  33950. /**
  33951. * Creates the VertexData of the Disc or regular Polygon
  33952. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  33953. * * radius the radius of the disc, optional default 0.5
  33954. * * tessellation the number of polygon sides, optional, default 64
  33955. * * 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
  33956. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  33957. * * 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)
  33958. * * 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)
  33959. * @returns the VertexData of the box
  33960. */
  33961. static CreateDisc(options: {
  33962. radius?: number;
  33963. tessellation?: number;
  33964. arc?: number;
  33965. sideOrientation?: number;
  33966. frontUVs?: Vector4;
  33967. backUVs?: Vector4;
  33968. }): VertexData;
  33969. /**
  33970. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  33971. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  33972. * @param polygon a mesh built from polygonTriangulation.build()
  33973. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  33974. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  33975. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  33976. * @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)
  33977. * @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)
  33978. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  33979. * @returns the VertexData of the Polygon
  33980. */
  33981. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  33982. /**
  33983. * Creates the VertexData of the IcoSphere
  33984. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  33985. * * radius the radius of the IcoSphere, optional default 1
  33986. * * radiusX allows stretching in the x direction, optional, default radius
  33987. * * radiusY allows stretching in the y direction, optional, default radius
  33988. * * radiusZ allows stretching in the z direction, optional, default radius
  33989. * * flat when true creates a flat shaded mesh, optional, default true
  33990. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  33991. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  33992. * * 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)
  33993. * * 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)
  33994. * @returns the VertexData of the IcoSphere
  33995. */
  33996. static CreateIcoSphere(options: {
  33997. radius?: number;
  33998. radiusX?: number;
  33999. radiusY?: number;
  34000. radiusZ?: number;
  34001. flat?: boolean;
  34002. subdivisions?: number;
  34003. sideOrientation?: number;
  34004. frontUVs?: Vector4;
  34005. backUVs?: Vector4;
  34006. }): VertexData;
  34007. /**
  34008. * Creates the VertexData for a Polyhedron
  34009. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  34010. * * type provided types are:
  34011. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  34012. * * 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)
  34013. * * size the size of the IcoSphere, optional default 1
  34014. * * sizeX allows stretching in the x direction, optional, default size
  34015. * * sizeY allows stretching in the y direction, optional, default size
  34016. * * sizeZ allows stretching in the z direction, optional, default size
  34017. * * 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
  34018. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  34019. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  34020. * * flat when true creates a flat shaded mesh, optional, default true
  34021. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  34022. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  34023. * * 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)
  34024. * * 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)
  34025. * @returns the VertexData of the Polyhedron
  34026. */
  34027. static CreatePolyhedron(options: {
  34028. type?: number;
  34029. size?: number;
  34030. sizeX?: number;
  34031. sizeY?: number;
  34032. sizeZ?: number;
  34033. custom?: any;
  34034. faceUV?: Vector4[];
  34035. faceColors?: Color4[];
  34036. flat?: boolean;
  34037. sideOrientation?: number;
  34038. frontUVs?: Vector4;
  34039. backUVs?: Vector4;
  34040. }): VertexData;
  34041. /**
  34042. * Creates the VertexData for a Capsule, inspired from https://github.com/maximeq/three-js-capsule-geometry/blob/master/src/CapsuleBufferGeometry.js
  34043. * @param options an object used to set the following optional parameters for the capsule, required but can be empty
  34044. * @returns the VertexData of the Capsule
  34045. */
  34046. static CreateCapsule(options?: ICreateCapsuleOptions): VertexData;
  34047. /**
  34048. * Creates the VertexData for a TorusKnot
  34049. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  34050. * * radius the radius of the torus knot, optional, default 2
  34051. * * tube the thickness of the tube, optional, default 0.5
  34052. * * radialSegments the number of sides on each tube segments, optional, default 32
  34053. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  34054. * * p the number of windings around the z axis, optional, default 2
  34055. * * q the number of windings around the x axis, optional, default 3
  34056. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  34057. * * 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)
  34058. * * 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)
  34059. * @returns the VertexData of the Torus Knot
  34060. */
  34061. static CreateTorusKnot(options: {
  34062. radius?: number;
  34063. tube?: number;
  34064. radialSegments?: number;
  34065. tubularSegments?: number;
  34066. p?: number;
  34067. q?: number;
  34068. sideOrientation?: number;
  34069. frontUVs?: Vector4;
  34070. backUVs?: Vector4;
  34071. }): VertexData;
  34072. /**
  34073. * Compute normals for given positions and indices
  34074. * @param positions an array of vertex positions, [...., x, y, z, ......]
  34075. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  34076. * @param normals an array of vertex normals, [...., x, y, z, ......]
  34077. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  34078. * * facetNormals : optional array of facet normals (vector3)
  34079. * * facetPositions : optional array of facet positions (vector3)
  34080. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  34081. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  34082. * * bInfo : optional bounding info, required for facetPartitioning computation
  34083. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  34084. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  34085. * * useRightHandedSystem: optional boolean to for right handed system computation
  34086. * * depthSort : optional boolean to enable the facet depth sort computation
  34087. * * distanceTo : optional Vector3 to compute the facet depth from this location
  34088. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  34089. */
  34090. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  34091. facetNormals?: any;
  34092. facetPositions?: any;
  34093. facetPartitioning?: any;
  34094. ratio?: number;
  34095. bInfo?: any;
  34096. bbSize?: Vector3;
  34097. subDiv?: any;
  34098. useRightHandedSystem?: boolean;
  34099. depthSort?: boolean;
  34100. distanceTo?: Vector3;
  34101. depthSortedFacets?: any;
  34102. }): void;
  34103. /** @hidden */
  34104. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  34105. /**
  34106. * Applies VertexData created from the imported parameters to the geometry
  34107. * @param parsedVertexData the parsed data from an imported file
  34108. * @param geometry the geometry to apply the VertexData to
  34109. */
  34110. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  34111. }
  34112. }
  34113. declare module BABYLON {
  34114. /**
  34115. * Class containing static functions to help procedurally build meshes
  34116. */
  34117. export class DiscBuilder {
  34118. /**
  34119. * Creates a plane polygonal mesh. By default, this is a disc
  34120. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  34121. * * 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
  34122. * * 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
  34123. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  34124. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  34125. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  34126. * @param name defines the name of the mesh
  34127. * @param options defines the options used to create the mesh
  34128. * @param scene defines the hosting scene
  34129. * @returns the plane polygonal mesh
  34130. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  34131. */
  34132. static CreateDisc(name: string, options: {
  34133. radius?: number;
  34134. tessellation?: number;
  34135. arc?: number;
  34136. updatable?: boolean;
  34137. sideOrientation?: number;
  34138. frontUVs?: Vector4;
  34139. backUVs?: Vector4;
  34140. }, scene?: Nullable<Scene>): Mesh;
  34141. }
  34142. }
  34143. declare module BABYLON {
  34144. /**
  34145. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  34146. *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.
  34147. * The SPS is also a particle system. It provides some methods to manage the particles.
  34148. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  34149. *
  34150. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  34151. */
  34152. export class SolidParticleSystem implements IDisposable {
  34153. /**
  34154. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  34155. * Example : var p = SPS.particles[i];
  34156. */
  34157. particles: SolidParticle[];
  34158. /**
  34159. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  34160. */
  34161. nbParticles: number;
  34162. /**
  34163. * If the particles must ever face the camera (default false). Useful for planar particles.
  34164. */
  34165. billboard: boolean;
  34166. /**
  34167. * Recompute normals when adding a shape
  34168. */
  34169. recomputeNormals: boolean;
  34170. /**
  34171. * This a counter ofr your own usage. It's not set by any SPS functions.
  34172. */
  34173. counter: number;
  34174. /**
  34175. * The SPS name. This name is also given to the underlying mesh.
  34176. */
  34177. name: string;
  34178. /**
  34179. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  34180. */
  34181. mesh: Mesh;
  34182. /**
  34183. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  34184. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  34185. */
  34186. vars: any;
  34187. /**
  34188. * This array is populated when the SPS is set as 'pickable'.
  34189. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  34190. * Each element of this array is an object `{idx: int, faceId: int}`.
  34191. * `idx` is the picked particle index in the `SPS.particles` array
  34192. * `faceId` is the picked face index counted within this particle.
  34193. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  34194. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  34195. * Use the method SPS.pickedParticle(pickingInfo) instead.
  34196. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  34197. */
  34198. pickedParticles: {
  34199. idx: number;
  34200. faceId: number;
  34201. }[];
  34202. /**
  34203. * This array is populated when the SPS is set as 'pickable'
  34204. * Each key of this array is a submesh index.
  34205. * Each element of this array is a second array defined like this :
  34206. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  34207. * Each element of this second array is an object `{idx: int, faceId: int}`.
  34208. * `idx` is the picked particle index in the `SPS.particles` array
  34209. * `faceId` is the picked face index counted within this particle.
  34210. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  34211. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  34212. */
  34213. pickedBySubMesh: {
  34214. idx: number;
  34215. faceId: number;
  34216. }[][];
  34217. /**
  34218. * This array is populated when `enableDepthSort` is set to true.
  34219. * Each element of this array is an instance of the class DepthSortedParticle.
  34220. */
  34221. depthSortedParticles: DepthSortedParticle[];
  34222. /**
  34223. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  34224. * @hidden
  34225. */
  34226. _bSphereOnly: boolean;
  34227. /**
  34228. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  34229. * @hidden
  34230. */
  34231. _bSphereRadiusFactor: number;
  34232. private _scene;
  34233. private _positions;
  34234. private _indices;
  34235. private _normals;
  34236. private _colors;
  34237. private _uvs;
  34238. private _indices32;
  34239. private _positions32;
  34240. private _normals32;
  34241. private _fixedNormal32;
  34242. private _colors32;
  34243. private _uvs32;
  34244. private _index;
  34245. private _updatable;
  34246. private _pickable;
  34247. private _isVisibilityBoxLocked;
  34248. private _alwaysVisible;
  34249. private _depthSort;
  34250. private _expandable;
  34251. private _shapeCounter;
  34252. private _copy;
  34253. private _color;
  34254. private _computeParticleColor;
  34255. private _computeParticleTexture;
  34256. private _computeParticleRotation;
  34257. private _computeParticleVertex;
  34258. private _computeBoundingBox;
  34259. private _depthSortParticles;
  34260. private _camera;
  34261. private _mustUnrotateFixedNormals;
  34262. private _particlesIntersect;
  34263. private _needs32Bits;
  34264. private _isNotBuilt;
  34265. private _lastParticleId;
  34266. private _idxOfId;
  34267. private _multimaterialEnabled;
  34268. private _useModelMaterial;
  34269. private _indicesByMaterial;
  34270. private _materialIndexes;
  34271. private _depthSortFunction;
  34272. private _materialSortFunction;
  34273. private _materials;
  34274. private _multimaterial;
  34275. private _materialIndexesById;
  34276. private _defaultMaterial;
  34277. private _autoUpdateSubMeshes;
  34278. private _tmpVertex;
  34279. /**
  34280. * Creates a SPS (Solid Particle System) object.
  34281. * @param name (String) is the SPS name, this will be the underlying mesh name.
  34282. * @param scene (Scene) is the scene in which the SPS is added.
  34283. * @param options defines the options of the sps e.g.
  34284. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  34285. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  34286. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  34287. * * useModelMaterial (optional boolean, defaut false) : if the model materials must be used to create the SPS multimaterial. This enables the multimaterial supports of the SPS.
  34288. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  34289. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  34290. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  34291. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  34292. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  34293. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  34294. */
  34295. constructor(name: string, scene: Scene, options?: {
  34296. updatable?: boolean;
  34297. isPickable?: boolean;
  34298. enableDepthSort?: boolean;
  34299. particleIntersection?: boolean;
  34300. boundingSphereOnly?: boolean;
  34301. bSphereRadiusFactor?: number;
  34302. expandable?: boolean;
  34303. useModelMaterial?: boolean;
  34304. enableMultiMaterial?: boolean;
  34305. });
  34306. /**
  34307. * Builds the SPS underlying mesh. Returns a standard Mesh.
  34308. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  34309. * @returns the created mesh
  34310. */
  34311. buildMesh(): Mesh;
  34312. /**
  34313. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  34314. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  34315. * Thus the particles generated from `digest()` have their property `position` set yet.
  34316. * @param mesh ( Mesh ) is the mesh to be digested
  34317. * @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
  34318. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  34319. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  34320. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  34321. * @returns the current SPS
  34322. */
  34323. digest(mesh: Mesh, options?: {
  34324. facetNb?: number;
  34325. number?: number;
  34326. delta?: number;
  34327. storage?: [];
  34328. }): SolidParticleSystem;
  34329. /**
  34330. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  34331. * @hidden
  34332. */
  34333. private _unrotateFixedNormals;
  34334. /**
  34335. * Resets the temporary working copy particle
  34336. * @hidden
  34337. */
  34338. private _resetCopy;
  34339. /**
  34340. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  34341. * @param p the current index in the positions array to be updated
  34342. * @param ind the current index in the indices array
  34343. * @param shape a Vector3 array, the shape geometry
  34344. * @param positions the positions array to be updated
  34345. * @param meshInd the shape indices array
  34346. * @param indices the indices array to be updated
  34347. * @param meshUV the shape uv array
  34348. * @param uvs the uv array to be updated
  34349. * @param meshCol the shape color array
  34350. * @param colors the color array to be updated
  34351. * @param meshNor the shape normals array
  34352. * @param normals the normals array to be updated
  34353. * @param idx the particle index
  34354. * @param idxInShape the particle index in its shape
  34355. * @param options the addShape() method passed options
  34356. * @model the particle model
  34357. * @hidden
  34358. */
  34359. private _meshBuilder;
  34360. /**
  34361. * Returns a shape Vector3 array from positions float array
  34362. * @param positions float array
  34363. * @returns a vector3 array
  34364. * @hidden
  34365. */
  34366. private _posToShape;
  34367. /**
  34368. * Returns a shapeUV array from a float uvs (array deep copy)
  34369. * @param uvs as a float array
  34370. * @returns a shapeUV array
  34371. * @hidden
  34372. */
  34373. private _uvsToShapeUV;
  34374. /**
  34375. * Adds a new particle object in the particles array
  34376. * @param idx particle index in particles array
  34377. * @param id particle id
  34378. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  34379. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  34380. * @param model particle ModelShape object
  34381. * @param shapeId model shape identifier
  34382. * @param idxInShape index of the particle in the current model
  34383. * @param bInfo model bounding info object
  34384. * @param storage target storage array, if any
  34385. * @hidden
  34386. */
  34387. private _addParticle;
  34388. /**
  34389. * Adds some particles to the SPS from the model shape. Returns the shape id.
  34390. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  34391. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  34392. * @param nb (positive integer) the number of particles to be created from this model
  34393. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  34394. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  34395. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  34396. * @returns the number of shapes in the system
  34397. */
  34398. addShape(mesh: Mesh, nb: number, options?: {
  34399. positionFunction?: any;
  34400. vertexFunction?: any;
  34401. storage?: [];
  34402. }): number;
  34403. /**
  34404. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  34405. * @hidden
  34406. */
  34407. private _rebuildParticle;
  34408. /**
  34409. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  34410. * @param reset boolean, default false : if the particles must be reset at position and rotation zero, scaling 1, color white, initial UVs and not parented.
  34411. * @returns the SPS.
  34412. */
  34413. rebuildMesh(reset?: boolean): SolidParticleSystem;
  34414. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  34415. * Returns an array with the removed particles.
  34416. * If the number of particles to remove is lower than zero or greater than the global remaining particle number, then an empty array is returned.
  34417. * The SPS can't be empty so at least one particle needs to remain in place.
  34418. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  34419. * @param start index of the first particle to remove
  34420. * @param end index of the last particle to remove (included)
  34421. * @returns an array populated with the removed particles
  34422. */
  34423. removeParticles(start: number, end: number): SolidParticle[];
  34424. /**
  34425. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  34426. * @param solidParticleArray an array populated with Solid Particles objects
  34427. * @returns the SPS
  34428. */
  34429. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  34430. /**
  34431. * Creates a new particle and modifies the SPS mesh geometry :
  34432. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  34433. * - calls _addParticle() to populate the particle array
  34434. * factorized code from addShape() and insertParticlesFromArray()
  34435. * @param idx particle index in the particles array
  34436. * @param i particle index in its shape
  34437. * @param modelShape particle ModelShape object
  34438. * @param shape shape vertex array
  34439. * @param meshInd shape indices array
  34440. * @param meshUV shape uv array
  34441. * @param meshCol shape color array
  34442. * @param meshNor shape normals array
  34443. * @param bbInfo shape bounding info
  34444. * @param storage target particle storage
  34445. * @options addShape() passed options
  34446. * @hidden
  34447. */
  34448. private _insertNewParticle;
  34449. /**
  34450. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  34451. * This method calls `updateParticle()` for each particle of the SPS.
  34452. * For an animated SPS, it is usually called within the render loop.
  34453. * This methods does nothing if called on a non updatable or not yet built SPS. Example : buildMesh() not called after having added or removed particles from an expandable SPS.
  34454. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  34455. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  34456. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  34457. * @returns the SPS.
  34458. */
  34459. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  34460. /**
  34461. * Disposes the SPS.
  34462. */
  34463. dispose(): void;
  34464. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  34465. * idx is the particle index in the SPS
  34466. * faceId is the picked face index counted within this particle.
  34467. * Returns null if the pickInfo can't identify a picked particle.
  34468. * @param pickingInfo (PickingInfo object)
  34469. * @returns {idx: number, faceId: number} or null
  34470. */
  34471. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  34472. idx: number;
  34473. faceId: number;
  34474. }>;
  34475. /**
  34476. * Returns a SolidParticle object from its identifier : particle.id
  34477. * @param id (integer) the particle Id
  34478. * @returns the searched particle or null if not found in the SPS.
  34479. */
  34480. getParticleById(id: number): Nullable<SolidParticle>;
  34481. /**
  34482. * Returns a new array populated with the particles having the passed shapeId.
  34483. * @param shapeId (integer) the shape identifier
  34484. * @returns a new solid particle array
  34485. */
  34486. getParticlesByShapeId(shapeId: number): SolidParticle[];
  34487. /**
  34488. * Populates the passed array "ref" with the particles having the passed shapeId.
  34489. * @param shapeId the shape identifier
  34490. * @returns the SPS
  34491. * @param ref
  34492. */
  34493. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  34494. /**
  34495. * Computes the required SubMeshes according the materials assigned to the particles.
  34496. * @returns the solid particle system.
  34497. * Does nothing if called before the SPS mesh is built.
  34498. */
  34499. computeSubMeshes(): SolidParticleSystem;
  34500. /**
  34501. * Sorts the solid particles by material when MultiMaterial is enabled.
  34502. * Updates the indices32 array.
  34503. * Updates the indicesByMaterial array.
  34504. * Updates the mesh indices array.
  34505. * @returns the SPS
  34506. * @hidden
  34507. */
  34508. private _sortParticlesByMaterial;
  34509. /**
  34510. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  34511. * @hidden
  34512. */
  34513. private _setMaterialIndexesById;
  34514. /**
  34515. * Returns an array with unique values of Materials from the passed array
  34516. * @param array the material array to be checked and filtered
  34517. * @hidden
  34518. */
  34519. private _filterUniqueMaterialId;
  34520. /**
  34521. * Sets a new Standard Material as _defaultMaterial if not already set.
  34522. * @hidden
  34523. */
  34524. private _setDefaultMaterial;
  34525. /**
  34526. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  34527. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  34528. * @returns the SPS.
  34529. */
  34530. refreshVisibleSize(): SolidParticleSystem;
  34531. /**
  34532. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  34533. * @param size the size (float) of the visibility box
  34534. * note : this doesn't lock the SPS mesh bounding box.
  34535. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  34536. */
  34537. setVisibilityBox(size: number): void;
  34538. /**
  34539. * Gets whether the SPS as always visible or not
  34540. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  34541. */
  34542. get isAlwaysVisible(): boolean;
  34543. /**
  34544. * Sets the SPS as always visible or not
  34545. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  34546. */
  34547. set isAlwaysVisible(val: boolean);
  34548. /**
  34549. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  34550. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  34551. */
  34552. set isVisibilityBoxLocked(val: boolean);
  34553. /**
  34554. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  34555. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  34556. */
  34557. get isVisibilityBoxLocked(): boolean;
  34558. /**
  34559. * Tells to `setParticles()` to compute the particle rotations or not.
  34560. * Default value : true. The SPS is faster when it's set to false.
  34561. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  34562. */
  34563. set computeParticleRotation(val: boolean);
  34564. /**
  34565. * Tells to `setParticles()` to compute the particle colors or not.
  34566. * Default value : true. The SPS is faster when it's set to false.
  34567. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  34568. */
  34569. set computeParticleColor(val: boolean);
  34570. set computeParticleTexture(val: boolean);
  34571. /**
  34572. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  34573. * Default value : false. The SPS is faster when it's set to false.
  34574. * Note : the particle custom vertex positions aren't stored values.
  34575. */
  34576. set computeParticleVertex(val: boolean);
  34577. /**
  34578. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  34579. */
  34580. set computeBoundingBox(val: boolean);
  34581. /**
  34582. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  34583. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  34584. * Default : `true`
  34585. */
  34586. set depthSortParticles(val: boolean);
  34587. /**
  34588. * Gets if `setParticles()` computes the particle rotations or not.
  34589. * Default value : true. The SPS is faster when it's set to false.
  34590. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  34591. */
  34592. get computeParticleRotation(): boolean;
  34593. /**
  34594. * Gets if `setParticles()` computes the particle colors or not.
  34595. * Default value : true. The SPS is faster when it's set to false.
  34596. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  34597. */
  34598. get computeParticleColor(): boolean;
  34599. /**
  34600. * Gets if `setParticles()` computes the particle textures or not.
  34601. * Default value : true. The SPS is faster when it's set to false.
  34602. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  34603. */
  34604. get computeParticleTexture(): boolean;
  34605. /**
  34606. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  34607. * Default value : false. The SPS is faster when it's set to false.
  34608. * Note : the particle custom vertex positions aren't stored values.
  34609. */
  34610. get computeParticleVertex(): boolean;
  34611. /**
  34612. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  34613. */
  34614. get computeBoundingBox(): boolean;
  34615. /**
  34616. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  34617. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  34618. * Default : `true`
  34619. */
  34620. get depthSortParticles(): boolean;
  34621. /**
  34622. * Gets if the SPS is created as expandable at construction time.
  34623. * Default : `false`
  34624. */
  34625. get expandable(): boolean;
  34626. /**
  34627. * Gets if the SPS supports the Multi Materials
  34628. */
  34629. get multimaterialEnabled(): boolean;
  34630. /**
  34631. * Gets if the SPS uses the model materials for its own multimaterial.
  34632. */
  34633. get useModelMaterial(): boolean;
  34634. /**
  34635. * The SPS used material array.
  34636. */
  34637. get materials(): Material[];
  34638. /**
  34639. * Sets the SPS MultiMaterial from the passed materials.
  34640. * Note : the passed array is internally copied and not used then by reference.
  34641. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  34642. */
  34643. setMultiMaterial(materials: Material[]): void;
  34644. /**
  34645. * The SPS computed multimaterial object
  34646. */
  34647. get multimaterial(): MultiMaterial;
  34648. set multimaterial(mm: MultiMaterial);
  34649. /**
  34650. * If the subMeshes must be updated on the next call to setParticles()
  34651. */
  34652. get autoUpdateSubMeshes(): boolean;
  34653. set autoUpdateSubMeshes(val: boolean);
  34654. /**
  34655. * This function does nothing. It may be overwritten to set all the particle first values.
  34656. * The SPS doesn't call this function, you may have to call it by your own.
  34657. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  34658. */
  34659. initParticles(): void;
  34660. /**
  34661. * This function does nothing. It may be overwritten to recycle a particle.
  34662. * The SPS doesn't call this function, you may have to call it by your own.
  34663. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  34664. * @param particle The particle to recycle
  34665. * @returns the recycled particle
  34666. */
  34667. recycleParticle(particle: SolidParticle): SolidParticle;
  34668. /**
  34669. * Updates a particle : this function should be overwritten by the user.
  34670. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  34671. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  34672. * @example : just set a particle position or velocity and recycle conditions
  34673. * @param particle The particle to update
  34674. * @returns the updated particle
  34675. */
  34676. updateParticle(particle: SolidParticle): SolidParticle;
  34677. /**
  34678. * Updates a vertex of a particle : it can be overwritten by the user.
  34679. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  34680. * @param particle the current particle
  34681. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  34682. * @param pt the index of the current vertex in the particle shape
  34683. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  34684. * @example : just set a vertex particle position or color
  34685. * @returns the sps
  34686. */
  34687. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  34688. /**
  34689. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  34690. * This does nothing and may be overwritten by the user.
  34691. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  34692. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  34693. * @param update the boolean update value actually passed to setParticles()
  34694. */
  34695. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  34696. /**
  34697. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  34698. * This will be passed three parameters.
  34699. * This does nothing and may be overwritten by the user.
  34700. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  34701. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  34702. * @param update the boolean update value actually passed to setParticles()
  34703. */
  34704. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  34705. }
  34706. }
  34707. declare module BABYLON {
  34708. /**
  34709. * Represents one particle of a solid particle system.
  34710. */
  34711. export class SolidParticle {
  34712. /**
  34713. * particle global index
  34714. */
  34715. idx: number;
  34716. /**
  34717. * particle identifier
  34718. */
  34719. id: number;
  34720. /**
  34721. * The color of the particle
  34722. */
  34723. color: Nullable<Color4>;
  34724. /**
  34725. * The world space position of the particle.
  34726. */
  34727. position: Vector3;
  34728. /**
  34729. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  34730. */
  34731. rotation: Vector3;
  34732. /**
  34733. * The world space rotation quaternion of the particle.
  34734. */
  34735. rotationQuaternion: Nullable<Quaternion>;
  34736. /**
  34737. * The scaling of the particle.
  34738. */
  34739. scaling: Vector3;
  34740. /**
  34741. * The uvs of the particle.
  34742. */
  34743. uvs: Vector4;
  34744. /**
  34745. * The current speed of the particle.
  34746. */
  34747. velocity: Vector3;
  34748. /**
  34749. * The pivot point in the particle local space.
  34750. */
  34751. pivot: Vector3;
  34752. /**
  34753. * Must the particle be translated from its pivot point in its local space ?
  34754. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  34755. * Default : false
  34756. */
  34757. translateFromPivot: boolean;
  34758. /**
  34759. * Is the particle active or not ?
  34760. */
  34761. alive: boolean;
  34762. /**
  34763. * Is the particle visible or not ?
  34764. */
  34765. isVisible: boolean;
  34766. /**
  34767. * Index of this particle in the global "positions" array (Internal use)
  34768. * @hidden
  34769. */
  34770. _pos: number;
  34771. /**
  34772. * @hidden Index of this particle in the global "indices" array (Internal use)
  34773. */
  34774. _ind: number;
  34775. /**
  34776. * @hidden ModelShape of this particle (Internal use)
  34777. */
  34778. _model: ModelShape;
  34779. /**
  34780. * ModelShape id of this particle
  34781. */
  34782. shapeId: number;
  34783. /**
  34784. * Index of the particle in its shape id
  34785. */
  34786. idxInShape: number;
  34787. /**
  34788. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  34789. */
  34790. _modelBoundingInfo: BoundingInfo;
  34791. /**
  34792. * @hidden Particle BoundingInfo object (Internal use)
  34793. */
  34794. _boundingInfo: BoundingInfo;
  34795. /**
  34796. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  34797. */
  34798. _sps: SolidParticleSystem;
  34799. /**
  34800. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  34801. */
  34802. _stillInvisible: boolean;
  34803. /**
  34804. * @hidden Last computed particle rotation matrix
  34805. */
  34806. _rotationMatrix: number[];
  34807. /**
  34808. * Parent particle Id, if any.
  34809. * Default null.
  34810. */
  34811. parentId: Nullable<number>;
  34812. /**
  34813. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  34814. */
  34815. materialIndex: Nullable<number>;
  34816. /**
  34817. * Custom object or properties.
  34818. */
  34819. props: Nullable<any>;
  34820. /**
  34821. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  34822. * The possible values are :
  34823. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  34824. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  34825. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  34826. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  34827. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  34828. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  34829. * */
  34830. cullingStrategy: number;
  34831. /**
  34832. * @hidden Internal global position in the SPS.
  34833. */
  34834. _globalPosition: Vector3;
  34835. /**
  34836. * Creates a Solid Particle object.
  34837. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  34838. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  34839. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  34840. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  34841. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  34842. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  34843. * @param shapeId (integer) is the model shape identifier in the SPS.
  34844. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  34845. * @param sps defines the sps it is associated to
  34846. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  34847. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  34848. */
  34849. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  34850. /**
  34851. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  34852. * @param target the particle target
  34853. * @returns the current particle
  34854. */
  34855. copyToRef(target: SolidParticle): SolidParticle;
  34856. /**
  34857. * Legacy support, changed scale to scaling
  34858. */
  34859. get scale(): Vector3;
  34860. /**
  34861. * Legacy support, changed scale to scaling
  34862. */
  34863. set scale(scale: Vector3);
  34864. /**
  34865. * Legacy support, changed quaternion to rotationQuaternion
  34866. */
  34867. get quaternion(): Nullable<Quaternion>;
  34868. /**
  34869. * Legacy support, changed quaternion to rotationQuaternion
  34870. */
  34871. set quaternion(q: Nullable<Quaternion>);
  34872. /**
  34873. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  34874. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  34875. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  34876. * @returns true if it intersects
  34877. */
  34878. intersectsMesh(target: Mesh | SolidParticle): boolean;
  34879. /**
  34880. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  34881. * A particle is in the frustum if its bounding box intersects the frustum
  34882. * @param frustumPlanes defines the frustum to test
  34883. * @returns true if the particle is in the frustum planes
  34884. */
  34885. isInFrustum(frustumPlanes: Plane[]): boolean;
  34886. /**
  34887. * get the rotation matrix of the particle
  34888. * @hidden
  34889. */
  34890. getRotationMatrix(m: Matrix): void;
  34891. }
  34892. /**
  34893. * Represents the shape of the model used by one particle of a solid particle system.
  34894. * SPS internal tool, don't use it manually.
  34895. */
  34896. export class ModelShape {
  34897. /**
  34898. * The shape id
  34899. * @hidden
  34900. */
  34901. shapeID: number;
  34902. /**
  34903. * flat array of model positions (internal use)
  34904. * @hidden
  34905. */
  34906. _shape: Vector3[];
  34907. /**
  34908. * flat array of model UVs (internal use)
  34909. * @hidden
  34910. */
  34911. _shapeUV: number[];
  34912. /**
  34913. * color array of the model
  34914. * @hidden
  34915. */
  34916. _shapeColors: number[];
  34917. /**
  34918. * indices array of the model
  34919. * @hidden
  34920. */
  34921. _indices: number[];
  34922. /**
  34923. * normals array of the model
  34924. * @hidden
  34925. */
  34926. _normals: number[];
  34927. /**
  34928. * length of the shape in the model indices array (internal use)
  34929. * @hidden
  34930. */
  34931. _indicesLength: number;
  34932. /**
  34933. * Custom position function (internal use)
  34934. * @hidden
  34935. */
  34936. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  34937. /**
  34938. * Custom vertex function (internal use)
  34939. * @hidden
  34940. */
  34941. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  34942. /**
  34943. * Model material (internal use)
  34944. * @hidden
  34945. */
  34946. _material: Nullable<Material>;
  34947. /**
  34948. * 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.
  34949. * SPS internal tool, don't use it manually.
  34950. * @hidden
  34951. */
  34952. constructor(id: number, shape: Vector3[], indices: number[], normals: number[], colors: number[], shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>, material: Nullable<Material>);
  34953. }
  34954. /**
  34955. * Represents a Depth Sorted Particle in the solid particle system.
  34956. * @hidden
  34957. */
  34958. export class DepthSortedParticle {
  34959. /**
  34960. * Particle index
  34961. */
  34962. idx: number;
  34963. /**
  34964. * Index of the particle in the "indices" array
  34965. */
  34966. ind: number;
  34967. /**
  34968. * Length of the particle shape in the "indices" array
  34969. */
  34970. indicesLength: number;
  34971. /**
  34972. * Squared distance from the particle to the camera
  34973. */
  34974. sqDistance: number;
  34975. /**
  34976. * Material index when used with MultiMaterials
  34977. */
  34978. materialIndex: number;
  34979. /**
  34980. * Creates a new sorted particle
  34981. * @param materialIndex
  34982. */
  34983. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  34984. }
  34985. /**
  34986. * Represents a solid particle vertex
  34987. */
  34988. export class SolidParticleVertex {
  34989. /**
  34990. * Vertex position
  34991. */
  34992. position: Vector3;
  34993. /**
  34994. * Vertex color
  34995. */
  34996. color: Color4;
  34997. /**
  34998. * Vertex UV
  34999. */
  35000. uv: Vector2;
  35001. /**
  35002. * Creates a new solid particle vertex
  35003. */
  35004. constructor();
  35005. /** Vertex x coordinate */
  35006. get x(): number;
  35007. set x(val: number);
  35008. /** Vertex y coordinate */
  35009. get y(): number;
  35010. set y(val: number);
  35011. /** Vertex z coordinate */
  35012. get z(): number;
  35013. set z(val: number);
  35014. }
  35015. }
  35016. declare module BABYLON {
  35017. /**
  35018. * @hidden
  35019. */
  35020. export class _MeshCollisionData {
  35021. _checkCollisions: boolean;
  35022. _collisionMask: number;
  35023. _collisionGroup: number;
  35024. _surroundingMeshes: Nullable<AbstractMesh[]>;
  35025. _collider: Nullable<Collider>;
  35026. _oldPositionForCollisions: Vector3;
  35027. _diffPositionForCollisions: Vector3;
  35028. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  35029. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  35030. _collisionResponse: boolean;
  35031. }
  35032. }
  35033. declare module BABYLON {
  35034. /** @hidden */
  35035. class _FacetDataStorage {
  35036. facetPositions: Vector3[];
  35037. facetNormals: Vector3[];
  35038. facetPartitioning: number[][];
  35039. facetNb: number;
  35040. partitioningSubdivisions: number;
  35041. partitioningBBoxRatio: number;
  35042. facetDataEnabled: boolean;
  35043. facetParameters: any;
  35044. bbSize: Vector3;
  35045. subDiv: {
  35046. max: number;
  35047. X: number;
  35048. Y: number;
  35049. Z: number;
  35050. };
  35051. facetDepthSort: boolean;
  35052. facetDepthSortEnabled: boolean;
  35053. depthSortedIndices: IndicesArray;
  35054. depthSortedFacets: {
  35055. ind: number;
  35056. sqDistance: number;
  35057. }[];
  35058. facetDepthSortFunction: (f1: {
  35059. ind: number;
  35060. sqDistance: number;
  35061. }, f2: {
  35062. ind: number;
  35063. sqDistance: number;
  35064. }) => number;
  35065. facetDepthSortFrom: Vector3;
  35066. facetDepthSortOrigin: Vector3;
  35067. invertedMatrix: Matrix;
  35068. }
  35069. /**
  35070. * @hidden
  35071. **/
  35072. class _InternalAbstractMeshDataInfo {
  35073. _hasVertexAlpha: boolean;
  35074. _useVertexColors: boolean;
  35075. _numBoneInfluencers: number;
  35076. _applyFog: boolean;
  35077. _receiveShadows: boolean;
  35078. _facetData: _FacetDataStorage;
  35079. _visibility: number;
  35080. _skeleton: Nullable<Skeleton>;
  35081. _layerMask: number;
  35082. _computeBonesUsingShaders: boolean;
  35083. _isActive: boolean;
  35084. _onlyForInstances: boolean;
  35085. _isActiveIntermediate: boolean;
  35086. _onlyForInstancesIntermediate: boolean;
  35087. _actAsRegularMesh: boolean;
  35088. _currentLOD: Nullable<AbstractMesh>;
  35089. }
  35090. /**
  35091. * Class used to store all common mesh properties
  35092. */
  35093. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  35094. /** No occlusion */
  35095. static OCCLUSION_TYPE_NONE: number;
  35096. /** Occlusion set to optimisitic */
  35097. static OCCLUSION_TYPE_OPTIMISTIC: number;
  35098. /** Occlusion set to strict */
  35099. static OCCLUSION_TYPE_STRICT: number;
  35100. /** Use an accurante occlusion algorithm */
  35101. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  35102. /** Use a conservative occlusion algorithm */
  35103. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  35104. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  35105. * Test order :
  35106. * Is the bounding sphere outside the frustum ?
  35107. * If not, are the bounding box vertices outside the frustum ?
  35108. * It not, then the cullable object is in the frustum.
  35109. */
  35110. static readonly CULLINGSTRATEGY_STANDARD: number;
  35111. /** Culling strategy : Bounding Sphere Only.
  35112. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  35113. * It's also less accurate than the standard because some not visible objects can still be selected.
  35114. * Test : is the bounding sphere outside the frustum ?
  35115. * If not, then the cullable object is in the frustum.
  35116. */
  35117. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  35118. /** Culling strategy : Optimistic Inclusion.
  35119. * This in an inclusion test first, then the standard exclusion test.
  35120. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  35121. * 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.
  35122. * Anyway, it's as accurate as the standard strategy.
  35123. * Test :
  35124. * Is the cullable object bounding sphere center in the frustum ?
  35125. * If not, apply the default culling strategy.
  35126. */
  35127. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  35128. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  35129. * This in an inclusion test first, then the bounding sphere only exclusion test.
  35130. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  35131. * 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.
  35132. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  35133. * Test :
  35134. * Is the cullable object bounding sphere center in the frustum ?
  35135. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  35136. */
  35137. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  35138. /**
  35139. * No billboard
  35140. */
  35141. static get BILLBOARDMODE_NONE(): number;
  35142. /** Billboard on X axis */
  35143. static get BILLBOARDMODE_X(): number;
  35144. /** Billboard on Y axis */
  35145. static get BILLBOARDMODE_Y(): number;
  35146. /** Billboard on Z axis */
  35147. static get BILLBOARDMODE_Z(): number;
  35148. /** Billboard on all axes */
  35149. static get BILLBOARDMODE_ALL(): number;
  35150. /** Billboard on using position instead of orientation */
  35151. static get BILLBOARDMODE_USE_POSITION(): number;
  35152. /** @hidden */
  35153. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  35154. /**
  35155. * The culling strategy to use to check whether the mesh must be rendered or not.
  35156. * This value can be changed at any time and will be used on the next render mesh selection.
  35157. * The possible values are :
  35158. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  35159. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  35160. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  35161. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  35162. * Please read each static variable documentation to get details about the culling process.
  35163. * */
  35164. cullingStrategy: number;
  35165. /**
  35166. * Gets the number of facets in the mesh
  35167. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  35168. */
  35169. get facetNb(): number;
  35170. /**
  35171. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  35172. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  35173. */
  35174. get partitioningSubdivisions(): number;
  35175. set partitioningSubdivisions(nb: number);
  35176. /**
  35177. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  35178. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  35179. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  35180. */
  35181. get partitioningBBoxRatio(): number;
  35182. set partitioningBBoxRatio(ratio: number);
  35183. /**
  35184. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  35185. * Works only for updatable meshes.
  35186. * Doesn't work with multi-materials
  35187. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  35188. */
  35189. get mustDepthSortFacets(): boolean;
  35190. set mustDepthSortFacets(sort: boolean);
  35191. /**
  35192. * The location (Vector3) where the facet depth sort must be computed from.
  35193. * By default, the active camera position.
  35194. * Used only when facet depth sort is enabled
  35195. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  35196. */
  35197. get facetDepthSortFrom(): Vector3;
  35198. set facetDepthSortFrom(location: Vector3);
  35199. /**
  35200. * gets a boolean indicating if facetData is enabled
  35201. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  35202. */
  35203. get isFacetDataEnabled(): boolean;
  35204. /** @hidden */
  35205. _updateNonUniformScalingState(value: boolean): boolean;
  35206. /**
  35207. * An event triggered when this mesh collides with another one
  35208. */
  35209. onCollideObservable: Observable<AbstractMesh>;
  35210. /** Set a function to call when this mesh collides with another one */
  35211. set onCollide(callback: () => void);
  35212. /**
  35213. * An event triggered when the collision's position changes
  35214. */
  35215. onCollisionPositionChangeObservable: Observable<Vector3>;
  35216. /** Set a function to call when the collision's position changes */
  35217. set onCollisionPositionChange(callback: () => void);
  35218. /**
  35219. * An event triggered when material is changed
  35220. */
  35221. onMaterialChangedObservable: Observable<AbstractMesh>;
  35222. /**
  35223. * Gets or sets the orientation for POV movement & rotation
  35224. */
  35225. definedFacingForward: boolean;
  35226. /** @hidden */
  35227. _occlusionQuery: Nullable<WebGLQuery>;
  35228. /** @hidden */
  35229. _renderingGroup: Nullable<RenderingGroup>;
  35230. /**
  35231. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  35232. */
  35233. get visibility(): number;
  35234. /**
  35235. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  35236. */
  35237. set visibility(value: number);
  35238. /** Gets or sets the alpha index used to sort transparent meshes
  35239. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  35240. */
  35241. alphaIndex: number;
  35242. /**
  35243. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  35244. */
  35245. isVisible: boolean;
  35246. /**
  35247. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  35248. */
  35249. isPickable: boolean;
  35250. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  35251. showSubMeshesBoundingBox: boolean;
  35252. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  35253. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  35254. */
  35255. isBlocker: boolean;
  35256. /**
  35257. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  35258. */
  35259. enablePointerMoveEvents: boolean;
  35260. private _renderingGroupId;
  35261. /**
  35262. * Specifies the rendering group id for this mesh (0 by default)
  35263. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  35264. */
  35265. get renderingGroupId(): number;
  35266. set renderingGroupId(value: number);
  35267. private _material;
  35268. /** Gets or sets current material */
  35269. get material(): Nullable<Material>;
  35270. set material(value: Nullable<Material>);
  35271. /**
  35272. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  35273. * @see https://doc.babylonjs.com/babylon101/shadows
  35274. */
  35275. get receiveShadows(): boolean;
  35276. set receiveShadows(value: boolean);
  35277. /** Defines color to use when rendering outline */
  35278. outlineColor: Color3;
  35279. /** Define width to use when rendering outline */
  35280. outlineWidth: number;
  35281. /** Defines color to use when rendering overlay */
  35282. overlayColor: Color3;
  35283. /** Defines alpha to use when rendering overlay */
  35284. overlayAlpha: number;
  35285. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  35286. get hasVertexAlpha(): boolean;
  35287. set hasVertexAlpha(value: boolean);
  35288. /** 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) */
  35289. get useVertexColors(): boolean;
  35290. set useVertexColors(value: boolean);
  35291. /**
  35292. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  35293. */
  35294. get computeBonesUsingShaders(): boolean;
  35295. set computeBonesUsingShaders(value: boolean);
  35296. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  35297. get numBoneInfluencers(): number;
  35298. set numBoneInfluencers(value: number);
  35299. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  35300. get applyFog(): boolean;
  35301. set applyFog(value: boolean);
  35302. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  35303. useOctreeForRenderingSelection: boolean;
  35304. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  35305. useOctreeForPicking: boolean;
  35306. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  35307. useOctreeForCollisions: boolean;
  35308. /**
  35309. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  35310. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  35311. */
  35312. get layerMask(): number;
  35313. set layerMask(value: number);
  35314. /**
  35315. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  35316. */
  35317. alwaysSelectAsActiveMesh: boolean;
  35318. /**
  35319. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  35320. */
  35321. doNotSyncBoundingInfo: boolean;
  35322. /**
  35323. * Gets or sets the current action manager
  35324. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  35325. */
  35326. actionManager: Nullable<AbstractActionManager>;
  35327. private _meshCollisionData;
  35328. /**
  35329. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  35330. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  35331. */
  35332. ellipsoid: Vector3;
  35333. /**
  35334. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  35335. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  35336. */
  35337. ellipsoidOffset: Vector3;
  35338. /**
  35339. * Gets or sets a collision mask used to mask collisions (default is -1).
  35340. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  35341. */
  35342. get collisionMask(): number;
  35343. set collisionMask(mask: number);
  35344. /**
  35345. * Gets or sets a collision response flag (default is true).
  35346. * when collisionResponse is false, events are still triggered but colliding entity has no response
  35347. * This helps creating trigger volume when user wants collision feedback events but not position/velocity
  35348. * to respond to the collision.
  35349. */
  35350. get collisionResponse(): boolean;
  35351. set collisionResponse(response: boolean);
  35352. /**
  35353. * Gets or sets the current collision group mask (-1 by default).
  35354. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  35355. */
  35356. get collisionGroup(): number;
  35357. set collisionGroup(mask: number);
  35358. /**
  35359. * Gets or sets current surrounding meshes (null by default).
  35360. *
  35361. * By default collision detection is tested against every mesh in the scene.
  35362. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  35363. * meshes will be tested for the collision.
  35364. *
  35365. * Note: if set to an empty array no collision will happen when this mesh is moved.
  35366. */
  35367. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  35368. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  35369. /**
  35370. * Defines edge width used when edgesRenderer is enabled
  35371. * @see https://www.babylonjs-playground.com/#10OJSG#13
  35372. */
  35373. edgesWidth: number;
  35374. /**
  35375. * Defines edge color used when edgesRenderer is enabled
  35376. * @see https://www.babylonjs-playground.com/#10OJSG#13
  35377. */
  35378. edgesColor: Color4;
  35379. /** @hidden */
  35380. _edgesRenderer: Nullable<IEdgesRenderer>;
  35381. /** @hidden */
  35382. _masterMesh: Nullable<AbstractMesh>;
  35383. /** @hidden */
  35384. _boundingInfo: Nullable<BoundingInfo>;
  35385. /** @hidden */
  35386. _renderId: number;
  35387. /**
  35388. * Gets or sets the list of subMeshes
  35389. * @see https://doc.babylonjs.com/how_to/multi_materials
  35390. */
  35391. subMeshes: SubMesh[];
  35392. /** @hidden */
  35393. _intersectionsInProgress: AbstractMesh[];
  35394. /** @hidden */
  35395. _unIndexed: boolean;
  35396. /** @hidden */
  35397. _lightSources: Light[];
  35398. /** Gets the list of lights affecting that mesh */
  35399. get lightSources(): Light[];
  35400. /** @hidden */
  35401. get _positions(): Nullable<Vector3[]>;
  35402. /** @hidden */
  35403. _waitingData: {
  35404. lods: Nullable<any>;
  35405. actions: Nullable<any>;
  35406. freezeWorldMatrix: Nullable<boolean>;
  35407. };
  35408. /** @hidden */
  35409. _bonesTransformMatrices: Nullable<Float32Array>;
  35410. /** @hidden */
  35411. _transformMatrixTexture: Nullable<RawTexture>;
  35412. /**
  35413. * Gets or sets a skeleton to apply skining transformations
  35414. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  35415. */
  35416. set skeleton(value: Nullable<Skeleton>);
  35417. get skeleton(): Nullable<Skeleton>;
  35418. /**
  35419. * An event triggered when the mesh is rebuilt.
  35420. */
  35421. onRebuildObservable: Observable<AbstractMesh>;
  35422. /**
  35423. * Creates a new AbstractMesh
  35424. * @param name defines the name of the mesh
  35425. * @param scene defines the hosting scene
  35426. */
  35427. constructor(name: string, scene?: Nullable<Scene>);
  35428. /**
  35429. * Returns the string "AbstractMesh"
  35430. * @returns "AbstractMesh"
  35431. */
  35432. getClassName(): string;
  35433. /**
  35434. * Gets a string representation of the current mesh
  35435. * @param fullDetails defines a boolean indicating if full details must be included
  35436. * @returns a string representation of the current mesh
  35437. */
  35438. toString(fullDetails?: boolean): string;
  35439. /**
  35440. * @hidden
  35441. */
  35442. protected _getEffectiveParent(): Nullable<Node>;
  35443. /** @hidden */
  35444. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  35445. /** @hidden */
  35446. _rebuild(): void;
  35447. /** @hidden */
  35448. _resyncLightSources(): void;
  35449. /** @hidden */
  35450. _resyncLightSource(light: Light): void;
  35451. /** @hidden */
  35452. _unBindEffect(): void;
  35453. /** @hidden */
  35454. _removeLightSource(light: Light, dispose: boolean): void;
  35455. private _markSubMeshesAsDirty;
  35456. /** @hidden */
  35457. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  35458. /** @hidden */
  35459. _markSubMeshesAsAttributesDirty(): void;
  35460. /** @hidden */
  35461. _markSubMeshesAsMiscDirty(): void;
  35462. /**
  35463. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  35464. */
  35465. get scaling(): Vector3;
  35466. set scaling(newScaling: Vector3);
  35467. /**
  35468. * Returns true if the mesh is blocked. Implemented by child classes
  35469. */
  35470. get isBlocked(): boolean;
  35471. /**
  35472. * Returns the mesh itself by default. Implemented by child classes
  35473. * @param camera defines the camera to use to pick the right LOD level
  35474. * @returns the currentAbstractMesh
  35475. */
  35476. getLOD(camera: Camera): Nullable<AbstractMesh>;
  35477. /**
  35478. * Returns 0 by default. Implemented by child classes
  35479. * @returns an integer
  35480. */
  35481. getTotalVertices(): number;
  35482. /**
  35483. * Returns a positive integer : the total number of indices in this mesh geometry.
  35484. * @returns the numner of indices or zero if the mesh has no geometry.
  35485. */
  35486. getTotalIndices(): number;
  35487. /**
  35488. * Returns null by default. Implemented by child classes
  35489. * @returns null
  35490. */
  35491. getIndices(): Nullable<IndicesArray>;
  35492. /**
  35493. * Returns the array of the requested vertex data kind. Implemented by child classes
  35494. * @param kind defines the vertex data kind to use
  35495. * @returns null
  35496. */
  35497. getVerticesData(kind: string): Nullable<FloatArray>;
  35498. /**
  35499. * Sets the vertex data of the mesh geometry for the requested `kind`.
  35500. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  35501. * Note that a new underlying VertexBuffer object is created each call.
  35502. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  35503. * @param kind defines vertex data kind:
  35504. * * VertexBuffer.PositionKind
  35505. * * VertexBuffer.UVKind
  35506. * * VertexBuffer.UV2Kind
  35507. * * VertexBuffer.UV3Kind
  35508. * * VertexBuffer.UV4Kind
  35509. * * VertexBuffer.UV5Kind
  35510. * * VertexBuffer.UV6Kind
  35511. * * VertexBuffer.ColorKind
  35512. * * VertexBuffer.MatricesIndicesKind
  35513. * * VertexBuffer.MatricesIndicesExtraKind
  35514. * * VertexBuffer.MatricesWeightsKind
  35515. * * VertexBuffer.MatricesWeightsExtraKind
  35516. * @param data defines the data source
  35517. * @param updatable defines if the data must be flagged as updatable (or static)
  35518. * @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
  35519. * @returns the current mesh
  35520. */
  35521. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  35522. /**
  35523. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  35524. * If the mesh has no geometry, it is simply returned as it is.
  35525. * @param kind defines vertex data kind:
  35526. * * VertexBuffer.PositionKind
  35527. * * VertexBuffer.UVKind
  35528. * * VertexBuffer.UV2Kind
  35529. * * VertexBuffer.UV3Kind
  35530. * * VertexBuffer.UV4Kind
  35531. * * VertexBuffer.UV5Kind
  35532. * * VertexBuffer.UV6Kind
  35533. * * VertexBuffer.ColorKind
  35534. * * VertexBuffer.MatricesIndicesKind
  35535. * * VertexBuffer.MatricesIndicesExtraKind
  35536. * * VertexBuffer.MatricesWeightsKind
  35537. * * VertexBuffer.MatricesWeightsExtraKind
  35538. * @param data defines the data source
  35539. * @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
  35540. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  35541. * @returns the current mesh
  35542. */
  35543. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  35544. /**
  35545. * Sets the mesh indices,
  35546. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  35547. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  35548. * @param totalVertices Defines the total number of vertices
  35549. * @returns the current mesh
  35550. */
  35551. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  35552. /**
  35553. * Gets a boolean indicating if specific vertex data is present
  35554. * @param kind defines the vertex data kind to use
  35555. * @returns true is data kind is present
  35556. */
  35557. isVerticesDataPresent(kind: string): boolean;
  35558. /**
  35559. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  35560. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  35561. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  35562. * @returns a BoundingInfo
  35563. */
  35564. getBoundingInfo(): BoundingInfo;
  35565. /**
  35566. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  35567. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  35568. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  35569. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  35570. * @returns the current mesh
  35571. */
  35572. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  35573. /**
  35574. * Overwrite the current bounding info
  35575. * @param boundingInfo defines the new bounding info
  35576. * @returns the current mesh
  35577. */
  35578. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  35579. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  35580. get useBones(): boolean;
  35581. /** @hidden */
  35582. _preActivate(): void;
  35583. /** @hidden */
  35584. _preActivateForIntermediateRendering(renderId: number): void;
  35585. /** @hidden */
  35586. _activate(renderId: number, intermediateRendering: boolean): boolean;
  35587. /** @hidden */
  35588. _postActivate(): void;
  35589. /** @hidden */
  35590. _freeze(): void;
  35591. /** @hidden */
  35592. _unFreeze(): void;
  35593. /**
  35594. * Gets the current world matrix
  35595. * @returns a Matrix
  35596. */
  35597. getWorldMatrix(): Matrix;
  35598. /** @hidden */
  35599. _getWorldMatrixDeterminant(): number;
  35600. /**
  35601. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  35602. */
  35603. get isAnInstance(): boolean;
  35604. /**
  35605. * Gets a boolean indicating if this mesh has instances
  35606. */
  35607. get hasInstances(): boolean;
  35608. /**
  35609. * Gets a boolean indicating if this mesh has thin instances
  35610. */
  35611. get hasThinInstances(): boolean;
  35612. /**
  35613. * Perform relative position change from the point of view of behind the front of the mesh.
  35614. * This is performed taking into account the meshes current rotation, so you do not have to care.
  35615. * Supports definition of mesh facing forward or backward
  35616. * @param amountRight defines the distance on the right axis
  35617. * @param amountUp defines the distance on the up axis
  35618. * @param amountForward defines the distance on the forward axis
  35619. * @returns the current mesh
  35620. */
  35621. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  35622. /**
  35623. * Calculate relative position change from the point of view of behind the front of the mesh.
  35624. * This is performed taking into account the meshes current rotation, so you do not have to care.
  35625. * Supports definition of mesh facing forward or backward
  35626. * @param amountRight defines the distance on the right axis
  35627. * @param amountUp defines the distance on the up axis
  35628. * @param amountForward defines the distance on the forward axis
  35629. * @returns the new displacement vector
  35630. */
  35631. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  35632. /**
  35633. * Perform relative rotation change from the point of view of behind the front of the mesh.
  35634. * Supports definition of mesh facing forward or backward
  35635. * @param flipBack defines the flip
  35636. * @param twirlClockwise defines the twirl
  35637. * @param tiltRight defines the tilt
  35638. * @returns the current mesh
  35639. */
  35640. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  35641. /**
  35642. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  35643. * Supports definition of mesh facing forward or backward.
  35644. * @param flipBack defines the flip
  35645. * @param twirlClockwise defines the twirl
  35646. * @param tiltRight defines the tilt
  35647. * @returns the new rotation vector
  35648. */
  35649. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  35650. /**
  35651. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  35652. * This means the mesh underlying bounding box and sphere are recomputed.
  35653. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  35654. * @returns the current mesh
  35655. */
  35656. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  35657. /** @hidden */
  35658. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  35659. /** @hidden */
  35660. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  35661. /** @hidden */
  35662. _updateBoundingInfo(): AbstractMesh;
  35663. /** @hidden */
  35664. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  35665. /** @hidden */
  35666. protected _afterComputeWorldMatrix(): void;
  35667. /** @hidden */
  35668. get _effectiveMesh(): AbstractMesh;
  35669. /**
  35670. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  35671. * A mesh is in the frustum if its bounding box intersects the frustum
  35672. * @param frustumPlanes defines the frustum to test
  35673. * @returns true if the mesh is in the frustum planes
  35674. */
  35675. isInFrustum(frustumPlanes: Plane[]): boolean;
  35676. /**
  35677. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  35678. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  35679. * @param frustumPlanes defines the frustum to test
  35680. * @returns true if the mesh is completely in the frustum planes
  35681. */
  35682. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  35683. /**
  35684. * True if the mesh intersects another mesh or a SolidParticle object
  35685. * @param mesh defines a target mesh or SolidParticle to test
  35686. * @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)
  35687. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  35688. * @returns true if there is an intersection
  35689. */
  35690. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  35691. /**
  35692. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  35693. * @param point defines the point to test
  35694. * @returns true if there is an intersection
  35695. */
  35696. intersectsPoint(point: Vector3): boolean;
  35697. /**
  35698. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  35699. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  35700. */
  35701. get checkCollisions(): boolean;
  35702. set checkCollisions(collisionEnabled: boolean);
  35703. /**
  35704. * Gets Collider object used to compute collisions (not physics)
  35705. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  35706. */
  35707. get collider(): Nullable<Collider>;
  35708. /**
  35709. * Move the mesh using collision engine
  35710. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  35711. * @param displacement defines the requested displacement vector
  35712. * @returns the current mesh
  35713. */
  35714. moveWithCollisions(displacement: Vector3): AbstractMesh;
  35715. private _onCollisionPositionChange;
  35716. /** @hidden */
  35717. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  35718. /** @hidden */
  35719. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  35720. /** @hidden */
  35721. _checkCollision(collider: Collider): AbstractMesh;
  35722. /** @hidden */
  35723. _generatePointsArray(): boolean;
  35724. /**
  35725. * Checks if the passed Ray intersects with the mesh
  35726. * @param ray defines the ray to use
  35727. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  35728. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35729. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  35730. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  35731. * @param skipBoundingInfo a boolean indicating if we should skip the bounding info check
  35732. * @returns the picking info
  35733. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  35734. */
  35735. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix, skipBoundingInfo?: boolean): PickingInfo;
  35736. /**
  35737. * Clones the current mesh
  35738. * @param name defines the mesh name
  35739. * @param newParent defines the new mesh parent
  35740. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  35741. * @returns the new mesh
  35742. */
  35743. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  35744. /**
  35745. * Disposes all the submeshes of the current meshnp
  35746. * @returns the current mesh
  35747. */
  35748. releaseSubMeshes(): AbstractMesh;
  35749. /**
  35750. * Releases resources associated with this abstract mesh.
  35751. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  35752. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  35753. */
  35754. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  35755. /**
  35756. * Adds the passed mesh as a child to the current mesh
  35757. * @param mesh defines the child mesh
  35758. * @returns the current mesh
  35759. */
  35760. addChild(mesh: AbstractMesh): AbstractMesh;
  35761. /**
  35762. * Removes the passed mesh from the current mesh children list
  35763. * @param mesh defines the child mesh
  35764. * @returns the current mesh
  35765. */
  35766. removeChild(mesh: AbstractMesh): AbstractMesh;
  35767. /** @hidden */
  35768. private _initFacetData;
  35769. /**
  35770. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  35771. * This method can be called within the render loop.
  35772. * 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
  35773. * @returns the current mesh
  35774. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  35775. */
  35776. updateFacetData(): AbstractMesh;
  35777. /**
  35778. * Returns the facetLocalNormals array.
  35779. * The normals are expressed in the mesh local spac
  35780. * @returns an array of Vector3
  35781. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  35782. */
  35783. getFacetLocalNormals(): Vector3[];
  35784. /**
  35785. * Returns the facetLocalPositions array.
  35786. * The facet positions are expressed in the mesh local space
  35787. * @returns an array of Vector3
  35788. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  35789. */
  35790. getFacetLocalPositions(): Vector3[];
  35791. /**
  35792. * Returns the facetLocalPartioning array
  35793. * @returns an array of array of numbers
  35794. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  35795. */
  35796. getFacetLocalPartitioning(): number[][];
  35797. /**
  35798. * Returns the i-th facet position in the world system.
  35799. * This method allocates a new Vector3 per call
  35800. * @param i defines the facet index
  35801. * @returns a new Vector3
  35802. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  35803. */
  35804. getFacetPosition(i: number): Vector3;
  35805. /**
  35806. * Sets the reference Vector3 with the i-th facet position in the world system
  35807. * @param i defines the facet index
  35808. * @param ref defines the target vector
  35809. * @returns the current mesh
  35810. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  35811. */
  35812. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  35813. /**
  35814. * Returns the i-th facet normal in the world system.
  35815. * This method allocates a new Vector3 per call
  35816. * @param i defines the facet index
  35817. * @returns a new Vector3
  35818. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  35819. */
  35820. getFacetNormal(i: number): Vector3;
  35821. /**
  35822. * Sets the reference Vector3 with the i-th facet normal in the world system
  35823. * @param i defines the facet index
  35824. * @param ref defines the target vector
  35825. * @returns the current mesh
  35826. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  35827. */
  35828. getFacetNormalToRef(i: number, ref: Vector3): this;
  35829. /**
  35830. * 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)
  35831. * @param x defines x coordinate
  35832. * @param y defines y coordinate
  35833. * @param z defines z coordinate
  35834. * @returns the array of facet indexes
  35835. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  35836. */
  35837. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  35838. /**
  35839. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  35840. * @param projected sets as the (x,y,z) world projection on the facet
  35841. * @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
  35842. * @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
  35843. * @param x defines x coordinate
  35844. * @param y defines y coordinate
  35845. * @param z defines z coordinate
  35846. * @returns the face index if found (or null instead)
  35847. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  35848. */
  35849. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  35850. /**
  35851. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  35852. * @param projected sets as the (x,y,z) local projection on the facet
  35853. * @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
  35854. * @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
  35855. * @param x defines x coordinate
  35856. * @param y defines y coordinate
  35857. * @param z defines z coordinate
  35858. * @returns the face index if found (or null instead)
  35859. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  35860. */
  35861. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  35862. /**
  35863. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  35864. * @returns the parameters
  35865. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  35866. */
  35867. getFacetDataParameters(): any;
  35868. /**
  35869. * Disables the feature FacetData and frees the related memory
  35870. * @returns the current mesh
  35871. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  35872. */
  35873. disableFacetData(): AbstractMesh;
  35874. /**
  35875. * Updates the AbstractMesh indices array
  35876. * @param indices defines the data source
  35877. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  35878. * @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)
  35879. * @returns the current mesh
  35880. */
  35881. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  35882. /**
  35883. * Creates new normals data for the mesh
  35884. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  35885. * @returns the current mesh
  35886. */
  35887. createNormals(updatable: boolean): AbstractMesh;
  35888. /**
  35889. * Align the mesh with a normal
  35890. * @param normal defines the normal to use
  35891. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  35892. * @returns the current mesh
  35893. */
  35894. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  35895. /** @hidden */
  35896. _checkOcclusionQuery(): boolean;
  35897. /**
  35898. * Disables the mesh edge rendering mode
  35899. * @returns the currentAbstractMesh
  35900. */
  35901. disableEdgesRendering(): AbstractMesh;
  35902. /**
  35903. * Enables the edge rendering mode on the mesh.
  35904. * This mode makes the mesh edges visible
  35905. * @param epsilon defines the maximal distance between two angles to detect a face
  35906. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  35907. * @param options options to the edge renderer
  35908. * @returns the currentAbstractMesh
  35909. * @see https://www.babylonjs-playground.com/#19O9TU#0
  35910. */
  35911. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean, options?: IEdgesRendererOptions): AbstractMesh;
  35912. /**
  35913. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  35914. * @returns an array of particle systems in the scene that use the mesh as an emitter
  35915. */
  35916. getConnectedParticleSystems(): IParticleSystem[];
  35917. }
  35918. }
  35919. declare module BABYLON {
  35920. /**
  35921. * Interface used to define ActionEvent
  35922. */
  35923. export interface IActionEvent {
  35924. /** The mesh or sprite that triggered the action */
  35925. source: any;
  35926. /** The X mouse cursor position at the time of the event */
  35927. pointerX: number;
  35928. /** The Y mouse cursor position at the time of the event */
  35929. pointerY: number;
  35930. /** The mesh that is currently pointed at (can be null) */
  35931. meshUnderPointer: Nullable<AbstractMesh>;
  35932. /** the original (browser) event that triggered the ActionEvent */
  35933. sourceEvent?: any;
  35934. /** additional data for the event */
  35935. additionalData?: any;
  35936. }
  35937. /**
  35938. * ActionEvent is the event being sent when an action is triggered.
  35939. */
  35940. export class ActionEvent implements IActionEvent {
  35941. /** The mesh or sprite that triggered the action */
  35942. source: any;
  35943. /** The X mouse cursor position at the time of the event */
  35944. pointerX: number;
  35945. /** The Y mouse cursor position at the time of the event */
  35946. pointerY: number;
  35947. /** The mesh that is currently pointed at (can be null) */
  35948. meshUnderPointer: Nullable<AbstractMesh>;
  35949. /** the original (browser) event that triggered the ActionEvent */
  35950. sourceEvent?: any;
  35951. /** additional data for the event */
  35952. additionalData?: any;
  35953. /**
  35954. * Creates a new ActionEvent
  35955. * @param source The mesh or sprite that triggered the action
  35956. * @param pointerX The X mouse cursor position at the time of the event
  35957. * @param pointerY The Y mouse cursor position at the time of the event
  35958. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  35959. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  35960. * @param additionalData additional data for the event
  35961. */
  35962. constructor(
  35963. /** The mesh or sprite that triggered the action */
  35964. source: any,
  35965. /** The X mouse cursor position at the time of the event */
  35966. pointerX: number,
  35967. /** The Y mouse cursor position at the time of the event */
  35968. pointerY: number,
  35969. /** The mesh that is currently pointed at (can be null) */
  35970. meshUnderPointer: Nullable<AbstractMesh>,
  35971. /** the original (browser) event that triggered the ActionEvent */
  35972. sourceEvent?: any,
  35973. /** additional data for the event */
  35974. additionalData?: any);
  35975. /**
  35976. * Helper function to auto-create an ActionEvent from a source mesh.
  35977. * @param source The source mesh that triggered the event
  35978. * @param evt The original (browser) event
  35979. * @param additionalData additional data for the event
  35980. * @returns the new ActionEvent
  35981. */
  35982. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  35983. /**
  35984. * Helper function to auto-create an ActionEvent from a source sprite
  35985. * @param source The source sprite that triggered the event
  35986. * @param scene Scene associated with the sprite
  35987. * @param evt The original (browser) event
  35988. * @param additionalData additional data for the event
  35989. * @returns the new ActionEvent
  35990. */
  35991. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  35992. /**
  35993. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  35994. * @param scene the scene where the event occurred
  35995. * @param evt The original (browser) event
  35996. * @returns the new ActionEvent
  35997. */
  35998. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  35999. /**
  36000. * Helper function to auto-create an ActionEvent from a primitive
  36001. * @param prim defines the target primitive
  36002. * @param pointerPos defines the pointer position
  36003. * @param evt The original (browser) event
  36004. * @param additionalData additional data for the event
  36005. * @returns the new ActionEvent
  36006. */
  36007. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  36008. }
  36009. }
  36010. declare module BABYLON {
  36011. /**
  36012. * Abstract class used to decouple action Manager from scene and meshes.
  36013. * Do not instantiate.
  36014. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  36015. */
  36016. export abstract class AbstractActionManager implements IDisposable {
  36017. /** Gets the list of active triggers */
  36018. static Triggers: {
  36019. [key: string]: number;
  36020. };
  36021. /** Gets the cursor to use when hovering items */
  36022. hoverCursor: string;
  36023. /** Gets the list of actions */
  36024. actions: IAction[];
  36025. /**
  36026. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  36027. */
  36028. isRecursive: boolean;
  36029. /**
  36030. * Releases all associated resources
  36031. */
  36032. abstract dispose(): void;
  36033. /**
  36034. * Does this action manager has pointer triggers
  36035. */
  36036. abstract get hasPointerTriggers(): boolean;
  36037. /**
  36038. * Does this action manager has pick triggers
  36039. */
  36040. abstract get hasPickTriggers(): boolean;
  36041. /**
  36042. * Process a specific trigger
  36043. * @param trigger defines the trigger to process
  36044. * @param evt defines the event details to be processed
  36045. */
  36046. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  36047. /**
  36048. * Does this action manager handles actions of any of the given triggers
  36049. * @param triggers defines the triggers to be tested
  36050. * @return a boolean indicating whether one (or more) of the triggers is handled
  36051. */
  36052. abstract hasSpecificTriggers(triggers: number[]): boolean;
  36053. /**
  36054. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  36055. * speed.
  36056. * @param triggerA defines the trigger to be tested
  36057. * @param triggerB defines the trigger to be tested
  36058. * @return a boolean indicating whether one (or more) of the triggers is handled
  36059. */
  36060. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  36061. /**
  36062. * Does this action manager handles actions of a given trigger
  36063. * @param trigger defines the trigger to be tested
  36064. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  36065. * @return whether the trigger is handled
  36066. */
  36067. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  36068. /**
  36069. * Serialize this manager to a JSON object
  36070. * @param name defines the property name to store this manager
  36071. * @returns a JSON representation of this manager
  36072. */
  36073. abstract serialize(name: string): any;
  36074. /**
  36075. * Registers an action to this action manager
  36076. * @param action defines the action to be registered
  36077. * @return the action amended (prepared) after registration
  36078. */
  36079. abstract registerAction(action: IAction): Nullable<IAction>;
  36080. /**
  36081. * Unregisters an action to this action manager
  36082. * @param action defines the action to be unregistered
  36083. * @return a boolean indicating whether the action has been unregistered
  36084. */
  36085. abstract unregisterAction(action: IAction): Boolean;
  36086. /**
  36087. * Does exist one action manager with at least one trigger
  36088. **/
  36089. static get HasTriggers(): boolean;
  36090. /**
  36091. * Does exist one action manager with at least one pick trigger
  36092. **/
  36093. static get HasPickTriggers(): boolean;
  36094. /**
  36095. * Does exist one action manager that handles actions of a given trigger
  36096. * @param trigger defines the trigger to be tested
  36097. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  36098. **/
  36099. static HasSpecificTrigger(trigger: number): boolean;
  36100. }
  36101. }
  36102. declare module BABYLON {
  36103. /**
  36104. * Defines how a node can be built from a string name.
  36105. */
  36106. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  36107. /**
  36108. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  36109. */
  36110. export class Node implements IBehaviorAware<Node> {
  36111. /** @hidden */
  36112. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  36113. private static _NodeConstructors;
  36114. /**
  36115. * Add a new node constructor
  36116. * @param type defines the type name of the node to construct
  36117. * @param constructorFunc defines the constructor function
  36118. */
  36119. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  36120. /**
  36121. * Returns a node constructor based on type name
  36122. * @param type defines the type name
  36123. * @param name defines the new node name
  36124. * @param scene defines the hosting scene
  36125. * @param options defines optional options to transmit to constructors
  36126. * @returns the new constructor or null
  36127. */
  36128. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  36129. /**
  36130. * Gets or sets the name of the node
  36131. */
  36132. name: string;
  36133. /**
  36134. * Gets or sets the id of the node
  36135. */
  36136. id: string;
  36137. /**
  36138. * Gets or sets the unique id of the node
  36139. */
  36140. uniqueId: number;
  36141. /**
  36142. * Gets or sets a string used to store user defined state for the node
  36143. */
  36144. state: string;
  36145. /**
  36146. * Gets or sets an object used to store user defined information for the node
  36147. */
  36148. metadata: any;
  36149. /**
  36150. * For internal use only. Please do not use.
  36151. */
  36152. reservedDataStore: any;
  36153. /**
  36154. * List of inspectable custom properties (used by the Inspector)
  36155. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  36156. */
  36157. inspectableCustomProperties: IInspectable[];
  36158. private _doNotSerialize;
  36159. /**
  36160. * Gets or sets a boolean used to define if the node must be serialized
  36161. */
  36162. get doNotSerialize(): boolean;
  36163. set doNotSerialize(value: boolean);
  36164. /** @hidden */
  36165. _isDisposed: boolean;
  36166. /**
  36167. * Gets a list of Animations associated with the node
  36168. */
  36169. animations: Animation[];
  36170. protected _ranges: {
  36171. [name: string]: Nullable<AnimationRange>;
  36172. };
  36173. /**
  36174. * Callback raised when the node is ready to be used
  36175. */
  36176. onReady: Nullable<(node: Node) => void>;
  36177. private _isEnabled;
  36178. private _isParentEnabled;
  36179. private _isReady;
  36180. /** @hidden */
  36181. _currentRenderId: number;
  36182. private _parentUpdateId;
  36183. /** @hidden */
  36184. _childUpdateId: number;
  36185. /** @hidden */
  36186. _waitingParentId: Nullable<string>;
  36187. /** @hidden */
  36188. _scene: Scene;
  36189. /** @hidden */
  36190. _cache: any;
  36191. private _parentNode;
  36192. private _children;
  36193. /** @hidden */
  36194. _worldMatrix: Matrix;
  36195. /** @hidden */
  36196. _worldMatrixDeterminant: number;
  36197. /** @hidden */
  36198. _worldMatrixDeterminantIsDirty: boolean;
  36199. /** @hidden */
  36200. private _sceneRootNodesIndex;
  36201. /**
  36202. * Gets a boolean indicating if the node has been disposed
  36203. * @returns true if the node was disposed
  36204. */
  36205. isDisposed(): boolean;
  36206. /**
  36207. * Gets or sets the parent of the node (without keeping the current position in the scene)
  36208. * @see https://doc.babylonjs.com/how_to/parenting
  36209. */
  36210. set parent(parent: Nullable<Node>);
  36211. get parent(): Nullable<Node>;
  36212. /** @hidden */
  36213. _addToSceneRootNodes(): void;
  36214. /** @hidden */
  36215. _removeFromSceneRootNodes(): void;
  36216. private _animationPropertiesOverride;
  36217. /**
  36218. * Gets or sets the animation properties override
  36219. */
  36220. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  36221. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  36222. /**
  36223. * Gets a string identifying the name of the class
  36224. * @returns "Node" string
  36225. */
  36226. getClassName(): string;
  36227. /** @hidden */
  36228. readonly _isNode: boolean;
  36229. /**
  36230. * An event triggered when the mesh is disposed
  36231. */
  36232. onDisposeObservable: Observable<Node>;
  36233. private _onDisposeObserver;
  36234. /**
  36235. * Sets a callback that will be raised when the node will be disposed
  36236. */
  36237. set onDispose(callback: () => void);
  36238. /**
  36239. * Creates a new Node
  36240. * @param name the name and id to be given to this node
  36241. * @param scene the scene this node will be added to
  36242. */
  36243. constructor(name: string, scene?: Nullable<Scene>);
  36244. /**
  36245. * Gets the scene of the node
  36246. * @returns a scene
  36247. */
  36248. getScene(): Scene;
  36249. /**
  36250. * Gets the engine of the node
  36251. * @returns a Engine
  36252. */
  36253. getEngine(): Engine;
  36254. private _behaviors;
  36255. /**
  36256. * Attach a behavior to the node
  36257. * @see https://doc.babylonjs.com/features/behaviour
  36258. * @param behavior defines the behavior to attach
  36259. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  36260. * @returns the current Node
  36261. */
  36262. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  36263. /**
  36264. * Remove an attached behavior
  36265. * @see https://doc.babylonjs.com/features/behaviour
  36266. * @param behavior defines the behavior to attach
  36267. * @returns the current Node
  36268. */
  36269. removeBehavior(behavior: Behavior<Node>): Node;
  36270. /**
  36271. * Gets the list of attached behaviors
  36272. * @see https://doc.babylonjs.com/features/behaviour
  36273. */
  36274. get behaviors(): Behavior<Node>[];
  36275. /**
  36276. * Gets an attached behavior by name
  36277. * @param name defines the name of the behavior to look for
  36278. * @see https://doc.babylonjs.com/features/behaviour
  36279. * @returns null if behavior was not found else the requested behavior
  36280. */
  36281. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  36282. /**
  36283. * Returns the latest update of the World matrix
  36284. * @returns a Matrix
  36285. */
  36286. getWorldMatrix(): Matrix;
  36287. /** @hidden */
  36288. _getWorldMatrixDeterminant(): number;
  36289. /**
  36290. * Returns directly the latest state of the mesh World matrix.
  36291. * A Matrix is returned.
  36292. */
  36293. get worldMatrixFromCache(): Matrix;
  36294. /** @hidden */
  36295. _initCache(): void;
  36296. /** @hidden */
  36297. updateCache(force?: boolean): void;
  36298. /** @hidden */
  36299. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  36300. /** @hidden */
  36301. _updateCache(ignoreParentClass?: boolean): void;
  36302. /** @hidden */
  36303. _isSynchronized(): boolean;
  36304. /** @hidden */
  36305. _markSyncedWithParent(): void;
  36306. /** @hidden */
  36307. isSynchronizedWithParent(): boolean;
  36308. /** @hidden */
  36309. isSynchronized(): boolean;
  36310. /**
  36311. * Is this node ready to be used/rendered
  36312. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  36313. * @return true if the node is ready
  36314. */
  36315. isReady(completeCheck?: boolean): boolean;
  36316. /**
  36317. * Is this node enabled?
  36318. * 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
  36319. * @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
  36320. * @return whether this node (and its parent) is enabled
  36321. */
  36322. isEnabled(checkAncestors?: boolean): boolean;
  36323. /** @hidden */
  36324. protected _syncParentEnabledState(): void;
  36325. /**
  36326. * Set the enabled state of this node
  36327. * @param value defines the new enabled state
  36328. */
  36329. setEnabled(value: boolean): void;
  36330. /**
  36331. * Is this node a descendant of the given node?
  36332. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  36333. * @param ancestor defines the parent node to inspect
  36334. * @returns a boolean indicating if this node is a descendant of the given node
  36335. */
  36336. isDescendantOf(ancestor: Node): boolean;
  36337. /** @hidden */
  36338. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  36339. /**
  36340. * Will return all nodes that have this node as ascendant
  36341. * @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
  36342. * @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
  36343. * @return all children nodes of all types
  36344. */
  36345. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  36346. /**
  36347. * Get all child-meshes of this node
  36348. * @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)
  36349. * @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
  36350. * @returns an array of AbstractMesh
  36351. */
  36352. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  36353. /**
  36354. * Get all direct children of this node
  36355. * @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
  36356. * @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)
  36357. * @returns an array of Node
  36358. */
  36359. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  36360. /** @hidden */
  36361. _setReady(state: boolean): void;
  36362. /**
  36363. * Get an animation by name
  36364. * @param name defines the name of the animation to look for
  36365. * @returns null if not found else the requested animation
  36366. */
  36367. getAnimationByName(name: string): Nullable<Animation>;
  36368. /**
  36369. * Creates an animation range for this node
  36370. * @param name defines the name of the range
  36371. * @param from defines the starting key
  36372. * @param to defines the end key
  36373. */
  36374. createAnimationRange(name: string, from: number, to: number): void;
  36375. /**
  36376. * Delete a specific animation range
  36377. * @param name defines the name of the range to delete
  36378. * @param deleteFrames defines if animation frames from the range must be deleted as well
  36379. */
  36380. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  36381. /**
  36382. * Get an animation range by name
  36383. * @param name defines the name of the animation range to look for
  36384. * @returns null if not found else the requested animation range
  36385. */
  36386. getAnimationRange(name: string): Nullable<AnimationRange>;
  36387. /**
  36388. * Gets the list of all animation ranges defined on this node
  36389. * @returns an array
  36390. */
  36391. getAnimationRanges(): Nullable<AnimationRange>[];
  36392. /**
  36393. * Will start the animation sequence
  36394. * @param name defines the range frames for animation sequence
  36395. * @param loop defines if the animation should loop (false by default)
  36396. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  36397. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  36398. * @returns the object created for this animation. If range does not exist, it will return null
  36399. */
  36400. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  36401. /**
  36402. * Serialize animation ranges into a JSON compatible object
  36403. * @returns serialization object
  36404. */
  36405. serializeAnimationRanges(): any;
  36406. /**
  36407. * Computes the world matrix of the node
  36408. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  36409. * @returns the world matrix
  36410. */
  36411. computeWorldMatrix(force?: boolean): Matrix;
  36412. /**
  36413. * Releases resources associated with this node.
  36414. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  36415. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  36416. */
  36417. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  36418. /**
  36419. * Parse animation range data from a serialization object and store them into a given node
  36420. * @param node defines where to store the animation ranges
  36421. * @param parsedNode defines the serialization object to read data from
  36422. * @param scene defines the hosting scene
  36423. */
  36424. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  36425. /**
  36426. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  36427. * @param includeDescendants Include bounding info from descendants as well (true by default)
  36428. * @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
  36429. * @returns the new bounding vectors
  36430. */
  36431. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  36432. min: Vector3;
  36433. max: Vector3;
  36434. };
  36435. }
  36436. }
  36437. declare module BABYLON {
  36438. /**
  36439. * @hidden
  36440. */
  36441. export class _IAnimationState {
  36442. key: number;
  36443. repeatCount: number;
  36444. workValue?: any;
  36445. loopMode?: number;
  36446. offsetValue?: any;
  36447. highLimitValue?: any;
  36448. }
  36449. /**
  36450. * Class used to store any kind of animation
  36451. */
  36452. export class Animation {
  36453. /**Name of the animation */
  36454. name: string;
  36455. /**Property to animate */
  36456. targetProperty: string;
  36457. /**The frames per second of the animation */
  36458. framePerSecond: number;
  36459. /**The data type of the animation */
  36460. dataType: number;
  36461. /**The loop mode of the animation */
  36462. loopMode?: number | undefined;
  36463. /**Specifies if blending should be enabled */
  36464. enableBlending?: boolean | undefined;
  36465. /**
  36466. * Use matrix interpolation instead of using direct key value when animating matrices
  36467. */
  36468. static AllowMatricesInterpolation: boolean;
  36469. /**
  36470. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  36471. */
  36472. static AllowMatrixDecomposeForInterpolation: boolean;
  36473. /** Define the Url to load snippets */
  36474. static SnippetUrl: string;
  36475. /** Snippet ID if the animation was created from the snippet server */
  36476. snippetId: string;
  36477. /**
  36478. * Stores the key frames of the animation
  36479. */
  36480. private _keys;
  36481. /**
  36482. * Stores the easing function of the animation
  36483. */
  36484. private _easingFunction;
  36485. /**
  36486. * @hidden Internal use only
  36487. */
  36488. _runtimeAnimations: RuntimeAnimation[];
  36489. /**
  36490. * The set of event that will be linked to this animation
  36491. */
  36492. private _events;
  36493. /**
  36494. * Stores an array of target property paths
  36495. */
  36496. targetPropertyPath: string[];
  36497. /**
  36498. * Stores the blending speed of the animation
  36499. */
  36500. blendingSpeed: number;
  36501. /**
  36502. * Stores the animation ranges for the animation
  36503. */
  36504. private _ranges;
  36505. /**
  36506. * @hidden Internal use
  36507. */
  36508. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  36509. /**
  36510. * Sets up an animation
  36511. * @param property The property to animate
  36512. * @param animationType The animation type to apply
  36513. * @param framePerSecond The frames per second of the animation
  36514. * @param easingFunction The easing function used in the animation
  36515. * @returns The created animation
  36516. */
  36517. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  36518. /**
  36519. * Create and start an animation on a node
  36520. * @param name defines the name of the global animation that will be run on all nodes
  36521. * @param node defines the root node where the animation will take place
  36522. * @param targetProperty defines property to animate
  36523. * @param framePerSecond defines the number of frame per second yo use
  36524. * @param totalFrame defines the number of frames in total
  36525. * @param from defines the initial value
  36526. * @param to defines the final value
  36527. * @param loopMode defines which loop mode you want to use (off by default)
  36528. * @param easingFunction defines the easing function to use (linear by default)
  36529. * @param onAnimationEnd defines the callback to call when animation end
  36530. * @returns the animatable created for this animation
  36531. */
  36532. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  36533. /**
  36534. * Create and start an animation on a node and its descendants
  36535. * @param name defines the name of the global animation that will be run on all nodes
  36536. * @param node defines the root node where the animation will take place
  36537. * @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
  36538. * @param targetProperty defines property to animate
  36539. * @param framePerSecond defines the number of frame per second to use
  36540. * @param totalFrame defines the number of frames in total
  36541. * @param from defines the initial value
  36542. * @param to defines the final value
  36543. * @param loopMode defines which loop mode you want to use (off by default)
  36544. * @param easingFunction defines the easing function to use (linear by default)
  36545. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  36546. * @returns the list of animatables created for all nodes
  36547. * @example https://www.babylonjs-playground.com/#MH0VLI
  36548. */
  36549. 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[]>;
  36550. /**
  36551. * Creates a new animation, merges it with the existing animations and starts it
  36552. * @param name Name of the animation
  36553. * @param node Node which contains the scene that begins the animations
  36554. * @param targetProperty Specifies which property to animate
  36555. * @param framePerSecond The frames per second of the animation
  36556. * @param totalFrame The total number of frames
  36557. * @param from The frame at the beginning of the animation
  36558. * @param to The frame at the end of the animation
  36559. * @param loopMode Specifies the loop mode of the animation
  36560. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  36561. * @param onAnimationEnd Callback to run once the animation is complete
  36562. * @returns Nullable animation
  36563. */
  36564. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  36565. /**
  36566. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  36567. * @param sourceAnimation defines the Animation containing keyframes to convert
  36568. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  36569. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  36570. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  36571. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  36572. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  36573. */
  36574. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  36575. /**
  36576. * Transition property of an host to the target Value
  36577. * @param property The property to transition
  36578. * @param targetValue The target Value of the property
  36579. * @param host The object where the property to animate belongs
  36580. * @param scene Scene used to run the animation
  36581. * @param frameRate Framerate (in frame/s) to use
  36582. * @param transition The transition type we want to use
  36583. * @param duration The duration of the animation, in milliseconds
  36584. * @param onAnimationEnd Callback trigger at the end of the animation
  36585. * @returns Nullable animation
  36586. */
  36587. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  36588. /**
  36589. * Return the array of runtime animations currently using this animation
  36590. */
  36591. get runtimeAnimations(): RuntimeAnimation[];
  36592. /**
  36593. * Specifies if any of the runtime animations are currently running
  36594. */
  36595. get hasRunningRuntimeAnimations(): boolean;
  36596. /**
  36597. * Initializes the animation
  36598. * @param name Name of the animation
  36599. * @param targetProperty Property to animate
  36600. * @param framePerSecond The frames per second of the animation
  36601. * @param dataType The data type of the animation
  36602. * @param loopMode The loop mode of the animation
  36603. * @param enableBlending Specifies if blending should be enabled
  36604. */
  36605. constructor(
  36606. /**Name of the animation */
  36607. name: string,
  36608. /**Property to animate */
  36609. targetProperty: string,
  36610. /**The frames per second of the animation */
  36611. framePerSecond: number,
  36612. /**The data type of the animation */
  36613. dataType: number,
  36614. /**The loop mode of the animation */
  36615. loopMode?: number | undefined,
  36616. /**Specifies if blending should be enabled */
  36617. enableBlending?: boolean | undefined);
  36618. /**
  36619. * Converts the animation to a string
  36620. * @param fullDetails support for multiple levels of logging within scene loading
  36621. * @returns String form of the animation
  36622. */
  36623. toString(fullDetails?: boolean): string;
  36624. /**
  36625. * Add an event to this animation
  36626. * @param event Event to add
  36627. */
  36628. addEvent(event: AnimationEvent): void;
  36629. /**
  36630. * Remove all events found at the given frame
  36631. * @param frame The frame to remove events from
  36632. */
  36633. removeEvents(frame: number): void;
  36634. /**
  36635. * Retrieves all the events from the animation
  36636. * @returns Events from the animation
  36637. */
  36638. getEvents(): AnimationEvent[];
  36639. /**
  36640. * Creates an animation range
  36641. * @param name Name of the animation range
  36642. * @param from Starting frame of the animation range
  36643. * @param to Ending frame of the animation
  36644. */
  36645. createRange(name: string, from: number, to: number): void;
  36646. /**
  36647. * Deletes an animation range by name
  36648. * @param name Name of the animation range to delete
  36649. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  36650. */
  36651. deleteRange(name: string, deleteFrames?: boolean): void;
  36652. /**
  36653. * Gets the animation range by name, or null if not defined
  36654. * @param name Name of the animation range
  36655. * @returns Nullable animation range
  36656. */
  36657. getRange(name: string): Nullable<AnimationRange>;
  36658. /**
  36659. * Gets the key frames from the animation
  36660. * @returns The key frames of the animation
  36661. */
  36662. getKeys(): Array<IAnimationKey>;
  36663. /**
  36664. * Gets the highest frame rate of the animation
  36665. * @returns Highest frame rate of the animation
  36666. */
  36667. getHighestFrame(): number;
  36668. /**
  36669. * Gets the easing function of the animation
  36670. * @returns Easing function of the animation
  36671. */
  36672. getEasingFunction(): IEasingFunction;
  36673. /**
  36674. * Sets the easing function of the animation
  36675. * @param easingFunction A custom mathematical formula for animation
  36676. */
  36677. setEasingFunction(easingFunction: EasingFunction): void;
  36678. /**
  36679. * Interpolates a scalar linearly
  36680. * @param startValue Start value of the animation curve
  36681. * @param endValue End value of the animation curve
  36682. * @param gradient Scalar amount to interpolate
  36683. * @returns Interpolated scalar value
  36684. */
  36685. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  36686. /**
  36687. * Interpolates a scalar cubically
  36688. * @param startValue Start value of the animation curve
  36689. * @param outTangent End tangent of the animation
  36690. * @param endValue End value of the animation curve
  36691. * @param inTangent Start tangent of the animation curve
  36692. * @param gradient Scalar amount to interpolate
  36693. * @returns Interpolated scalar value
  36694. */
  36695. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  36696. /**
  36697. * Interpolates a quaternion using a spherical linear interpolation
  36698. * @param startValue Start value of the animation curve
  36699. * @param endValue End value of the animation curve
  36700. * @param gradient Scalar amount to interpolate
  36701. * @returns Interpolated quaternion value
  36702. */
  36703. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  36704. /**
  36705. * Interpolates a quaternion cubically
  36706. * @param startValue Start value of the animation curve
  36707. * @param outTangent End tangent of the animation curve
  36708. * @param endValue End value of the animation curve
  36709. * @param inTangent Start tangent of the animation curve
  36710. * @param gradient Scalar amount to interpolate
  36711. * @returns Interpolated quaternion value
  36712. */
  36713. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  36714. /**
  36715. * Interpolates a Vector3 linearl
  36716. * @param startValue Start value of the animation curve
  36717. * @param endValue End value of the animation curve
  36718. * @param gradient Scalar amount to interpolate
  36719. * @returns Interpolated scalar value
  36720. */
  36721. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  36722. /**
  36723. * Interpolates a Vector3 cubically
  36724. * @param startValue Start value of the animation curve
  36725. * @param outTangent End tangent of the animation
  36726. * @param endValue End value of the animation curve
  36727. * @param inTangent Start tangent of the animation curve
  36728. * @param gradient Scalar amount to interpolate
  36729. * @returns InterpolatedVector3 value
  36730. */
  36731. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  36732. /**
  36733. * Interpolates a Vector2 linearly
  36734. * @param startValue Start value of the animation curve
  36735. * @param endValue End value of the animation curve
  36736. * @param gradient Scalar amount to interpolate
  36737. * @returns Interpolated Vector2 value
  36738. */
  36739. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  36740. /**
  36741. * Interpolates a Vector2 cubically
  36742. * @param startValue Start value of the animation curve
  36743. * @param outTangent End tangent of the animation
  36744. * @param endValue End value of the animation curve
  36745. * @param inTangent Start tangent of the animation curve
  36746. * @param gradient Scalar amount to interpolate
  36747. * @returns Interpolated Vector2 value
  36748. */
  36749. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  36750. /**
  36751. * Interpolates a size linearly
  36752. * @param startValue Start value of the animation curve
  36753. * @param endValue End value of the animation curve
  36754. * @param gradient Scalar amount to interpolate
  36755. * @returns Interpolated Size value
  36756. */
  36757. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  36758. /**
  36759. * Interpolates a Color3 linearly
  36760. * @param startValue Start value of the animation curve
  36761. * @param endValue End value of the animation curve
  36762. * @param gradient Scalar amount to interpolate
  36763. * @returns Interpolated Color3 value
  36764. */
  36765. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  36766. /**
  36767. * Interpolates a Color4 linearly
  36768. * @param startValue Start value of the animation curve
  36769. * @param endValue End value of the animation curve
  36770. * @param gradient Scalar amount to interpolate
  36771. * @returns Interpolated Color3 value
  36772. */
  36773. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  36774. /**
  36775. * @hidden Internal use only
  36776. */
  36777. _getKeyValue(value: any): any;
  36778. /**
  36779. * @hidden Internal use only
  36780. */
  36781. _interpolate(currentFrame: number, state: _IAnimationState): any;
  36782. /**
  36783. * Defines the function to use to interpolate matrices
  36784. * @param startValue defines the start matrix
  36785. * @param endValue defines the end matrix
  36786. * @param gradient defines the gradient between both matrices
  36787. * @param result defines an optional target matrix where to store the interpolation
  36788. * @returns the interpolated matrix
  36789. */
  36790. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  36791. /**
  36792. * Makes a copy of the animation
  36793. * @returns Cloned animation
  36794. */
  36795. clone(): Animation;
  36796. /**
  36797. * Sets the key frames of the animation
  36798. * @param values The animation key frames to set
  36799. */
  36800. setKeys(values: Array<IAnimationKey>): void;
  36801. /**
  36802. * Serializes the animation to an object
  36803. * @returns Serialized object
  36804. */
  36805. serialize(): any;
  36806. /**
  36807. * Float animation type
  36808. */
  36809. static readonly ANIMATIONTYPE_FLOAT: number;
  36810. /**
  36811. * Vector3 animation type
  36812. */
  36813. static readonly ANIMATIONTYPE_VECTOR3: number;
  36814. /**
  36815. * Quaternion animation type
  36816. */
  36817. static readonly ANIMATIONTYPE_QUATERNION: number;
  36818. /**
  36819. * Matrix animation type
  36820. */
  36821. static readonly ANIMATIONTYPE_MATRIX: number;
  36822. /**
  36823. * Color3 animation type
  36824. */
  36825. static readonly ANIMATIONTYPE_COLOR3: number;
  36826. /**
  36827. * Color3 animation type
  36828. */
  36829. static readonly ANIMATIONTYPE_COLOR4: number;
  36830. /**
  36831. * Vector2 animation type
  36832. */
  36833. static readonly ANIMATIONTYPE_VECTOR2: number;
  36834. /**
  36835. * Size animation type
  36836. */
  36837. static readonly ANIMATIONTYPE_SIZE: number;
  36838. /**
  36839. * Relative Loop Mode
  36840. */
  36841. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  36842. /**
  36843. * Cycle Loop Mode
  36844. */
  36845. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  36846. /**
  36847. * Constant Loop Mode
  36848. */
  36849. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  36850. /** @hidden */
  36851. static _UniversalLerp(left: any, right: any, amount: number): any;
  36852. /**
  36853. * Parses an animation object and creates an animation
  36854. * @param parsedAnimation Parsed animation object
  36855. * @returns Animation object
  36856. */
  36857. static Parse(parsedAnimation: any): Animation;
  36858. /**
  36859. * Appends the serialized animations from the source animations
  36860. * @param source Source containing the animations
  36861. * @param destination Target to store the animations
  36862. */
  36863. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  36864. /**
  36865. * Creates a new animation or an array of animations from a snippet saved in a remote file
  36866. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  36867. * @param url defines the url to load from
  36868. * @returns a promise that will resolve to the new animation or an array of animations
  36869. */
  36870. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  36871. /**
  36872. * Creates an animation or an array of animations from a snippet saved by the Inspector
  36873. * @param snippetId defines the snippet to load
  36874. * @returns a promise that will resolve to the new animation or a new array of animations
  36875. */
  36876. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  36877. }
  36878. }
  36879. declare module BABYLON {
  36880. /**
  36881. * Interface containing an array of animations
  36882. */
  36883. export interface IAnimatable {
  36884. /**
  36885. * Array of animations
  36886. */
  36887. animations: Nullable<Array<Animation>>;
  36888. }
  36889. }
  36890. declare module BABYLON {
  36891. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  36892. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  36893. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  36894. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  36895. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  36896. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  36897. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  36898. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  36899. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  36900. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  36901. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  36902. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  36903. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  36904. /**
  36905. * Decorator used to define property that can be serialized as reference to a camera
  36906. * @param sourceName defines the name of the property to decorate
  36907. */
  36908. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  36909. /**
  36910. * Class used to help serialization objects
  36911. */
  36912. export class SerializationHelper {
  36913. /** @hidden */
  36914. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  36915. /** @hidden */
  36916. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  36917. /** @hidden */
  36918. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  36919. /** @hidden */
  36920. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  36921. /**
  36922. * Appends the serialized animations from the source animations
  36923. * @param source Source containing the animations
  36924. * @param destination Target to store the animations
  36925. */
  36926. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  36927. /**
  36928. * Static function used to serialized a specific entity
  36929. * @param entity defines the entity to serialize
  36930. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  36931. * @returns a JSON compatible object representing the serialization of the entity
  36932. */
  36933. static Serialize<T>(entity: T, serializationObject?: any): any;
  36934. /**
  36935. * Creates a new entity from a serialization data object
  36936. * @param creationFunction defines a function used to instanciated the new entity
  36937. * @param source defines the source serialization data
  36938. * @param scene defines the hosting scene
  36939. * @param rootUrl defines the root url for resources
  36940. * @returns a new entity
  36941. */
  36942. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  36943. /**
  36944. * Clones an object
  36945. * @param creationFunction defines the function used to instanciate the new object
  36946. * @param source defines the source object
  36947. * @returns the cloned object
  36948. */
  36949. static Clone<T>(creationFunction: () => T, source: T): T;
  36950. /**
  36951. * Instanciates a new object based on a source one (some data will be shared between both object)
  36952. * @param creationFunction defines the function used to instanciate the new object
  36953. * @param source defines the source object
  36954. * @returns the new object
  36955. */
  36956. static Instanciate<T>(creationFunction: () => T, source: T): T;
  36957. }
  36958. }
  36959. declare module BABYLON {
  36960. /**
  36961. * This is the base class of all the camera used in the application.
  36962. * @see https://doc.babylonjs.com/features/cameras
  36963. */
  36964. export class Camera extends Node {
  36965. /** @hidden */
  36966. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  36967. /**
  36968. * This is the default projection mode used by the cameras.
  36969. * It helps recreating a feeling of perspective and better appreciate depth.
  36970. * This is the best way to simulate real life cameras.
  36971. */
  36972. static readonly PERSPECTIVE_CAMERA: number;
  36973. /**
  36974. * This helps creating camera with an orthographic mode.
  36975. * 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.
  36976. */
  36977. static readonly ORTHOGRAPHIC_CAMERA: number;
  36978. /**
  36979. * This is the default FOV mode for perspective cameras.
  36980. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  36981. */
  36982. static readonly FOVMODE_VERTICAL_FIXED: number;
  36983. /**
  36984. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  36985. */
  36986. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  36987. /**
  36988. * This specifies ther is no need for a camera rig.
  36989. * Basically only one eye is rendered corresponding to the camera.
  36990. */
  36991. static readonly RIG_MODE_NONE: number;
  36992. /**
  36993. * Simulates a camera Rig with one blue eye and one red eye.
  36994. * This can be use with 3d blue and red glasses.
  36995. */
  36996. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  36997. /**
  36998. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  36999. */
  37000. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  37001. /**
  37002. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  37003. */
  37004. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  37005. /**
  37006. * Defines that both eyes of the camera will be rendered over under each other.
  37007. */
  37008. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  37009. /**
  37010. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  37011. */
  37012. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  37013. /**
  37014. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  37015. */
  37016. static readonly RIG_MODE_VR: number;
  37017. /**
  37018. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  37019. */
  37020. static readonly RIG_MODE_WEBVR: number;
  37021. /**
  37022. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  37023. */
  37024. static readonly RIG_MODE_CUSTOM: number;
  37025. /**
  37026. * Defines if by default attaching controls should prevent the default javascript event to continue.
  37027. */
  37028. static ForceAttachControlToAlwaysPreventDefault: boolean;
  37029. /**
  37030. * Define the input manager associated with the camera.
  37031. */
  37032. inputs: CameraInputsManager<Camera>;
  37033. /** @hidden */
  37034. _position: Vector3;
  37035. /**
  37036. * Define the current local position of the camera in the scene
  37037. */
  37038. get position(): Vector3;
  37039. set position(newPosition: Vector3);
  37040. protected _upVector: Vector3;
  37041. /**
  37042. * The vector the camera should consider as up.
  37043. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  37044. */
  37045. set upVector(vec: Vector3);
  37046. get upVector(): Vector3;
  37047. /**
  37048. * Define the current limit on the left side for an orthographic camera
  37049. * In scene unit
  37050. */
  37051. orthoLeft: Nullable<number>;
  37052. /**
  37053. * Define the current limit on the right side for an orthographic camera
  37054. * In scene unit
  37055. */
  37056. orthoRight: Nullable<number>;
  37057. /**
  37058. * Define the current limit on the bottom side for an orthographic camera
  37059. * In scene unit
  37060. */
  37061. orthoBottom: Nullable<number>;
  37062. /**
  37063. * Define the current limit on the top side for an orthographic camera
  37064. * In scene unit
  37065. */
  37066. orthoTop: Nullable<number>;
  37067. /**
  37068. * Field Of View is set in Radians. (default is 0.8)
  37069. */
  37070. fov: number;
  37071. /**
  37072. * Define the minimum distance the camera can see from.
  37073. * This is important to note that the depth buffer are not infinite and the closer it starts
  37074. * the more your scene might encounter depth fighting issue.
  37075. */
  37076. minZ: number;
  37077. /**
  37078. * Define the maximum distance the camera can see to.
  37079. * This is important to note that the depth buffer are not infinite and the further it end
  37080. * the more your scene might encounter depth fighting issue.
  37081. */
  37082. maxZ: number;
  37083. /**
  37084. * Define the default inertia of the camera.
  37085. * This helps giving a smooth feeling to the camera movement.
  37086. */
  37087. inertia: number;
  37088. /**
  37089. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  37090. */
  37091. mode: number;
  37092. /**
  37093. * Define whether the camera is intermediate.
  37094. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  37095. */
  37096. isIntermediate: boolean;
  37097. /**
  37098. * Define the viewport of the camera.
  37099. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  37100. */
  37101. viewport: Viewport;
  37102. /**
  37103. * Restricts the camera to viewing objects with the same layerMask.
  37104. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  37105. */
  37106. layerMask: number;
  37107. /**
  37108. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  37109. */
  37110. fovMode: number;
  37111. /**
  37112. * Rig mode of the camera.
  37113. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  37114. * This is normally controlled byt the camera themselves as internal use.
  37115. */
  37116. cameraRigMode: number;
  37117. /**
  37118. * Defines the distance between both "eyes" in case of a RIG
  37119. */
  37120. interaxialDistance: number;
  37121. /**
  37122. * Defines if stereoscopic rendering is done side by side or over under.
  37123. */
  37124. isStereoscopicSideBySide: boolean;
  37125. /**
  37126. * 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
  37127. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  37128. * else in the scene. (Eg. security camera)
  37129. *
  37130. * 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)
  37131. */
  37132. customRenderTargets: RenderTargetTexture[];
  37133. /**
  37134. * When set, the camera will render to this render target instead of the default canvas
  37135. *
  37136. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  37137. */
  37138. outputRenderTarget: Nullable<RenderTargetTexture>;
  37139. /**
  37140. * Observable triggered when the camera view matrix has changed.
  37141. */
  37142. onViewMatrixChangedObservable: Observable<Camera>;
  37143. /**
  37144. * Observable triggered when the camera Projection matrix has changed.
  37145. */
  37146. onProjectionMatrixChangedObservable: Observable<Camera>;
  37147. /**
  37148. * Observable triggered when the inputs have been processed.
  37149. */
  37150. onAfterCheckInputsObservable: Observable<Camera>;
  37151. /**
  37152. * Observable triggered when reset has been called and applied to the camera.
  37153. */
  37154. onRestoreStateObservable: Observable<Camera>;
  37155. /**
  37156. * Is this camera a part of a rig system?
  37157. */
  37158. isRigCamera: boolean;
  37159. /**
  37160. * If isRigCamera set to true this will be set with the parent camera.
  37161. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  37162. */
  37163. rigParent?: Camera;
  37164. /** @hidden */
  37165. _cameraRigParams: any;
  37166. /** @hidden */
  37167. _rigCameras: Camera[];
  37168. /** @hidden */
  37169. _rigPostProcess: Nullable<PostProcess>;
  37170. protected _webvrViewMatrix: Matrix;
  37171. /** @hidden */
  37172. _skipRendering: boolean;
  37173. /** @hidden */
  37174. _projectionMatrix: Matrix;
  37175. /** @hidden */
  37176. _postProcesses: Nullable<PostProcess>[];
  37177. /** @hidden */
  37178. _activeMeshes: SmartArray<AbstractMesh>;
  37179. protected _globalPosition: Vector3;
  37180. /** @hidden */
  37181. _computedViewMatrix: Matrix;
  37182. private _doNotComputeProjectionMatrix;
  37183. private _transformMatrix;
  37184. private _frustumPlanes;
  37185. private _refreshFrustumPlanes;
  37186. private _storedFov;
  37187. private _stateStored;
  37188. /**
  37189. * Instantiates a new camera object.
  37190. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  37191. * @see https://doc.babylonjs.com/features/cameras
  37192. * @param name Defines the name of the camera in the scene
  37193. * @param position Defines the position of the camera
  37194. * @param scene Defines the scene the camera belongs too
  37195. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  37196. */
  37197. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  37198. /**
  37199. * Store current camera state (fov, position, etc..)
  37200. * @returns the camera
  37201. */
  37202. storeState(): Camera;
  37203. /**
  37204. * Restores the camera state values if it has been stored. You must call storeState() first
  37205. */
  37206. protected _restoreStateValues(): boolean;
  37207. /**
  37208. * Restored camera state. You must call storeState() first.
  37209. * @returns true if restored and false otherwise
  37210. */
  37211. restoreState(): boolean;
  37212. /**
  37213. * Gets the class name of the camera.
  37214. * @returns the class name
  37215. */
  37216. getClassName(): string;
  37217. /** @hidden */
  37218. readonly _isCamera: boolean;
  37219. /**
  37220. * Gets a string representation of the camera useful for debug purpose.
  37221. * @param fullDetails Defines that a more verboe level of logging is required
  37222. * @returns the string representation
  37223. */
  37224. toString(fullDetails?: boolean): string;
  37225. /**
  37226. * Gets the current world space position of the camera.
  37227. */
  37228. get globalPosition(): Vector3;
  37229. /**
  37230. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  37231. * @returns the active meshe list
  37232. */
  37233. getActiveMeshes(): SmartArray<AbstractMesh>;
  37234. /**
  37235. * Check whether a mesh is part of the current active mesh list of the camera
  37236. * @param mesh Defines the mesh to check
  37237. * @returns true if active, false otherwise
  37238. */
  37239. isActiveMesh(mesh: Mesh): boolean;
  37240. /**
  37241. * Is this camera ready to be used/rendered
  37242. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  37243. * @return true if the camera is ready
  37244. */
  37245. isReady(completeCheck?: boolean): boolean;
  37246. /** @hidden */
  37247. _initCache(): void;
  37248. /** @hidden */
  37249. _updateCache(ignoreParentClass?: boolean): void;
  37250. /** @hidden */
  37251. _isSynchronized(): boolean;
  37252. /** @hidden */
  37253. _isSynchronizedViewMatrix(): boolean;
  37254. /** @hidden */
  37255. _isSynchronizedProjectionMatrix(): boolean;
  37256. /**
  37257. * Attach the input controls to a specific dom element to get the input from.
  37258. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37259. */
  37260. attachControl(noPreventDefault?: boolean): void;
  37261. /**
  37262. * Attach the input controls to a specific dom element to get the input from.
  37263. * @param ignored defines an ignored parameter kept for backward compatibility. If you want to define the source input element, you can set engine.inputElement before calling camera.attachControl
  37264. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37265. * BACK COMPAT SIGNATURE ONLY.
  37266. */
  37267. attachControl(ignored: any, noPreventDefault?: boolean): void;
  37268. /**
  37269. * Detach the current controls from the specified dom element.
  37270. */
  37271. detachControl(): void;
  37272. /**
  37273. * Detach the current controls from the specified dom element.
  37274. * @param ignored defines an ignored parameter kept for backward compatibility. If you want to define the source input element, you can set engine.inputElement before calling camera.attachControl
  37275. */
  37276. detachControl(ignored: any): void;
  37277. /**
  37278. * Update the camera state according to the different inputs gathered during the frame.
  37279. */
  37280. update(): void;
  37281. /** @hidden */
  37282. _checkInputs(): void;
  37283. /** @hidden */
  37284. get rigCameras(): Camera[];
  37285. /**
  37286. * Gets the post process used by the rig cameras
  37287. */
  37288. get rigPostProcess(): Nullable<PostProcess>;
  37289. /**
  37290. * Internal, gets the first post proces.
  37291. * @returns the first post process to be run on this camera.
  37292. */
  37293. _getFirstPostProcess(): Nullable<PostProcess>;
  37294. private _cascadePostProcessesToRigCams;
  37295. /**
  37296. * Attach a post process to the camera.
  37297. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  37298. * @param postProcess The post process to attach to the camera
  37299. * @param insertAt The position of the post process in case several of them are in use in the scene
  37300. * @returns the position the post process has been inserted at
  37301. */
  37302. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  37303. /**
  37304. * Detach a post process to the camera.
  37305. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  37306. * @param postProcess The post process to detach from the camera
  37307. */
  37308. detachPostProcess(postProcess: PostProcess): void;
  37309. /**
  37310. * Gets the current world matrix of the camera
  37311. */
  37312. getWorldMatrix(): Matrix;
  37313. /** @hidden */
  37314. _getViewMatrix(): Matrix;
  37315. /**
  37316. * Gets the current view matrix of the camera.
  37317. * @param force forces the camera to recompute the matrix without looking at the cached state
  37318. * @returns the view matrix
  37319. */
  37320. getViewMatrix(force?: boolean): Matrix;
  37321. /**
  37322. * Freeze the projection matrix.
  37323. * It will prevent the cache check of the camera projection compute and can speed up perf
  37324. * if no parameter of the camera are meant to change
  37325. * @param projection Defines manually a projection if necessary
  37326. */
  37327. freezeProjectionMatrix(projection?: Matrix): void;
  37328. /**
  37329. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  37330. */
  37331. unfreezeProjectionMatrix(): void;
  37332. /**
  37333. * Gets the current projection matrix of the camera.
  37334. * @param force forces the camera to recompute the matrix without looking at the cached state
  37335. * @returns the projection matrix
  37336. */
  37337. getProjectionMatrix(force?: boolean): Matrix;
  37338. /**
  37339. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  37340. * @returns a Matrix
  37341. */
  37342. getTransformationMatrix(): Matrix;
  37343. private _updateFrustumPlanes;
  37344. /**
  37345. * Checks if a cullable object (mesh...) is in the camera frustum
  37346. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  37347. * @param target The object to check
  37348. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  37349. * @returns true if the object is in frustum otherwise false
  37350. */
  37351. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  37352. /**
  37353. * Checks if a cullable object (mesh...) is in the camera frustum
  37354. * Unlike isInFrustum this cheks the full bounding box
  37355. * @param target The object to check
  37356. * @returns true if the object is in frustum otherwise false
  37357. */
  37358. isCompletelyInFrustum(target: ICullable): boolean;
  37359. /**
  37360. * Gets a ray in the forward direction from the camera.
  37361. * @param length Defines the length of the ray to create
  37362. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  37363. * @param origin Defines the start point of the ray which defaults to the camera position
  37364. * @returns the forward ray
  37365. */
  37366. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  37367. /**
  37368. * Gets a ray in the forward direction from the camera.
  37369. * @param refRay the ray to (re)use when setting the values
  37370. * @param length Defines the length of the ray to create
  37371. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  37372. * @param origin Defines the start point of the ray which defaults to the camera position
  37373. * @returns the forward ray
  37374. */
  37375. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  37376. /**
  37377. * Releases resources associated with this node.
  37378. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  37379. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  37380. */
  37381. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  37382. /** @hidden */
  37383. _isLeftCamera: boolean;
  37384. /**
  37385. * Gets the left camera of a rig setup in case of Rigged Camera
  37386. */
  37387. get isLeftCamera(): boolean;
  37388. /** @hidden */
  37389. _isRightCamera: boolean;
  37390. /**
  37391. * Gets the right camera of a rig setup in case of Rigged Camera
  37392. */
  37393. get isRightCamera(): boolean;
  37394. /**
  37395. * Gets the left camera of a rig setup in case of Rigged Camera
  37396. */
  37397. get leftCamera(): Nullable<FreeCamera>;
  37398. /**
  37399. * Gets the right camera of a rig setup in case of Rigged Camera
  37400. */
  37401. get rightCamera(): Nullable<FreeCamera>;
  37402. /**
  37403. * Gets the left camera target of a rig setup in case of Rigged Camera
  37404. * @returns the target position
  37405. */
  37406. getLeftTarget(): Nullable<Vector3>;
  37407. /**
  37408. * Gets the right camera target of a rig setup in case of Rigged Camera
  37409. * @returns the target position
  37410. */
  37411. getRightTarget(): Nullable<Vector3>;
  37412. /**
  37413. * @hidden
  37414. */
  37415. setCameraRigMode(mode: number, rigParams: any): void;
  37416. /** @hidden */
  37417. static _setStereoscopicRigMode(camera: Camera): void;
  37418. /** @hidden */
  37419. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  37420. /** @hidden */
  37421. static _setVRRigMode(camera: Camera, rigParams: any): void;
  37422. /** @hidden */
  37423. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  37424. /** @hidden */
  37425. _getVRProjectionMatrix(): Matrix;
  37426. protected _updateCameraRotationMatrix(): void;
  37427. protected _updateWebVRCameraRotationMatrix(): void;
  37428. /**
  37429. * This function MUST be overwritten by the different WebVR cameras available.
  37430. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  37431. * @hidden
  37432. */
  37433. _getWebVRProjectionMatrix(): Matrix;
  37434. /**
  37435. * This function MUST be overwritten by the different WebVR cameras available.
  37436. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  37437. * @hidden
  37438. */
  37439. _getWebVRViewMatrix(): Matrix;
  37440. /** @hidden */
  37441. setCameraRigParameter(name: string, value: any): void;
  37442. /**
  37443. * needs to be overridden by children so sub has required properties to be copied
  37444. * @hidden
  37445. */
  37446. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  37447. /**
  37448. * May need to be overridden by children
  37449. * @hidden
  37450. */
  37451. _updateRigCameras(): void;
  37452. /** @hidden */
  37453. _setupInputs(): void;
  37454. /**
  37455. * Serialiaze the camera setup to a json represention
  37456. * @returns the JSON representation
  37457. */
  37458. serialize(): any;
  37459. /**
  37460. * Clones the current camera.
  37461. * @param name The cloned camera name
  37462. * @returns the cloned camera
  37463. */
  37464. clone(name: string): Camera;
  37465. /**
  37466. * Gets the direction of the camera relative to a given local axis.
  37467. * @param localAxis Defines the reference axis to provide a relative direction.
  37468. * @return the direction
  37469. */
  37470. getDirection(localAxis: Vector3): Vector3;
  37471. /**
  37472. * Returns the current camera absolute rotation
  37473. */
  37474. get absoluteRotation(): Quaternion;
  37475. /**
  37476. * Gets the direction of the camera relative to a given local axis into a passed vector.
  37477. * @param localAxis Defines the reference axis to provide a relative direction.
  37478. * @param result Defines the vector to store the result in
  37479. */
  37480. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  37481. /**
  37482. * Gets a camera constructor for a given camera type
  37483. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  37484. * @param name The name of the camera the result will be able to instantiate
  37485. * @param scene The scene the result will construct the camera in
  37486. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  37487. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  37488. * @returns a factory method to construc the camera
  37489. */
  37490. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  37491. /**
  37492. * Compute the world matrix of the camera.
  37493. * @returns the camera world matrix
  37494. */
  37495. computeWorldMatrix(): Matrix;
  37496. /**
  37497. * Parse a JSON and creates the camera from the parsed information
  37498. * @param parsedCamera The JSON to parse
  37499. * @param scene The scene to instantiate the camera in
  37500. * @returns the newly constructed camera
  37501. */
  37502. static Parse(parsedCamera: any, scene: Scene): Camera;
  37503. }
  37504. }
  37505. declare module BABYLON {
  37506. /**
  37507. * PostProcessManager is used to manage one or more post processes or post process pipelines
  37508. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  37509. */
  37510. export class PostProcessManager {
  37511. private _scene;
  37512. private _indexBuffer;
  37513. private _vertexBuffers;
  37514. /**
  37515. * Creates a new instance PostProcess
  37516. * @param scene The scene that the post process is associated with.
  37517. */
  37518. constructor(scene: Scene);
  37519. private _prepareBuffers;
  37520. private _buildIndexBuffer;
  37521. /**
  37522. * Rebuilds the vertex buffers of the manager.
  37523. * @hidden
  37524. */
  37525. _rebuild(): void;
  37526. /**
  37527. * Prepares a frame to be run through a post process.
  37528. * @param sourceTexture The input texture to the post procesess. (default: null)
  37529. * @param postProcesses An array of post processes to be run. (default: null)
  37530. * @returns True if the post processes were able to be run.
  37531. * @hidden
  37532. */
  37533. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  37534. /**
  37535. * Manually render a set of post processes to a texture.
  37536. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  37537. * @param postProcesses An array of post processes to be run.
  37538. * @param targetTexture The target texture to render to.
  37539. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  37540. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  37541. * @param lodLevel defines which lod of the texture to render to
  37542. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  37543. */
  37544. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  37545. /**
  37546. * Finalize the result of the output of the postprocesses.
  37547. * @param doNotPresent If true the result will not be displayed to the screen.
  37548. * @param targetTexture The target texture to render to.
  37549. * @param faceIndex The index of the face to bind the target texture to.
  37550. * @param postProcesses The array of post processes to render.
  37551. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  37552. * @hidden
  37553. */
  37554. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  37555. /**
  37556. * Disposes of the post process manager.
  37557. */
  37558. dispose(): void;
  37559. }
  37560. }
  37561. declare module BABYLON {
  37562. /**
  37563. * This Helps creating a texture that will be created from a camera in your scene.
  37564. * It is basically a dynamic texture that could be used to create special effects for instance.
  37565. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  37566. */
  37567. export class RenderTargetTexture extends Texture {
  37568. /**
  37569. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  37570. */
  37571. static readonly REFRESHRATE_RENDER_ONCE: number;
  37572. /**
  37573. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  37574. */
  37575. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  37576. /**
  37577. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  37578. * the central point of your effect and can save a lot of performances.
  37579. */
  37580. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  37581. /**
  37582. * Use this predicate to dynamically define the list of mesh you want to render.
  37583. * If set, the renderList property will be overwritten.
  37584. */
  37585. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  37586. private _renderList;
  37587. /**
  37588. * Use this list to define the list of mesh you want to render.
  37589. */
  37590. get renderList(): Nullable<Array<AbstractMesh>>;
  37591. set renderList(value: Nullable<Array<AbstractMesh>>);
  37592. /**
  37593. * Use this function to overload the renderList array at rendering time.
  37594. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  37595. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  37596. * the cube (if the RTT is a cube, else layerOrFace=0).
  37597. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  37598. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  37599. * hold dummy elements!
  37600. */
  37601. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  37602. private _hookArray;
  37603. /**
  37604. * Define if particles should be rendered in your texture.
  37605. */
  37606. renderParticles: boolean;
  37607. /**
  37608. * Define if sprites should be rendered in your texture.
  37609. */
  37610. renderSprites: boolean;
  37611. /**
  37612. * Define the camera used to render the texture.
  37613. */
  37614. activeCamera: Nullable<Camera>;
  37615. /**
  37616. * Override the mesh isReady function with your own one.
  37617. */
  37618. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  37619. /**
  37620. * Override the render function of the texture with your own one.
  37621. */
  37622. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  37623. /**
  37624. * Define if camera post processes should be use while rendering the texture.
  37625. */
  37626. useCameraPostProcesses: boolean;
  37627. /**
  37628. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  37629. */
  37630. ignoreCameraViewport: boolean;
  37631. private _postProcessManager;
  37632. private _postProcesses;
  37633. private _resizeObserver;
  37634. /**
  37635. * An event triggered when the texture is unbind.
  37636. */
  37637. onBeforeBindObservable: Observable<RenderTargetTexture>;
  37638. /**
  37639. * An event triggered when the texture is unbind.
  37640. */
  37641. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  37642. private _onAfterUnbindObserver;
  37643. /**
  37644. * Set a after unbind callback in the texture.
  37645. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  37646. */
  37647. set onAfterUnbind(callback: () => void);
  37648. /**
  37649. * An event triggered before rendering the texture
  37650. */
  37651. onBeforeRenderObservable: Observable<number>;
  37652. private _onBeforeRenderObserver;
  37653. /**
  37654. * Set a before render callback in the texture.
  37655. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  37656. */
  37657. set onBeforeRender(callback: (faceIndex: number) => void);
  37658. /**
  37659. * An event triggered after rendering the texture
  37660. */
  37661. onAfterRenderObservable: Observable<number>;
  37662. private _onAfterRenderObserver;
  37663. /**
  37664. * Set a after render callback in the texture.
  37665. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  37666. */
  37667. set onAfterRender(callback: (faceIndex: number) => void);
  37668. /**
  37669. * An event triggered after the texture clear
  37670. */
  37671. onClearObservable: Observable<Engine>;
  37672. private _onClearObserver;
  37673. /**
  37674. * Set a clear callback in the texture.
  37675. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  37676. */
  37677. set onClear(callback: (Engine: Engine) => void);
  37678. /**
  37679. * An event triggered when the texture is resized.
  37680. */
  37681. onResizeObservable: Observable<RenderTargetTexture>;
  37682. /**
  37683. * Define the clear color of the Render Target if it should be different from the scene.
  37684. */
  37685. clearColor: Color4;
  37686. protected _size: number | {
  37687. width: number;
  37688. height: number;
  37689. layers?: number;
  37690. };
  37691. protected _initialSizeParameter: number | {
  37692. width: number;
  37693. height: number;
  37694. } | {
  37695. ratio: number;
  37696. };
  37697. protected _sizeRatio: Nullable<number>;
  37698. /** @hidden */
  37699. _generateMipMaps: boolean;
  37700. protected _renderingManager: RenderingManager;
  37701. /** @hidden */
  37702. _waitingRenderList?: string[];
  37703. protected _doNotChangeAspectRatio: boolean;
  37704. protected _currentRefreshId: number;
  37705. protected _refreshRate: number;
  37706. protected _textureMatrix: Matrix;
  37707. protected _samples: number;
  37708. protected _renderTargetOptions: RenderTargetCreationOptions;
  37709. /**
  37710. * Gets render target creation options that were used.
  37711. */
  37712. get renderTargetOptions(): RenderTargetCreationOptions;
  37713. protected _onRatioRescale(): void;
  37714. /**
  37715. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  37716. * It must define where the camera used to render the texture is set
  37717. */
  37718. boundingBoxPosition: Vector3;
  37719. private _boundingBoxSize;
  37720. /**
  37721. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  37722. * When defined, the cubemap will switch to local mode
  37723. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  37724. * @example https://www.babylonjs-playground.com/#RNASML
  37725. */
  37726. set boundingBoxSize(value: Vector3);
  37727. get boundingBoxSize(): Vector3;
  37728. /**
  37729. * In case the RTT has been created with a depth texture, get the associated
  37730. * depth texture.
  37731. * Otherwise, return null.
  37732. */
  37733. get depthStencilTexture(): Nullable<InternalTexture>;
  37734. /**
  37735. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  37736. * or used a shadow, depth texture...
  37737. * @param name The friendly name of the texture
  37738. * @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)
  37739. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  37740. * @param generateMipMaps True if mip maps need to be generated after render.
  37741. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  37742. * @param type The type of the buffer in the RTT (int, half float, float...)
  37743. * @param isCube True if a cube texture needs to be created
  37744. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  37745. * @param generateDepthBuffer True to generate a depth buffer
  37746. * @param generateStencilBuffer True to generate a stencil buffer
  37747. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  37748. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  37749. * @param delayAllocation if the texture allocation should be delayed (default: false)
  37750. */
  37751. constructor(name: string, size: number | {
  37752. width: number;
  37753. height: number;
  37754. layers?: number;
  37755. } | {
  37756. ratio: number;
  37757. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  37758. /**
  37759. * Creates a depth stencil texture.
  37760. * This is only available in WebGL 2 or with the depth texture extension available.
  37761. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  37762. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  37763. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  37764. */
  37765. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  37766. private _processSizeParameter;
  37767. /**
  37768. * Define the number of samples to use in case of MSAA.
  37769. * It defaults to one meaning no MSAA has been enabled.
  37770. */
  37771. get samples(): number;
  37772. set samples(value: number);
  37773. /**
  37774. * Resets the refresh counter of the texture and start bak from scratch.
  37775. * Could be useful to regenerate the texture if it is setup to render only once.
  37776. */
  37777. resetRefreshCounter(): void;
  37778. /**
  37779. * Define the refresh rate of the texture or the rendering frequency.
  37780. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  37781. */
  37782. get refreshRate(): number;
  37783. set refreshRate(value: number);
  37784. /**
  37785. * Adds a post process to the render target rendering passes.
  37786. * @param postProcess define the post process to add
  37787. */
  37788. addPostProcess(postProcess: PostProcess): void;
  37789. /**
  37790. * Clear all the post processes attached to the render target
  37791. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  37792. */
  37793. clearPostProcesses(dispose?: boolean): void;
  37794. /**
  37795. * Remove one of the post process from the list of attached post processes to the texture
  37796. * @param postProcess define the post process to remove from the list
  37797. */
  37798. removePostProcess(postProcess: PostProcess): void;
  37799. /** @hidden */
  37800. _shouldRender(): boolean;
  37801. /**
  37802. * Gets the actual render size of the texture.
  37803. * @returns the width of the render size
  37804. */
  37805. getRenderSize(): number;
  37806. /**
  37807. * Gets the actual render width of the texture.
  37808. * @returns the width of the render size
  37809. */
  37810. getRenderWidth(): number;
  37811. /**
  37812. * Gets the actual render height of the texture.
  37813. * @returns the height of the render size
  37814. */
  37815. getRenderHeight(): number;
  37816. /**
  37817. * Gets the actual number of layers of the texture.
  37818. * @returns the number of layers
  37819. */
  37820. getRenderLayers(): number;
  37821. /**
  37822. * Get if the texture can be rescaled or not.
  37823. */
  37824. get canRescale(): boolean;
  37825. /**
  37826. * Resize the texture using a ratio.
  37827. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  37828. */
  37829. scale(ratio: number): void;
  37830. /**
  37831. * Get the texture reflection matrix used to rotate/transform the reflection.
  37832. * @returns the reflection matrix
  37833. */
  37834. getReflectionTextureMatrix(): Matrix;
  37835. /**
  37836. * Resize the texture to a new desired size.
  37837. * Be carrefull as it will recreate all the data in the new texture.
  37838. * @param size Define the new size. It can be:
  37839. * - a number for squared texture,
  37840. * - an object containing { width: number, height: number }
  37841. * - or an object containing a ratio { ratio: number }
  37842. */
  37843. resize(size: number | {
  37844. width: number;
  37845. height: number;
  37846. } | {
  37847. ratio: number;
  37848. }): void;
  37849. private _defaultRenderListPrepared;
  37850. /**
  37851. * Renders all the objects from the render list into the texture.
  37852. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  37853. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  37854. */
  37855. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  37856. private _bestReflectionRenderTargetDimension;
  37857. private _prepareRenderingManager;
  37858. /**
  37859. * @hidden
  37860. * @param faceIndex face index to bind to if this is a cubetexture
  37861. * @param layer defines the index of the texture to bind in the array
  37862. */
  37863. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  37864. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  37865. private renderToTarget;
  37866. /**
  37867. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  37868. * This allowed control for front to back rendering or reversly depending of the special needs.
  37869. *
  37870. * @param renderingGroupId The rendering group id corresponding to its index
  37871. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  37872. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  37873. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  37874. */
  37875. 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;
  37876. /**
  37877. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  37878. *
  37879. * @param renderingGroupId The rendering group id corresponding to its index
  37880. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  37881. */
  37882. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  37883. /**
  37884. * Clones the texture.
  37885. * @returns the cloned texture
  37886. */
  37887. clone(): RenderTargetTexture;
  37888. /**
  37889. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  37890. * @returns The JSON representation of the texture
  37891. */
  37892. serialize(): any;
  37893. /**
  37894. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  37895. */
  37896. disposeFramebufferObjects(): void;
  37897. /**
  37898. * Dispose the texture and release its associated resources.
  37899. */
  37900. dispose(): void;
  37901. /** @hidden */
  37902. _rebuild(): void;
  37903. /**
  37904. * Clear the info related to rendering groups preventing retention point in material dispose.
  37905. */
  37906. freeRenderingGroups(): void;
  37907. /**
  37908. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  37909. * @returns the view count
  37910. */
  37911. getViewCount(): number;
  37912. }
  37913. }
  37914. declare module BABYLON {
  37915. /**
  37916. * Options to be used when creating an effect.
  37917. */
  37918. export interface IEffectCreationOptions {
  37919. /**
  37920. * Atrributes that will be used in the shader.
  37921. */
  37922. attributes: string[];
  37923. /**
  37924. * Uniform varible names that will be set in the shader.
  37925. */
  37926. uniformsNames: string[];
  37927. /**
  37928. * Uniform buffer variable names that will be set in the shader.
  37929. */
  37930. uniformBuffersNames: string[];
  37931. /**
  37932. * Sampler texture variable names that will be set in the shader.
  37933. */
  37934. samplers: string[];
  37935. /**
  37936. * Define statements that will be set in the shader.
  37937. */
  37938. defines: any;
  37939. /**
  37940. * Possible fallbacks for this effect to improve performance when needed.
  37941. */
  37942. fallbacks: Nullable<IEffectFallbacks>;
  37943. /**
  37944. * Callback that will be called when the shader is compiled.
  37945. */
  37946. onCompiled: Nullable<(effect: Effect) => void>;
  37947. /**
  37948. * Callback that will be called if an error occurs during shader compilation.
  37949. */
  37950. onError: Nullable<(effect: Effect, errors: string) => void>;
  37951. /**
  37952. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  37953. */
  37954. indexParameters?: any;
  37955. /**
  37956. * Max number of lights that can be used in the shader.
  37957. */
  37958. maxSimultaneousLights?: number;
  37959. /**
  37960. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  37961. */
  37962. transformFeedbackVaryings?: Nullable<string[]>;
  37963. /**
  37964. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  37965. */
  37966. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  37967. /**
  37968. * Is this effect rendering to several color attachments ?
  37969. */
  37970. multiTarget?: boolean;
  37971. }
  37972. /**
  37973. * Effect containing vertex and fragment shader that can be executed on an object.
  37974. */
  37975. export class Effect implements IDisposable {
  37976. /**
  37977. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  37978. */
  37979. static ShadersRepository: string;
  37980. /**
  37981. * Enable logging of the shader code when a compilation error occurs
  37982. */
  37983. static LogShaderCodeOnCompilationError: boolean;
  37984. /**
  37985. * Name of the effect.
  37986. */
  37987. name: any;
  37988. /**
  37989. * String container all the define statements that should be set on the shader.
  37990. */
  37991. defines: string;
  37992. /**
  37993. * Callback that will be called when the shader is compiled.
  37994. */
  37995. onCompiled: Nullable<(effect: Effect) => void>;
  37996. /**
  37997. * Callback that will be called if an error occurs during shader compilation.
  37998. */
  37999. onError: Nullable<(effect: Effect, errors: string) => void>;
  38000. /**
  38001. * Callback that will be called when effect is bound.
  38002. */
  38003. onBind: Nullable<(effect: Effect) => void>;
  38004. /**
  38005. * Unique ID of the effect.
  38006. */
  38007. uniqueId: number;
  38008. /**
  38009. * Observable that will be called when the shader is compiled.
  38010. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  38011. */
  38012. onCompileObservable: Observable<Effect>;
  38013. /**
  38014. * Observable that will be called if an error occurs during shader compilation.
  38015. */
  38016. onErrorObservable: Observable<Effect>;
  38017. /** @hidden */
  38018. _onBindObservable: Nullable<Observable<Effect>>;
  38019. /**
  38020. * @hidden
  38021. * Specifies if the effect was previously ready
  38022. */
  38023. _wasPreviouslyReady: boolean;
  38024. /**
  38025. * Observable that will be called when effect is bound.
  38026. */
  38027. get onBindObservable(): Observable<Effect>;
  38028. /** @hidden */
  38029. _bonesComputationForcedToCPU: boolean;
  38030. /** @hidden */
  38031. _multiTarget: boolean;
  38032. private static _uniqueIdSeed;
  38033. private _engine;
  38034. private _uniformBuffersNames;
  38035. private _uniformBuffersNamesList;
  38036. private _uniformsNames;
  38037. private _samplerList;
  38038. private _samplers;
  38039. private _isReady;
  38040. private _compilationError;
  38041. private _allFallbacksProcessed;
  38042. private _attributesNames;
  38043. private _attributes;
  38044. private _attributeLocationByName;
  38045. private _uniforms;
  38046. /**
  38047. * Key for the effect.
  38048. * @hidden
  38049. */
  38050. _key: string;
  38051. private _indexParameters;
  38052. private _fallbacks;
  38053. private _vertexSourceCode;
  38054. private _fragmentSourceCode;
  38055. private _vertexSourceCodeOverride;
  38056. private _fragmentSourceCodeOverride;
  38057. private _transformFeedbackVaryings;
  38058. private _rawVertexSourceCode;
  38059. private _rawFragmentSourceCode;
  38060. /**
  38061. * Compiled shader to webGL program.
  38062. * @hidden
  38063. */
  38064. _pipelineContext: Nullable<IPipelineContext>;
  38065. private _valueCache;
  38066. private static _baseCache;
  38067. /**
  38068. * Instantiates an effect.
  38069. * An effect can be used to create/manage/execute vertex and fragment shaders.
  38070. * @param baseName Name of the effect.
  38071. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  38072. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  38073. * @param samplers List of sampler variables that will be passed to the shader.
  38074. * @param engine Engine to be used to render the effect
  38075. * @param defines Define statements to be added to the shader.
  38076. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  38077. * @param onCompiled Callback that will be called when the shader is compiled.
  38078. * @param onError Callback that will be called if an error occurs during shader compilation.
  38079. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  38080. */
  38081. constructor(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: Nullable<string[]>, engine?: ThinEngine, defines?: Nullable<string>, fallbacks?: Nullable<IEffectFallbacks>, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any);
  38082. private _useFinalCode;
  38083. /**
  38084. * Unique key for this effect
  38085. */
  38086. get key(): string;
  38087. /**
  38088. * If the effect has been compiled and prepared.
  38089. * @returns if the effect is compiled and prepared.
  38090. */
  38091. isReady(): boolean;
  38092. private _isReadyInternal;
  38093. /**
  38094. * The engine the effect was initialized with.
  38095. * @returns the engine.
  38096. */
  38097. getEngine(): Engine;
  38098. /**
  38099. * The pipeline context for this effect
  38100. * @returns the associated pipeline context
  38101. */
  38102. getPipelineContext(): Nullable<IPipelineContext>;
  38103. /**
  38104. * The set of names of attribute variables for the shader.
  38105. * @returns An array of attribute names.
  38106. */
  38107. getAttributesNames(): string[];
  38108. /**
  38109. * Returns the attribute at the given index.
  38110. * @param index The index of the attribute.
  38111. * @returns The location of the attribute.
  38112. */
  38113. getAttributeLocation(index: number): number;
  38114. /**
  38115. * Returns the attribute based on the name of the variable.
  38116. * @param name of the attribute to look up.
  38117. * @returns the attribute location.
  38118. */
  38119. getAttributeLocationByName(name: string): number;
  38120. /**
  38121. * The number of attributes.
  38122. * @returns the numnber of attributes.
  38123. */
  38124. getAttributesCount(): number;
  38125. /**
  38126. * Gets the index of a uniform variable.
  38127. * @param uniformName of the uniform to look up.
  38128. * @returns the index.
  38129. */
  38130. getUniformIndex(uniformName: string): number;
  38131. /**
  38132. * Returns the attribute based on the name of the variable.
  38133. * @param uniformName of the uniform to look up.
  38134. * @returns the location of the uniform.
  38135. */
  38136. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  38137. /**
  38138. * Returns an array of sampler variable names
  38139. * @returns The array of sampler variable names.
  38140. */
  38141. getSamplers(): string[];
  38142. /**
  38143. * Returns an array of uniform variable names
  38144. * @returns The array of uniform variable names.
  38145. */
  38146. getUniformNames(): string[];
  38147. /**
  38148. * Returns an array of uniform buffer variable names
  38149. * @returns The array of uniform buffer variable names.
  38150. */
  38151. getUniformBuffersNames(): string[];
  38152. /**
  38153. * Returns the index parameters used to create the effect
  38154. * @returns The index parameters object
  38155. */
  38156. getIndexParameters(): any;
  38157. /**
  38158. * The error from the last compilation.
  38159. * @returns the error string.
  38160. */
  38161. getCompilationError(): string;
  38162. /**
  38163. * Gets a boolean indicating that all fallbacks were used during compilation
  38164. * @returns true if all fallbacks were used
  38165. */
  38166. allFallbacksProcessed(): boolean;
  38167. /**
  38168. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  38169. * @param func The callback to be used.
  38170. */
  38171. executeWhenCompiled(func: (effect: Effect) => void): void;
  38172. private _checkIsReady;
  38173. private _loadShader;
  38174. /**
  38175. * Gets the vertex shader source code of this effect
  38176. */
  38177. get vertexSourceCode(): string;
  38178. /**
  38179. * Gets the fragment shader source code of this effect
  38180. */
  38181. get fragmentSourceCode(): string;
  38182. /**
  38183. * Gets the vertex shader source code before it has been processed by the preprocessor
  38184. */
  38185. get rawVertexSourceCode(): string;
  38186. /**
  38187. * Gets the fragment shader source code before it has been processed by the preprocessor
  38188. */
  38189. get rawFragmentSourceCode(): string;
  38190. /**
  38191. * Recompiles the webGL program
  38192. * @param vertexSourceCode The source code for the vertex shader.
  38193. * @param fragmentSourceCode The source code for the fragment shader.
  38194. * @param onCompiled Callback called when completed.
  38195. * @param onError Callback called on error.
  38196. * @hidden
  38197. */
  38198. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  38199. /**
  38200. * Prepares the effect
  38201. * @hidden
  38202. */
  38203. _prepareEffect(): void;
  38204. private _getShaderCodeAndErrorLine;
  38205. private _processCompilationErrors;
  38206. /**
  38207. * Checks if the effect is supported. (Must be called after compilation)
  38208. */
  38209. get isSupported(): boolean;
  38210. /**
  38211. * Binds a texture to the engine to be used as output of the shader.
  38212. * @param channel Name of the output variable.
  38213. * @param texture Texture to bind.
  38214. * @hidden
  38215. */
  38216. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  38217. /**
  38218. * Sets a texture on the engine to be used in the shader.
  38219. * @param channel Name of the sampler variable.
  38220. * @param texture Texture to set.
  38221. */
  38222. setTexture(channel: string, texture: Nullable<ThinTexture>): void;
  38223. /**
  38224. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  38225. * @param channel Name of the sampler variable.
  38226. * @param texture Texture to set.
  38227. */
  38228. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  38229. /**
  38230. * Sets an array of textures on the engine to be used in the shader.
  38231. * @param channel Name of the variable.
  38232. * @param textures Textures to set.
  38233. */
  38234. setTextureArray(channel: string, textures: ThinTexture[]): void;
  38235. /**
  38236. * 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)
  38237. * @param channel Name of the sampler variable.
  38238. * @param postProcess Post process to get the input texture from.
  38239. */
  38240. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  38241. /**
  38242. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  38243. * 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)
  38244. * @param channel Name of the sampler variable.
  38245. * @param postProcess Post process to get the output texture from.
  38246. */
  38247. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  38248. /** @hidden */
  38249. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  38250. /** @hidden */
  38251. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  38252. /** @hidden */
  38253. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  38254. /** @hidden */
  38255. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  38256. /**
  38257. * Binds a buffer to a uniform.
  38258. * @param buffer Buffer to bind.
  38259. * @param name Name of the uniform variable to bind to.
  38260. */
  38261. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  38262. /**
  38263. * Binds block to a uniform.
  38264. * @param blockName Name of the block to bind.
  38265. * @param index Index to bind.
  38266. */
  38267. bindUniformBlock(blockName: string, index: number): void;
  38268. /**
  38269. * Sets an interger value on a uniform variable.
  38270. * @param uniformName Name of the variable.
  38271. * @param value Value to be set.
  38272. * @returns this effect.
  38273. */
  38274. setInt(uniformName: string, value: number): Effect;
  38275. /**
  38276. * Sets an int array on a uniform variable.
  38277. * @param uniformName Name of the variable.
  38278. * @param array array to be set.
  38279. * @returns this effect.
  38280. */
  38281. setIntArray(uniformName: string, array: Int32Array): Effect;
  38282. /**
  38283. * 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)
  38284. * @param uniformName Name of the variable.
  38285. * @param array array to be set.
  38286. * @returns this effect.
  38287. */
  38288. setIntArray2(uniformName: string, array: Int32Array): Effect;
  38289. /**
  38290. * 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)
  38291. * @param uniformName Name of the variable.
  38292. * @param array array to be set.
  38293. * @returns this effect.
  38294. */
  38295. setIntArray3(uniformName: string, array: Int32Array): Effect;
  38296. /**
  38297. * 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)
  38298. * @param uniformName Name of the variable.
  38299. * @param array array to be set.
  38300. * @returns this effect.
  38301. */
  38302. setIntArray4(uniformName: string, array: Int32Array): Effect;
  38303. /**
  38304. * Sets an float array on a uniform variable.
  38305. * @param uniformName Name of the variable.
  38306. * @param array array to be set.
  38307. * @returns this effect.
  38308. */
  38309. setFloatArray(uniformName: string, array: Float32Array): Effect;
  38310. /**
  38311. * 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)
  38312. * @param uniformName Name of the variable.
  38313. * @param array array to be set.
  38314. * @returns this effect.
  38315. */
  38316. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  38317. /**
  38318. * 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)
  38319. * @param uniformName Name of the variable.
  38320. * @param array array to be set.
  38321. * @returns this effect.
  38322. */
  38323. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  38324. /**
  38325. * 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)
  38326. * @param uniformName Name of the variable.
  38327. * @param array array to be set.
  38328. * @returns this effect.
  38329. */
  38330. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  38331. /**
  38332. * Sets an array on a uniform variable.
  38333. * @param uniformName Name of the variable.
  38334. * @param array array to be set.
  38335. * @returns this effect.
  38336. */
  38337. setArray(uniformName: string, array: number[]): Effect;
  38338. /**
  38339. * 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)
  38340. * @param uniformName Name of the variable.
  38341. * @param array array to be set.
  38342. * @returns this effect.
  38343. */
  38344. setArray2(uniformName: string, array: number[]): Effect;
  38345. /**
  38346. * 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)
  38347. * @param uniformName Name of the variable.
  38348. * @param array array to be set.
  38349. * @returns this effect.
  38350. */
  38351. setArray3(uniformName: string, array: number[]): Effect;
  38352. /**
  38353. * 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)
  38354. * @param uniformName Name of the variable.
  38355. * @param array array to be set.
  38356. * @returns this effect.
  38357. */
  38358. setArray4(uniformName: string, array: number[]): Effect;
  38359. /**
  38360. * Sets matrices on a uniform variable.
  38361. * @param uniformName Name of the variable.
  38362. * @param matrices matrices to be set.
  38363. * @returns this effect.
  38364. */
  38365. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  38366. /**
  38367. * Sets matrix on a uniform variable.
  38368. * @param uniformName Name of the variable.
  38369. * @param matrix matrix to be set.
  38370. * @returns this effect.
  38371. */
  38372. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  38373. /**
  38374. * 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)
  38375. * @param uniformName Name of the variable.
  38376. * @param matrix matrix to be set.
  38377. * @returns this effect.
  38378. */
  38379. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  38380. /**
  38381. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  38382. * @param uniformName Name of the variable.
  38383. * @param matrix matrix to be set.
  38384. * @returns this effect.
  38385. */
  38386. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  38387. /**
  38388. * Sets a float on a uniform variable.
  38389. * @param uniformName Name of the variable.
  38390. * @param value value to be set.
  38391. * @returns this effect.
  38392. */
  38393. setFloat(uniformName: string, value: number): Effect;
  38394. /**
  38395. * Sets a boolean on a uniform variable.
  38396. * @param uniformName Name of the variable.
  38397. * @param bool value to be set.
  38398. * @returns this effect.
  38399. */
  38400. setBool(uniformName: string, bool: boolean): Effect;
  38401. /**
  38402. * Sets a Vector2 on a uniform variable.
  38403. * @param uniformName Name of the variable.
  38404. * @param vector2 vector2 to be set.
  38405. * @returns this effect.
  38406. */
  38407. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  38408. /**
  38409. * Sets a float2 on a uniform variable.
  38410. * @param uniformName Name of the variable.
  38411. * @param x First float in float2.
  38412. * @param y Second float in float2.
  38413. * @returns this effect.
  38414. */
  38415. setFloat2(uniformName: string, x: number, y: number): Effect;
  38416. /**
  38417. * Sets a Vector3 on a uniform variable.
  38418. * @param uniformName Name of the variable.
  38419. * @param vector3 Value to be set.
  38420. * @returns this effect.
  38421. */
  38422. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  38423. /**
  38424. * Sets a float3 on a uniform variable.
  38425. * @param uniformName Name of the variable.
  38426. * @param x First float in float3.
  38427. * @param y Second float in float3.
  38428. * @param z Third float in float3.
  38429. * @returns this effect.
  38430. */
  38431. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  38432. /**
  38433. * Sets a Vector4 on a uniform variable.
  38434. * @param uniformName Name of the variable.
  38435. * @param vector4 Value to be set.
  38436. * @returns this effect.
  38437. */
  38438. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  38439. /**
  38440. * Sets a float4 on a uniform variable.
  38441. * @param uniformName Name of the variable.
  38442. * @param x First float in float4.
  38443. * @param y Second float in float4.
  38444. * @param z Third float in float4.
  38445. * @param w Fourth float in float4.
  38446. * @returns this effect.
  38447. */
  38448. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  38449. /**
  38450. * Sets a Color3 on a uniform variable.
  38451. * @param uniformName Name of the variable.
  38452. * @param color3 Value to be set.
  38453. * @returns this effect.
  38454. */
  38455. setColor3(uniformName: string, color3: IColor3Like): Effect;
  38456. /**
  38457. * Sets a Color4 on a uniform variable.
  38458. * @param uniformName Name of the variable.
  38459. * @param color3 Value to be set.
  38460. * @param alpha Alpha value to be set.
  38461. * @returns this effect.
  38462. */
  38463. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  38464. /**
  38465. * Sets a Color4 on a uniform variable
  38466. * @param uniformName defines the name of the variable
  38467. * @param color4 defines the value to be set
  38468. * @returns this effect.
  38469. */
  38470. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  38471. /** Release all associated resources */
  38472. dispose(): void;
  38473. /**
  38474. * This function will add a new shader to the shader store
  38475. * @param name the name of the shader
  38476. * @param pixelShader optional pixel shader content
  38477. * @param vertexShader optional vertex shader content
  38478. */
  38479. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  38480. /**
  38481. * Store of each shader (The can be looked up using effect.key)
  38482. */
  38483. static ShadersStore: {
  38484. [key: string]: string;
  38485. };
  38486. /**
  38487. * Store of each included file for a shader (The can be looked up using effect.key)
  38488. */
  38489. static IncludesShadersStore: {
  38490. [key: string]: string;
  38491. };
  38492. /**
  38493. * Resets the cache of effects.
  38494. */
  38495. static ResetCache(): void;
  38496. }
  38497. }
  38498. declare module BABYLON {
  38499. /**
  38500. * Interface used to describe the capabilities of the engine relatively to the current browser
  38501. */
  38502. export interface EngineCapabilities {
  38503. /** Maximum textures units per fragment shader */
  38504. maxTexturesImageUnits: number;
  38505. /** Maximum texture units per vertex shader */
  38506. maxVertexTextureImageUnits: number;
  38507. /** Maximum textures units in the entire pipeline */
  38508. maxCombinedTexturesImageUnits: number;
  38509. /** Maximum texture size */
  38510. maxTextureSize: number;
  38511. /** Maximum texture samples */
  38512. maxSamples?: number;
  38513. /** Maximum cube texture size */
  38514. maxCubemapTextureSize: number;
  38515. /** Maximum render texture size */
  38516. maxRenderTextureSize: number;
  38517. /** Maximum number of vertex attributes */
  38518. maxVertexAttribs: number;
  38519. /** Maximum number of varyings */
  38520. maxVaryingVectors: number;
  38521. /** Maximum number of uniforms per vertex shader */
  38522. maxVertexUniformVectors: number;
  38523. /** Maximum number of uniforms per fragment shader */
  38524. maxFragmentUniformVectors: number;
  38525. /** Defines if standard derivates (dx/dy) are supported */
  38526. standardDerivatives: boolean;
  38527. /** Defines if s3tc texture compression is supported */
  38528. s3tc?: WEBGL_compressed_texture_s3tc;
  38529. /** Defines if pvrtc texture compression is supported */
  38530. pvrtc: any;
  38531. /** Defines if etc1 texture compression is supported */
  38532. etc1: any;
  38533. /** Defines if etc2 texture compression is supported */
  38534. etc2: any;
  38535. /** Defines if astc texture compression is supported */
  38536. astc: any;
  38537. /** Defines if bptc texture compression is supported */
  38538. bptc: any;
  38539. /** Defines if float textures are supported */
  38540. textureFloat: boolean;
  38541. /** Defines if vertex array objects are supported */
  38542. vertexArrayObject: boolean;
  38543. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  38544. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  38545. /** Gets the maximum level of anisotropy supported */
  38546. maxAnisotropy: number;
  38547. /** Defines if instancing is supported */
  38548. instancedArrays: boolean;
  38549. /** Defines if 32 bits indices are supported */
  38550. uintIndices: boolean;
  38551. /** Defines if high precision shaders are supported */
  38552. highPrecisionShaderSupported: boolean;
  38553. /** Defines if depth reading in the fragment shader is supported */
  38554. fragmentDepthSupported: boolean;
  38555. /** Defines if float texture linear filtering is supported*/
  38556. textureFloatLinearFiltering: boolean;
  38557. /** Defines if rendering to float textures is supported */
  38558. textureFloatRender: boolean;
  38559. /** Defines if half float textures are supported*/
  38560. textureHalfFloat: boolean;
  38561. /** Defines if half float texture linear filtering is supported*/
  38562. textureHalfFloatLinearFiltering: boolean;
  38563. /** Defines if rendering to half float textures is supported */
  38564. textureHalfFloatRender: boolean;
  38565. /** Defines if textureLOD shader command is supported */
  38566. textureLOD: boolean;
  38567. /** Defines if draw buffers extension is supported */
  38568. drawBuffersExtension: boolean;
  38569. /** Defines if depth textures are supported */
  38570. depthTextureExtension: boolean;
  38571. /** Defines if float color buffer are supported */
  38572. colorBufferFloat: boolean;
  38573. /** Gets disjoint timer query extension (null if not supported) */
  38574. timerQuery?: EXT_disjoint_timer_query;
  38575. /** Defines if timestamp can be used with timer query */
  38576. canUseTimestampForTimerQuery: boolean;
  38577. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  38578. multiview?: any;
  38579. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  38580. oculusMultiview?: any;
  38581. /** Function used to let the system compiles shaders in background */
  38582. parallelShaderCompile?: {
  38583. COMPLETION_STATUS_KHR: number;
  38584. };
  38585. /** Max number of texture samples for MSAA */
  38586. maxMSAASamples: number;
  38587. /** Defines if the blend min max extension is supported */
  38588. blendMinMax: boolean;
  38589. }
  38590. }
  38591. declare module BABYLON {
  38592. /**
  38593. * @hidden
  38594. **/
  38595. export class DepthCullingState {
  38596. private _isDepthTestDirty;
  38597. private _isDepthMaskDirty;
  38598. private _isDepthFuncDirty;
  38599. private _isCullFaceDirty;
  38600. private _isCullDirty;
  38601. private _isZOffsetDirty;
  38602. private _isFrontFaceDirty;
  38603. private _depthTest;
  38604. private _depthMask;
  38605. private _depthFunc;
  38606. private _cull;
  38607. private _cullFace;
  38608. private _zOffset;
  38609. private _frontFace;
  38610. /**
  38611. * Initializes the state.
  38612. */
  38613. constructor();
  38614. get isDirty(): boolean;
  38615. get zOffset(): number;
  38616. set zOffset(value: number);
  38617. get cullFace(): Nullable<number>;
  38618. set cullFace(value: Nullable<number>);
  38619. get cull(): Nullable<boolean>;
  38620. set cull(value: Nullable<boolean>);
  38621. get depthFunc(): Nullable<number>;
  38622. set depthFunc(value: Nullable<number>);
  38623. get depthMask(): boolean;
  38624. set depthMask(value: boolean);
  38625. get depthTest(): boolean;
  38626. set depthTest(value: boolean);
  38627. get frontFace(): Nullable<number>;
  38628. set frontFace(value: Nullable<number>);
  38629. reset(): void;
  38630. apply(gl: WebGLRenderingContext): void;
  38631. }
  38632. }
  38633. declare module BABYLON {
  38634. /**
  38635. * @hidden
  38636. **/
  38637. export class StencilState {
  38638. /** 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 */
  38639. static readonly ALWAYS: number;
  38640. /** Passed to stencilOperation to specify that stencil value must be kept */
  38641. static readonly KEEP: number;
  38642. /** Passed to stencilOperation to specify that stencil value must be replaced */
  38643. static readonly REPLACE: number;
  38644. private _isStencilTestDirty;
  38645. private _isStencilMaskDirty;
  38646. private _isStencilFuncDirty;
  38647. private _isStencilOpDirty;
  38648. private _stencilTest;
  38649. private _stencilMask;
  38650. private _stencilFunc;
  38651. private _stencilFuncRef;
  38652. private _stencilFuncMask;
  38653. private _stencilOpStencilFail;
  38654. private _stencilOpDepthFail;
  38655. private _stencilOpStencilDepthPass;
  38656. get isDirty(): boolean;
  38657. get stencilFunc(): number;
  38658. set stencilFunc(value: number);
  38659. get stencilFuncRef(): number;
  38660. set stencilFuncRef(value: number);
  38661. get stencilFuncMask(): number;
  38662. set stencilFuncMask(value: number);
  38663. get stencilOpStencilFail(): number;
  38664. set stencilOpStencilFail(value: number);
  38665. get stencilOpDepthFail(): number;
  38666. set stencilOpDepthFail(value: number);
  38667. get stencilOpStencilDepthPass(): number;
  38668. set stencilOpStencilDepthPass(value: number);
  38669. get stencilMask(): number;
  38670. set stencilMask(value: number);
  38671. get stencilTest(): boolean;
  38672. set stencilTest(value: boolean);
  38673. constructor();
  38674. reset(): void;
  38675. apply(gl: WebGLRenderingContext): void;
  38676. }
  38677. }
  38678. declare module BABYLON {
  38679. /**
  38680. * @hidden
  38681. **/
  38682. export class AlphaState {
  38683. private _isAlphaBlendDirty;
  38684. private _isBlendFunctionParametersDirty;
  38685. private _isBlendEquationParametersDirty;
  38686. private _isBlendConstantsDirty;
  38687. private _alphaBlend;
  38688. private _blendFunctionParameters;
  38689. private _blendEquationParameters;
  38690. private _blendConstants;
  38691. /**
  38692. * Initializes the state.
  38693. */
  38694. constructor();
  38695. get isDirty(): boolean;
  38696. get alphaBlend(): boolean;
  38697. set alphaBlend(value: boolean);
  38698. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  38699. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  38700. setAlphaEquationParameters(rgb: number, alpha: number): void;
  38701. reset(): void;
  38702. apply(gl: WebGLRenderingContext): void;
  38703. }
  38704. }
  38705. declare module BABYLON {
  38706. /** @hidden */
  38707. export class WebGLShaderProcessor implements IShaderProcessor {
  38708. postProcessor(code: string, defines: string[], isFragment: boolean, engine: ThinEngine): string;
  38709. }
  38710. }
  38711. declare module BABYLON {
  38712. /** @hidden */
  38713. export class WebGL2ShaderProcessor implements IShaderProcessor {
  38714. attributeProcessor(attribute: string): string;
  38715. varyingProcessor(varying: string, isFragment: boolean): string;
  38716. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  38717. }
  38718. }
  38719. declare module BABYLON {
  38720. /**
  38721. * Interface for attribute information associated with buffer instanciation
  38722. */
  38723. export interface InstancingAttributeInfo {
  38724. /**
  38725. * Name of the GLSL attribute
  38726. * if attribute index is not specified, this is used to retrieve the index from the effect
  38727. */
  38728. attributeName: string;
  38729. /**
  38730. * Index/offset of the attribute in the vertex shader
  38731. * if not specified, this will be computes from the name.
  38732. */
  38733. index?: number;
  38734. /**
  38735. * size of the attribute, 1, 2, 3 or 4
  38736. */
  38737. attributeSize: number;
  38738. /**
  38739. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  38740. */
  38741. offset: number;
  38742. /**
  38743. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  38744. * default to 1
  38745. */
  38746. divisor?: number;
  38747. /**
  38748. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  38749. * default is FLOAT
  38750. */
  38751. attributeType?: number;
  38752. /**
  38753. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  38754. */
  38755. normalized?: boolean;
  38756. }
  38757. }
  38758. declare module BABYLON {
  38759. interface ThinEngine {
  38760. /**
  38761. * Update a video texture
  38762. * @param texture defines the texture to update
  38763. * @param video defines the video element to use
  38764. * @param invertY defines if data must be stored with Y axis inverted
  38765. */
  38766. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  38767. }
  38768. }
  38769. declare module BABYLON {
  38770. interface ThinEngine {
  38771. /**
  38772. * Creates a dynamic texture
  38773. * @param width defines the width of the texture
  38774. * @param height defines the height of the texture
  38775. * @param generateMipMaps defines if the engine should generate the mip levels
  38776. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  38777. * @returns the dynamic texture inside an InternalTexture
  38778. */
  38779. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  38780. /**
  38781. * Update the content of a dynamic texture
  38782. * @param texture defines the texture to update
  38783. * @param source defines the source containing the data
  38784. * @param invertY defines if data must be stored with Y axis inverted
  38785. * @param premulAlpha defines if alpha is stored as premultiplied
  38786. * @param format defines the format of the data
  38787. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  38788. */
  38789. updateDynamicTexture(texture: Nullable<InternalTexture>, source: ImageBitmap | ImageData | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | OffscreenCanvas, invertY?: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  38790. }
  38791. }
  38792. declare module BABYLON {
  38793. /**
  38794. * Settings for finer control over video usage
  38795. */
  38796. export interface VideoTextureSettings {
  38797. /**
  38798. * Applies `autoplay` to video, if specified
  38799. */
  38800. autoPlay?: boolean;
  38801. /**
  38802. * Applies `muted` to video, if specified
  38803. */
  38804. muted?: boolean;
  38805. /**
  38806. * Applies `loop` to video, if specified
  38807. */
  38808. loop?: boolean;
  38809. /**
  38810. * Automatically updates internal texture from video at every frame in the render loop
  38811. */
  38812. autoUpdateTexture: boolean;
  38813. /**
  38814. * Image src displayed during the video loading or until the user interacts with the video.
  38815. */
  38816. poster?: string;
  38817. }
  38818. /**
  38819. * If you want to display a video in your scene, this is the special texture for that.
  38820. * This special texture works similar to other textures, with the exception of a few parameters.
  38821. * @see https://doc.babylonjs.com/how_to/video_texture
  38822. */
  38823. export class VideoTexture extends Texture {
  38824. /**
  38825. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  38826. */
  38827. readonly autoUpdateTexture: boolean;
  38828. /**
  38829. * The video instance used by the texture internally
  38830. */
  38831. readonly video: HTMLVideoElement;
  38832. private _onUserActionRequestedObservable;
  38833. /**
  38834. * Event triggerd when a dom action is required by the user to play the video.
  38835. * This happens due to recent changes in browser policies preventing video to auto start.
  38836. */
  38837. get onUserActionRequestedObservable(): Observable<Texture>;
  38838. private _generateMipMaps;
  38839. private _stillImageCaptured;
  38840. private _displayingPosterTexture;
  38841. private _settings;
  38842. private _createInternalTextureOnEvent;
  38843. private _frameId;
  38844. private _currentSrc;
  38845. /**
  38846. * Creates a video texture.
  38847. * If you want to display a video in your scene, this is the special texture for that.
  38848. * This special texture works similar to other textures, with the exception of a few parameters.
  38849. * @see https://doc.babylonjs.com/how_to/video_texture
  38850. * @param name optional name, will detect from video source, if not defined
  38851. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  38852. * @param scene is obviously the current scene.
  38853. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  38854. * @param invertY is false by default but can be used to invert video on Y axis
  38855. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  38856. * @param settings allows finer control over video usage
  38857. */
  38858. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  38859. private _getName;
  38860. private _getVideo;
  38861. private _createInternalTexture;
  38862. private reset;
  38863. /**
  38864. * @hidden Internal method to initiate `update`.
  38865. */
  38866. _rebuild(): void;
  38867. /**
  38868. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  38869. */
  38870. update(): void;
  38871. /**
  38872. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  38873. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  38874. */
  38875. updateTexture(isVisible: boolean): void;
  38876. protected _updateInternalTexture: () => void;
  38877. /**
  38878. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  38879. * @param url New url.
  38880. */
  38881. updateURL(url: string): void;
  38882. /**
  38883. * Clones the texture.
  38884. * @returns the cloned texture
  38885. */
  38886. clone(): VideoTexture;
  38887. /**
  38888. * Dispose the texture and release its associated resources.
  38889. */
  38890. dispose(): void;
  38891. /**
  38892. * Creates a video texture straight from a stream.
  38893. * @param scene Define the scene the texture should be created in
  38894. * @param stream Define the stream the texture should be created from
  38895. * @returns The created video texture as a promise
  38896. */
  38897. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  38898. /**
  38899. * Creates a video texture straight from your WebCam video feed.
  38900. * @param scene Define the scene the texture should be created in
  38901. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  38902. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  38903. * @returns The created video texture as a promise
  38904. */
  38905. static CreateFromWebCamAsync(scene: Scene, constraints: {
  38906. minWidth: number;
  38907. maxWidth: number;
  38908. minHeight: number;
  38909. maxHeight: number;
  38910. deviceId: string;
  38911. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  38912. /**
  38913. * Creates a video texture straight from your WebCam video feed.
  38914. * @param scene Define the scene the texture should be created in
  38915. * @param onReady Define a callback to triggered once the texture will be ready
  38916. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  38917. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  38918. */
  38919. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  38920. minWidth: number;
  38921. maxWidth: number;
  38922. minHeight: number;
  38923. maxHeight: number;
  38924. deviceId: string;
  38925. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  38926. }
  38927. }
  38928. declare module BABYLON {
  38929. /**
  38930. * Defines the interface used by objects working like Scene
  38931. * @hidden
  38932. */
  38933. export interface ISceneLike {
  38934. _addPendingData(data: any): void;
  38935. _removePendingData(data: any): void;
  38936. offlineProvider: IOfflineProvider;
  38937. }
  38938. /**
  38939. * Information about the current host
  38940. */
  38941. export interface HostInformation {
  38942. /**
  38943. * Defines if the current host is a mobile
  38944. */
  38945. isMobile: boolean;
  38946. }
  38947. /** Interface defining initialization parameters for Engine class */
  38948. export interface EngineOptions extends WebGLContextAttributes {
  38949. /**
  38950. * Defines if the engine should no exceed a specified device ratio
  38951. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  38952. */
  38953. limitDeviceRatio?: number;
  38954. /**
  38955. * Defines if webvr should be enabled automatically
  38956. * @see https://doc.babylonjs.com/how_to/webvr_camera
  38957. */
  38958. autoEnableWebVR?: boolean;
  38959. /**
  38960. * Defines if webgl2 should be turned off even if supported
  38961. * @see https://doc.babylonjs.com/features/webgl2
  38962. */
  38963. disableWebGL2Support?: boolean;
  38964. /**
  38965. * Defines if webaudio should be initialized as well
  38966. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38967. */
  38968. audioEngine?: boolean;
  38969. /**
  38970. * Defines if animations should run using a deterministic lock step
  38971. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38972. */
  38973. deterministicLockstep?: boolean;
  38974. /** Defines the maximum steps to use with deterministic lock step mode */
  38975. lockstepMaxSteps?: number;
  38976. /** Defines the seconds between each deterministic lock step */
  38977. timeStep?: number;
  38978. /**
  38979. * Defines that engine should ignore context lost events
  38980. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  38981. */
  38982. doNotHandleContextLost?: boolean;
  38983. /**
  38984. * Defines that engine should ignore modifying touch action attribute and style
  38985. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  38986. */
  38987. doNotHandleTouchAction?: boolean;
  38988. /**
  38989. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  38990. */
  38991. useHighPrecisionFloats?: boolean;
  38992. /**
  38993. * Make the canvas XR Compatible for XR sessions
  38994. */
  38995. xrCompatible?: boolean;
  38996. /**
  38997. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  38998. */
  38999. useHighPrecisionMatrix?: boolean;
  39000. /**
  39001. * Will prevent the system from falling back to software implementation if a hardware device cannot be created
  39002. */
  39003. failIfMajorPerformanceCaveat?: boolean;
  39004. }
  39005. /**
  39006. * The base engine class (root of all engines)
  39007. */
  39008. export class ThinEngine {
  39009. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  39010. static ExceptionList: ({
  39011. key: string;
  39012. capture: string;
  39013. captureConstraint: number;
  39014. targets: string[];
  39015. } | {
  39016. key: string;
  39017. capture: null;
  39018. captureConstraint: null;
  39019. targets: string[];
  39020. })[];
  39021. /** @hidden */
  39022. static _TextureLoaders: IInternalTextureLoader[];
  39023. /**
  39024. * Returns the current npm package of the sdk
  39025. */
  39026. static get NpmPackage(): string;
  39027. /**
  39028. * Returns the current version of the framework
  39029. */
  39030. static get Version(): string;
  39031. /**
  39032. * Returns a string describing the current engine
  39033. */
  39034. get description(): string;
  39035. /**
  39036. * Gets or sets the epsilon value used by collision engine
  39037. */
  39038. static CollisionsEpsilon: number;
  39039. /**
  39040. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  39041. */
  39042. static get ShadersRepository(): string;
  39043. static set ShadersRepository(value: string);
  39044. /** @hidden */
  39045. _shaderProcessor: IShaderProcessor;
  39046. /**
  39047. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  39048. */
  39049. forcePOTTextures: boolean;
  39050. /**
  39051. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  39052. */
  39053. isFullscreen: boolean;
  39054. /**
  39055. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  39056. */
  39057. cullBackFaces: boolean;
  39058. /**
  39059. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  39060. */
  39061. renderEvenInBackground: boolean;
  39062. /**
  39063. * Gets or sets a boolean indicating that cache can be kept between frames
  39064. */
  39065. preventCacheWipeBetweenFrames: boolean;
  39066. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  39067. validateShaderPrograms: boolean;
  39068. /**
  39069. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  39070. * This can provide greater z depth for distant objects.
  39071. */
  39072. useReverseDepthBuffer: boolean;
  39073. /**
  39074. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  39075. */
  39076. disableUniformBuffers: boolean;
  39077. /** @hidden */
  39078. _uniformBuffers: UniformBuffer[];
  39079. /**
  39080. * Gets a boolean indicating that the engine supports uniform buffers
  39081. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  39082. */
  39083. get supportsUniformBuffers(): boolean;
  39084. /** @hidden */
  39085. _gl: WebGLRenderingContext;
  39086. /** @hidden */
  39087. _webGLVersion: number;
  39088. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  39089. protected _windowIsBackground: boolean;
  39090. protected _creationOptions: EngineOptions;
  39091. protected _highPrecisionShadersAllowed: boolean;
  39092. /** @hidden */
  39093. get _shouldUseHighPrecisionShader(): boolean;
  39094. /**
  39095. * Gets a boolean indicating that only power of 2 textures are supported
  39096. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  39097. */
  39098. get needPOTTextures(): boolean;
  39099. /** @hidden */
  39100. _badOS: boolean;
  39101. /** @hidden */
  39102. _badDesktopOS: boolean;
  39103. private _hardwareScalingLevel;
  39104. /** @hidden */
  39105. _caps: EngineCapabilities;
  39106. private _isStencilEnable;
  39107. private _glVersion;
  39108. private _glRenderer;
  39109. private _glVendor;
  39110. /** @hidden */
  39111. _videoTextureSupported: boolean;
  39112. protected _renderingQueueLaunched: boolean;
  39113. protected _activeRenderLoops: (() => void)[];
  39114. /**
  39115. * Observable signaled when a context lost event is raised
  39116. */
  39117. onContextLostObservable: Observable<ThinEngine>;
  39118. /**
  39119. * Observable signaled when a context restored event is raised
  39120. */
  39121. onContextRestoredObservable: Observable<ThinEngine>;
  39122. private _onContextLost;
  39123. private _onContextRestored;
  39124. protected _contextWasLost: boolean;
  39125. /** @hidden */
  39126. _doNotHandleContextLost: boolean;
  39127. /**
  39128. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  39129. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  39130. */
  39131. get doNotHandleContextLost(): boolean;
  39132. set doNotHandleContextLost(value: boolean);
  39133. /**
  39134. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  39135. */
  39136. disableVertexArrayObjects: boolean;
  39137. /** @hidden */
  39138. protected _colorWrite: boolean;
  39139. /** @hidden */
  39140. protected _colorWriteChanged: boolean;
  39141. /** @hidden */
  39142. protected _depthCullingState: DepthCullingState;
  39143. /** @hidden */
  39144. protected _stencilState: StencilState;
  39145. /** @hidden */
  39146. _alphaState: AlphaState;
  39147. /** @hidden */
  39148. _alphaMode: number;
  39149. /** @hidden */
  39150. _alphaEquation: number;
  39151. /** @hidden */
  39152. _internalTexturesCache: InternalTexture[];
  39153. /** @hidden */
  39154. protected _activeChannel: number;
  39155. private _currentTextureChannel;
  39156. /** @hidden */
  39157. protected _boundTexturesCache: {
  39158. [key: string]: Nullable<InternalTexture>;
  39159. };
  39160. /** @hidden */
  39161. protected _currentEffect: Nullable<Effect>;
  39162. /** @hidden */
  39163. protected _currentProgram: Nullable<WebGLProgram>;
  39164. private _compiledEffects;
  39165. private _vertexAttribArraysEnabled;
  39166. /** @hidden */
  39167. protected _cachedViewport: Nullable<IViewportLike>;
  39168. private _cachedVertexArrayObject;
  39169. /** @hidden */
  39170. protected _cachedVertexBuffers: any;
  39171. /** @hidden */
  39172. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  39173. /** @hidden */
  39174. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  39175. /** @hidden */
  39176. _currentRenderTarget: Nullable<InternalTexture>;
  39177. private _uintIndicesCurrentlySet;
  39178. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  39179. /** @hidden */
  39180. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  39181. /** @hidden */
  39182. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  39183. private _currentBufferPointers;
  39184. private _currentInstanceLocations;
  39185. private _currentInstanceBuffers;
  39186. private _textureUnits;
  39187. /** @hidden */
  39188. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  39189. /** @hidden */
  39190. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  39191. /** @hidden */
  39192. _boundRenderFunction: any;
  39193. private _vaoRecordInProgress;
  39194. private _mustWipeVertexAttributes;
  39195. private _emptyTexture;
  39196. private _emptyCubeTexture;
  39197. private _emptyTexture3D;
  39198. private _emptyTexture2DArray;
  39199. /** @hidden */
  39200. _frameHandler: number;
  39201. private _nextFreeTextureSlots;
  39202. private _maxSimultaneousTextures;
  39203. private _activeRequests;
  39204. /** @hidden */
  39205. _transformTextureUrl: Nullable<(url: string) => string>;
  39206. /**
  39207. * Gets information about the current host
  39208. */
  39209. hostInformation: HostInformation;
  39210. protected get _supportsHardwareTextureRescaling(): boolean;
  39211. private _framebufferDimensionsObject;
  39212. /**
  39213. * sets the object from which width and height will be taken from when getting render width and height
  39214. * Will fallback to the gl object
  39215. * @param dimensions the framebuffer width and height that will be used.
  39216. */
  39217. set framebufferDimensionsObject(dimensions: Nullable<{
  39218. framebufferWidth: number;
  39219. framebufferHeight: number;
  39220. }>);
  39221. /**
  39222. * Gets the current viewport
  39223. */
  39224. get currentViewport(): Nullable<IViewportLike>;
  39225. /**
  39226. * Gets the default empty texture
  39227. */
  39228. get emptyTexture(): InternalTexture;
  39229. /**
  39230. * Gets the default empty 3D texture
  39231. */
  39232. get emptyTexture3D(): InternalTexture;
  39233. /**
  39234. * Gets the default empty 2D array texture
  39235. */
  39236. get emptyTexture2DArray(): InternalTexture;
  39237. /**
  39238. * Gets the default empty cube texture
  39239. */
  39240. get emptyCubeTexture(): InternalTexture;
  39241. /**
  39242. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  39243. */
  39244. readonly premultipliedAlpha: boolean;
  39245. /**
  39246. * Observable event triggered before each texture is initialized
  39247. */
  39248. onBeforeTextureInitObservable: Observable<Texture>;
  39249. /**
  39250. * Creates a new engine
  39251. * @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
  39252. * @param antialias defines enable antialiasing (default: false)
  39253. * @param options defines further options to be sent to the getContext() function
  39254. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  39255. */
  39256. constructor(canvasOrContext: Nullable<HTMLCanvasElement | OffscreenCanvas | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  39257. private _rebuildInternalTextures;
  39258. private _rebuildEffects;
  39259. /**
  39260. * Gets a boolean indicating if all created effects are ready
  39261. * @returns true if all effects are ready
  39262. */
  39263. areAllEffectsReady(): boolean;
  39264. protected _rebuildBuffers(): void;
  39265. protected _initGLContext(): void;
  39266. /**
  39267. * Gets version of the current webGL context
  39268. */
  39269. get webGLVersion(): number;
  39270. /**
  39271. * Gets a string identifying the name of the class
  39272. * @returns "Engine" string
  39273. */
  39274. getClassName(): string;
  39275. /**
  39276. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  39277. */
  39278. get isStencilEnable(): boolean;
  39279. /** @hidden */
  39280. _prepareWorkingCanvas(): void;
  39281. /**
  39282. * Reset the texture cache to empty state
  39283. */
  39284. resetTextureCache(): void;
  39285. /**
  39286. * Gets an object containing information about the current webGL context
  39287. * @returns an object containing the vender, the renderer and the version of the current webGL context
  39288. */
  39289. getGlInfo(): {
  39290. vendor: string;
  39291. renderer: string;
  39292. version: string;
  39293. };
  39294. /**
  39295. * Defines the hardware scaling level.
  39296. * By default the hardware scaling level is computed from the window device ratio.
  39297. * 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.
  39298. * @param level defines the level to use
  39299. */
  39300. setHardwareScalingLevel(level: number): void;
  39301. /**
  39302. * Gets the current hardware scaling level.
  39303. * By default the hardware scaling level is computed from the window device ratio.
  39304. * 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.
  39305. * @returns a number indicating the current hardware scaling level
  39306. */
  39307. getHardwareScalingLevel(): number;
  39308. /**
  39309. * Gets the list of loaded textures
  39310. * @returns an array containing all loaded textures
  39311. */
  39312. getLoadedTexturesCache(): InternalTexture[];
  39313. /**
  39314. * Gets the object containing all engine capabilities
  39315. * @returns the EngineCapabilities object
  39316. */
  39317. getCaps(): EngineCapabilities;
  39318. /**
  39319. * stop executing a render loop function and remove it from the execution array
  39320. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  39321. */
  39322. stopRenderLoop(renderFunction?: () => void): void;
  39323. /** @hidden */
  39324. _renderLoop(): void;
  39325. /**
  39326. * Gets the HTML canvas attached with the current webGL context
  39327. * @returns a HTML canvas
  39328. */
  39329. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  39330. /**
  39331. * Gets host window
  39332. * @returns the host window object
  39333. */
  39334. getHostWindow(): Nullable<Window>;
  39335. /**
  39336. * Gets the current render width
  39337. * @param useScreen defines if screen size must be used (or the current render target if any)
  39338. * @returns a number defining the current render width
  39339. */
  39340. getRenderWidth(useScreen?: boolean): number;
  39341. /**
  39342. * Gets the current render height
  39343. * @param useScreen defines if screen size must be used (or the current render target if any)
  39344. * @returns a number defining the current render height
  39345. */
  39346. getRenderHeight(useScreen?: boolean): number;
  39347. /**
  39348. * Can be used to override the current requestAnimationFrame requester.
  39349. * @hidden
  39350. */
  39351. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  39352. /**
  39353. * Register and execute a render loop. The engine can have more than one render function
  39354. * @param renderFunction defines the function to continuously execute
  39355. */
  39356. runRenderLoop(renderFunction: () => void): void;
  39357. /**
  39358. * Clear the current render buffer or the current render target (if any is set up)
  39359. * @param color defines the color to use
  39360. * @param backBuffer defines if the back buffer must be cleared
  39361. * @param depth defines if the depth buffer must be cleared
  39362. * @param stencil defines if the stencil buffer must be cleared
  39363. */
  39364. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  39365. private _viewportCached;
  39366. /** @hidden */
  39367. _viewport(x: number, y: number, width: number, height: number): void;
  39368. /**
  39369. * Set the WebGL's viewport
  39370. * @param viewport defines the viewport element to be used
  39371. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  39372. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  39373. */
  39374. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  39375. /**
  39376. * Begin a new frame
  39377. */
  39378. beginFrame(): void;
  39379. /**
  39380. * Enf the current frame
  39381. */
  39382. endFrame(): void;
  39383. /**
  39384. * Resize the view according to the canvas' size
  39385. */
  39386. resize(): void;
  39387. /**
  39388. * Force a specific size of the canvas
  39389. * @param width defines the new canvas' width
  39390. * @param height defines the new canvas' height
  39391. * @returns true if the size was changed
  39392. */
  39393. setSize(width: number, height: number): boolean;
  39394. /**
  39395. * Binds the frame buffer to the specified texture.
  39396. * @param texture The texture to render to or null for the default canvas
  39397. * @param faceIndex The face of the texture to render to in case of cube texture
  39398. * @param requiredWidth The width of the target to render to
  39399. * @param requiredHeight The height of the target to render to
  39400. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  39401. * @param lodLevel defines the lod level to bind to the frame buffer
  39402. * @param layer defines the 2d array index to bind to frame buffer to
  39403. */
  39404. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  39405. /** @hidden */
  39406. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  39407. /**
  39408. * Unbind the current render target texture from the webGL context
  39409. * @param texture defines the render target texture to unbind
  39410. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  39411. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  39412. */
  39413. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  39414. /**
  39415. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  39416. */
  39417. flushFramebuffer(): void;
  39418. /**
  39419. * Unbind the current render target and bind the default framebuffer
  39420. */
  39421. restoreDefaultFramebuffer(): void;
  39422. /** @hidden */
  39423. protected _resetVertexBufferBinding(): void;
  39424. /**
  39425. * Creates a vertex buffer
  39426. * @param data the data for the vertex buffer
  39427. * @returns the new WebGL static buffer
  39428. */
  39429. createVertexBuffer(data: DataArray): DataBuffer;
  39430. private _createVertexBuffer;
  39431. /**
  39432. * Creates a dynamic vertex buffer
  39433. * @param data the data for the dynamic vertex buffer
  39434. * @returns the new WebGL dynamic buffer
  39435. */
  39436. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  39437. protected _resetIndexBufferBinding(): void;
  39438. /**
  39439. * Creates a new index buffer
  39440. * @param indices defines the content of the index buffer
  39441. * @param updatable defines if the index buffer must be updatable
  39442. * @returns a new webGL buffer
  39443. */
  39444. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  39445. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  39446. /**
  39447. * Bind a webGL buffer to the webGL context
  39448. * @param buffer defines the buffer to bind
  39449. */
  39450. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  39451. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  39452. private bindBuffer;
  39453. /**
  39454. * update the bound buffer with the given data
  39455. * @param data defines the data to update
  39456. */
  39457. updateArrayBuffer(data: Float32Array): void;
  39458. private _vertexAttribPointer;
  39459. /** @hidden */
  39460. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  39461. private _bindVertexBuffersAttributes;
  39462. /**
  39463. * Records a vertex array object
  39464. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  39465. * @param vertexBuffers defines the list of vertex buffers to store
  39466. * @param indexBuffer defines the index buffer to store
  39467. * @param effect defines the effect to store
  39468. * @returns the new vertex array object
  39469. */
  39470. recordVertexArrayObject(vertexBuffers: {
  39471. [key: string]: VertexBuffer;
  39472. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  39473. /**
  39474. * Bind a specific vertex array object
  39475. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  39476. * @param vertexArrayObject defines the vertex array object to bind
  39477. * @param indexBuffer defines the index buffer to bind
  39478. */
  39479. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  39480. /**
  39481. * Bind webGl buffers directly to the webGL context
  39482. * @param vertexBuffer defines the vertex buffer to bind
  39483. * @param indexBuffer defines the index buffer to bind
  39484. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  39485. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  39486. * @param effect defines the effect associated with the vertex buffer
  39487. */
  39488. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  39489. private _unbindVertexArrayObject;
  39490. /**
  39491. * Bind a list of vertex buffers to the webGL context
  39492. * @param vertexBuffers defines the list of vertex buffers to bind
  39493. * @param indexBuffer defines the index buffer to bind
  39494. * @param effect defines the effect associated with the vertex buffers
  39495. */
  39496. bindBuffers(vertexBuffers: {
  39497. [key: string]: Nullable<VertexBuffer>;
  39498. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  39499. /**
  39500. * Unbind all instance attributes
  39501. */
  39502. unbindInstanceAttributes(): void;
  39503. /**
  39504. * Release and free the memory of a vertex array object
  39505. * @param vao defines the vertex array object to delete
  39506. */
  39507. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  39508. /** @hidden */
  39509. _releaseBuffer(buffer: DataBuffer): boolean;
  39510. protected _deleteBuffer(buffer: DataBuffer): void;
  39511. /**
  39512. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  39513. * @param instancesBuffer defines the webGL buffer to update and bind
  39514. * @param data defines the data to store in the buffer
  39515. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  39516. */
  39517. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  39518. /**
  39519. * Bind the content of a webGL buffer used with instantiation
  39520. * @param instancesBuffer defines the webGL buffer to bind
  39521. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  39522. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  39523. */
  39524. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  39525. /**
  39526. * Disable the instance attribute corresponding to the name in parameter
  39527. * @param name defines the name of the attribute to disable
  39528. */
  39529. disableInstanceAttributeByName(name: string): void;
  39530. /**
  39531. * Disable the instance attribute corresponding to the location in parameter
  39532. * @param attributeLocation defines the attribute location of the attribute to disable
  39533. */
  39534. disableInstanceAttribute(attributeLocation: number): void;
  39535. /**
  39536. * Disable the attribute corresponding to the location in parameter
  39537. * @param attributeLocation defines the attribute location of the attribute to disable
  39538. */
  39539. disableAttributeByIndex(attributeLocation: number): void;
  39540. /**
  39541. * Send a draw order
  39542. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  39543. * @param indexStart defines the starting index
  39544. * @param indexCount defines the number of index to draw
  39545. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  39546. */
  39547. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  39548. /**
  39549. * Draw a list of points
  39550. * @param verticesStart defines the index of first vertex to draw
  39551. * @param verticesCount defines the count of vertices to draw
  39552. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  39553. */
  39554. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  39555. /**
  39556. * Draw a list of unindexed primitives
  39557. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  39558. * @param verticesStart defines the index of first vertex to draw
  39559. * @param verticesCount defines the count of vertices to draw
  39560. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  39561. */
  39562. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  39563. /**
  39564. * Draw a list of indexed primitives
  39565. * @param fillMode defines the primitive to use
  39566. * @param indexStart defines the starting index
  39567. * @param indexCount defines the number of index to draw
  39568. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  39569. */
  39570. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  39571. /**
  39572. * Draw a list of unindexed primitives
  39573. * @param fillMode defines the primitive to use
  39574. * @param verticesStart defines the index of first vertex to draw
  39575. * @param verticesCount defines the count of vertices to draw
  39576. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  39577. */
  39578. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  39579. private _drawMode;
  39580. /** @hidden */
  39581. protected _reportDrawCall(): void;
  39582. /** @hidden */
  39583. _releaseEffect(effect: Effect): void;
  39584. /** @hidden */
  39585. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  39586. /**
  39587. * Create a new effect (used to store vertex/fragment shaders)
  39588. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  39589. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  39590. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  39591. * @param samplers defines an array of string used to represent textures
  39592. * @param defines defines the string containing the defines to use to compile the shaders
  39593. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  39594. * @param onCompiled defines a function to call when the effect creation is successful
  39595. * @param onError defines a function to call when the effect creation has failed
  39596. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  39597. * @returns the new Effect
  39598. */
  39599. createEffect(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: string[], defines?: string, fallbacks?: IEffectFallbacks, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any): Effect;
  39600. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  39601. private _compileShader;
  39602. private _compileRawShader;
  39603. /** @hidden */
  39604. _getShaderSource(shader: WebGLShader): Nullable<string>;
  39605. /**
  39606. * Directly creates a webGL program
  39607. * @param pipelineContext defines the pipeline context to attach to
  39608. * @param vertexCode defines the vertex shader code to use
  39609. * @param fragmentCode defines the fragment shader code to use
  39610. * @param context defines the webGL context to use (if not set, the current one will be used)
  39611. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  39612. * @returns the new webGL program
  39613. */
  39614. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39615. /**
  39616. * Creates a webGL program
  39617. * @param pipelineContext defines the pipeline context to attach to
  39618. * @param vertexCode defines the vertex shader code to use
  39619. * @param fragmentCode defines the fragment shader code to use
  39620. * @param defines defines the string containing the defines to use to compile the shaders
  39621. * @param context defines the webGL context to use (if not set, the current one will be used)
  39622. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  39623. * @returns the new webGL program
  39624. */
  39625. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39626. /**
  39627. * Creates a new pipeline context
  39628. * @returns the new pipeline
  39629. */
  39630. createPipelineContext(): IPipelineContext;
  39631. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39632. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  39633. /** @hidden */
  39634. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  39635. /** @hidden */
  39636. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  39637. /** @hidden */
  39638. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  39639. /**
  39640. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  39641. * @param pipelineContext defines the pipeline context to use
  39642. * @param uniformsNames defines the list of uniform names
  39643. * @returns an array of webGL uniform locations
  39644. */
  39645. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  39646. /**
  39647. * Gets the lsit of active attributes for a given webGL program
  39648. * @param pipelineContext defines the pipeline context to use
  39649. * @param attributesNames defines the list of attribute names to get
  39650. * @returns an array of indices indicating the offset of each attribute
  39651. */
  39652. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  39653. /**
  39654. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  39655. * @param effect defines the effect to activate
  39656. */
  39657. enableEffect(effect: Nullable<Effect>): void;
  39658. /**
  39659. * Set the value of an uniform to a number (int)
  39660. * @param uniform defines the webGL uniform location where to store the value
  39661. * @param value defines the int number to store
  39662. * @returns true if the value was set
  39663. */
  39664. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): boolean;
  39665. /**
  39666. * Set the value of an uniform to an array of int32
  39667. * @param uniform defines the webGL uniform location where to store the value
  39668. * @param array defines the array of int32 to store
  39669. * @returns true if the value was set
  39670. */
  39671. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  39672. /**
  39673. * Set the value of an uniform to an array of int32 (stored as vec2)
  39674. * @param uniform defines the webGL uniform location where to store the value
  39675. * @param array defines the array of int32 to store
  39676. * @returns true if the value was set
  39677. */
  39678. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  39679. /**
  39680. * Set the value of an uniform to an array of int32 (stored as vec3)
  39681. * @param uniform defines the webGL uniform location where to store the value
  39682. * @param array defines the array of int32 to store
  39683. * @returns true if the value was set
  39684. */
  39685. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  39686. /**
  39687. * Set the value of an uniform to an array of int32 (stored as vec4)
  39688. * @param uniform defines the webGL uniform location where to store the value
  39689. * @param array defines the array of int32 to store
  39690. * @returns true if the value was set
  39691. */
  39692. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): boolean;
  39693. /**
  39694. * Set the value of an uniform to an array of number
  39695. * @param uniform defines the webGL uniform location where to store the value
  39696. * @param array defines the array of number to store
  39697. * @returns true if the value was set
  39698. */
  39699. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  39700. /**
  39701. * Set the value of an uniform to an array of number (stored as vec2)
  39702. * @param uniform defines the webGL uniform location where to store the value
  39703. * @param array defines the array of number to store
  39704. * @returns true if the value was set
  39705. */
  39706. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  39707. /**
  39708. * Set the value of an uniform to an array of number (stored as vec3)
  39709. * @param uniform defines the webGL uniform location where to store the value
  39710. * @param array defines the array of number to store
  39711. * @returns true if the value was set
  39712. */
  39713. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  39714. /**
  39715. * Set the value of an uniform to an array of number (stored as vec4)
  39716. * @param uniform defines the webGL uniform location where to store the value
  39717. * @param array defines the array of number to store
  39718. * @returns true if the value was set
  39719. */
  39720. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): boolean;
  39721. /**
  39722. * Set the value of an uniform to an array of float32 (stored as matrices)
  39723. * @param uniform defines the webGL uniform location where to store the value
  39724. * @param matrices defines the array of float32 to store
  39725. * @returns true if the value was set
  39726. */
  39727. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): boolean;
  39728. /**
  39729. * Set the value of an uniform to a matrix (3x3)
  39730. * @param uniform defines the webGL uniform location where to store the value
  39731. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  39732. * @returns true if the value was set
  39733. */
  39734. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): boolean;
  39735. /**
  39736. * Set the value of an uniform to a matrix (2x2)
  39737. * @param uniform defines the webGL uniform location where to store the value
  39738. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  39739. * @returns true if the value was set
  39740. */
  39741. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): boolean;
  39742. /**
  39743. * Set the value of an uniform to a number (float)
  39744. * @param uniform defines the webGL uniform location where to store the value
  39745. * @param value defines the float number to store
  39746. * @returns true if the value was transfered
  39747. */
  39748. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): boolean;
  39749. /**
  39750. * Set the value of an uniform to a vec2
  39751. * @param uniform defines the webGL uniform location where to store the value
  39752. * @param x defines the 1st component of the value
  39753. * @param y defines the 2nd component of the value
  39754. * @returns true if the value was set
  39755. */
  39756. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): boolean;
  39757. /**
  39758. * Set the value of an uniform to a vec3
  39759. * @param uniform defines the webGL uniform location where to store the value
  39760. * @param x defines the 1st component of the value
  39761. * @param y defines the 2nd component of the value
  39762. * @param z defines the 3rd component of the value
  39763. * @returns true if the value was set
  39764. */
  39765. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): boolean;
  39766. /**
  39767. * Set the value of an uniform to a vec4
  39768. * @param uniform defines the webGL uniform location where to store the value
  39769. * @param x defines the 1st component of the value
  39770. * @param y defines the 2nd component of the value
  39771. * @param z defines the 3rd component of the value
  39772. * @param w defines the 4th component of the value
  39773. * @returns true if the value was set
  39774. */
  39775. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): boolean;
  39776. /**
  39777. * Apply all cached states (depth, culling, stencil and alpha)
  39778. */
  39779. applyStates(): void;
  39780. /**
  39781. * Enable or disable color writing
  39782. * @param enable defines the state to set
  39783. */
  39784. setColorWrite(enable: boolean): void;
  39785. /**
  39786. * Gets a boolean indicating if color writing is enabled
  39787. * @returns the current color writing state
  39788. */
  39789. getColorWrite(): boolean;
  39790. /**
  39791. * Gets the depth culling state manager
  39792. */
  39793. get depthCullingState(): DepthCullingState;
  39794. /**
  39795. * Gets the alpha state manager
  39796. */
  39797. get alphaState(): AlphaState;
  39798. /**
  39799. * Gets the stencil state manager
  39800. */
  39801. get stencilState(): StencilState;
  39802. /**
  39803. * Clears the list of texture accessible through engine.
  39804. * This can help preventing texture load conflict due to name collision.
  39805. */
  39806. clearInternalTexturesCache(): void;
  39807. /**
  39808. * Force the entire cache to be cleared
  39809. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  39810. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  39811. */
  39812. wipeCaches(bruteForce?: boolean): void;
  39813. /** @hidden */
  39814. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  39815. min: number;
  39816. mag: number;
  39817. };
  39818. /** @hidden */
  39819. _createTexture(): WebGLTexture;
  39820. /**
  39821. * Usually called from Texture.ts.
  39822. * Passed information to create a WebGLTexture
  39823. * @param url defines a value which contains one of the following:
  39824. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  39825. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  39826. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  39827. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  39828. * @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)
  39829. * @param scene needed for loading to the correct scene
  39830. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  39831. * @param onLoad optional callback to be called upon successful completion
  39832. * @param onError optional callback to be called upon failure
  39833. * @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
  39834. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  39835. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  39836. * @param forcedExtension defines the extension to use to pick the right loader
  39837. * @param mimeType defines an optional mime type
  39838. * @param loaderOptions options to be passed to the loader
  39839. * @returns a InternalTexture for assignment back into BABYLON.Texture
  39840. */
  39841. createTexture(url: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, mimeType?: string, loaderOptions?: any): InternalTexture;
  39842. /**
  39843. * Loads an image as an HTMLImageElement.
  39844. * @param input url string, ArrayBuffer, or Blob to load
  39845. * @param onLoad callback called when the image successfully loads
  39846. * @param onError callback called when the image fails to load
  39847. * @param offlineProvider offline provider for caching
  39848. * @param mimeType optional mime type
  39849. * @returns the HTMLImageElement of the loaded image
  39850. * @hidden
  39851. */
  39852. static _FileToolsLoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  39853. /**
  39854. * @hidden
  39855. */
  39856. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  39857. private _unpackFlipYCached;
  39858. /**
  39859. * In case you are sharing the context with other applications, it might
  39860. * be interested to not cache the unpack flip y state to ensure a consistent
  39861. * value would be set.
  39862. */
  39863. enableUnpackFlipYCached: boolean;
  39864. /** @hidden */
  39865. _unpackFlipY(value: boolean): void;
  39866. /** @hidden */
  39867. _getUnpackAlignement(): number;
  39868. private _getTextureTarget;
  39869. /**
  39870. * Update the sampling mode of a given texture
  39871. * @param samplingMode defines the required sampling mode
  39872. * @param texture defines the texture to update
  39873. * @param generateMipMaps defines whether to generate mipmaps for the texture
  39874. */
  39875. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  39876. /**
  39877. * Update the sampling mode of a given texture
  39878. * @param texture defines the texture to update
  39879. * @param wrapU defines the texture wrap mode of the u coordinates
  39880. * @param wrapV defines the texture wrap mode of the v coordinates
  39881. * @param wrapR defines the texture wrap mode of the r coordinates
  39882. */
  39883. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  39884. /** @hidden */
  39885. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  39886. width: number;
  39887. height: number;
  39888. layers?: number;
  39889. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  39890. /** @hidden */
  39891. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  39892. /** @hidden */
  39893. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  39894. /**
  39895. * Update a portion of an internal texture
  39896. * @param texture defines the texture to update
  39897. * @param imageData defines the data to store into the texture
  39898. * @param xOffset defines the x coordinates of the update rectangle
  39899. * @param yOffset defines the y coordinates of the update rectangle
  39900. * @param width defines the width of the update rectangle
  39901. * @param height defines the height of the update rectangle
  39902. * @param faceIndex defines the face index if texture is a cube (0 by default)
  39903. * @param lod defines the lod level to update (0 by default)
  39904. */
  39905. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  39906. /** @hidden */
  39907. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  39908. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  39909. private _prepareWebGLTexture;
  39910. /** @hidden */
  39911. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  39912. private _getDepthStencilBuffer;
  39913. /** @hidden */
  39914. _releaseFramebufferObjects(texture: InternalTexture): void;
  39915. /** @hidden */
  39916. _releaseTexture(texture: InternalTexture): void;
  39917. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  39918. protected _setProgram(program: WebGLProgram): void;
  39919. protected _boundUniforms: {
  39920. [key: number]: WebGLUniformLocation;
  39921. };
  39922. /**
  39923. * Binds an effect to the webGL context
  39924. * @param effect defines the effect to bind
  39925. */
  39926. bindSamplers(effect: Effect): void;
  39927. private _activateCurrentTexture;
  39928. /** @hidden */
  39929. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  39930. /** @hidden */
  39931. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  39932. /**
  39933. * Unbind all textures from the webGL context
  39934. */
  39935. unbindAllTextures(): void;
  39936. /**
  39937. * Sets a texture to the according uniform.
  39938. * @param channel The texture channel
  39939. * @param uniform The uniform to set
  39940. * @param texture The texture to apply
  39941. */
  39942. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<ThinTexture>): void;
  39943. private _bindSamplerUniformToChannel;
  39944. private _getTextureWrapMode;
  39945. protected _setTexture(channel: number, texture: Nullable<ThinTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  39946. /**
  39947. * Sets an array of texture to the webGL context
  39948. * @param channel defines the channel where the texture array must be set
  39949. * @param uniform defines the associated uniform location
  39950. * @param textures defines the array of textures to bind
  39951. */
  39952. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: ThinTexture[]): void;
  39953. /** @hidden */
  39954. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  39955. private _setTextureParameterFloat;
  39956. private _setTextureParameterInteger;
  39957. /**
  39958. * Unbind all vertex attributes from the webGL context
  39959. */
  39960. unbindAllAttributes(): void;
  39961. /**
  39962. * 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
  39963. */
  39964. releaseEffects(): void;
  39965. /**
  39966. * Dispose and release all associated resources
  39967. */
  39968. dispose(): void;
  39969. /**
  39970. * Attach a new callback raised when context lost event is fired
  39971. * @param callback defines the callback to call
  39972. */
  39973. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  39974. /**
  39975. * Attach a new callback raised when context restored event is fired
  39976. * @param callback defines the callback to call
  39977. */
  39978. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  39979. /**
  39980. * Get the current error code of the webGL context
  39981. * @returns the error code
  39982. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  39983. */
  39984. getError(): number;
  39985. private _canRenderToFloatFramebuffer;
  39986. private _canRenderToHalfFloatFramebuffer;
  39987. private _canRenderToFramebuffer;
  39988. /** @hidden */
  39989. _getWebGLTextureType(type: number): number;
  39990. /** @hidden */
  39991. _getInternalFormat(format: number): number;
  39992. /** @hidden */
  39993. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  39994. /** @hidden */
  39995. _getRGBAMultiSampleBufferFormat(type: number): number;
  39996. /** @hidden */
  39997. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: IWebRequest, exception?: any) => void): IFileRequest;
  39998. /**
  39999. * Loads a file from a url
  40000. * @param url url to load
  40001. * @param onSuccess callback called when the file successfully loads
  40002. * @param onProgress callback called while file is loading (if the server supports this mode)
  40003. * @param offlineProvider defines the offline provider for caching
  40004. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  40005. * @param onError callback called when the file fails to load
  40006. * @returns a file request object
  40007. * @hidden
  40008. */
  40009. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  40010. /**
  40011. * Reads pixels from the current frame buffer. Please note that this function can be slow
  40012. * @param x defines the x coordinate of the rectangle where pixels must be read
  40013. * @param y defines the y coordinate of the rectangle where pixels must be read
  40014. * @param width defines the width of the rectangle where pixels must be read
  40015. * @param height defines the height of the rectangle where pixels must be read
  40016. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  40017. * @returns a Uint8Array containing RGBA colors
  40018. */
  40019. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  40020. private static _IsSupported;
  40021. private static _HasMajorPerformanceCaveat;
  40022. /**
  40023. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  40024. */
  40025. static get IsSupported(): boolean;
  40026. /**
  40027. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  40028. * @returns true if the engine can be created
  40029. * @ignorenaming
  40030. */
  40031. static isSupported(): boolean;
  40032. /**
  40033. * Gets a boolean indicating if the engine can be instanciated on a performant device (ie. if a webGL context can be found and it does not use a slow implementation)
  40034. */
  40035. static get HasMajorPerformanceCaveat(): boolean;
  40036. /**
  40037. * Find the next highest power of two.
  40038. * @param x Number to start search from.
  40039. * @return Next highest power of two.
  40040. */
  40041. static CeilingPOT(x: number): number;
  40042. /**
  40043. * Find the next lowest power of two.
  40044. * @param x Number to start search from.
  40045. * @return Next lowest power of two.
  40046. */
  40047. static FloorPOT(x: number): number;
  40048. /**
  40049. * Find the nearest power of two.
  40050. * @param x Number to start search from.
  40051. * @return Next nearest power of two.
  40052. */
  40053. static NearestPOT(x: number): number;
  40054. /**
  40055. * Get the closest exponent of two
  40056. * @param value defines the value to approximate
  40057. * @param max defines the maximum value to return
  40058. * @param mode defines how to define the closest value
  40059. * @returns closest exponent of two of the given value
  40060. */
  40061. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  40062. /**
  40063. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  40064. * @param func - the function to be called
  40065. * @param requester - the object that will request the next frame. Falls back to window.
  40066. * @returns frame number
  40067. */
  40068. static QueueNewFrame(func: () => void, requester?: any): number;
  40069. /**
  40070. * Gets host document
  40071. * @returns the host document object
  40072. */
  40073. getHostDocument(): Nullable<Document>;
  40074. }
  40075. }
  40076. declare module BABYLON {
  40077. /**
  40078. * Defines the source of the internal texture
  40079. */
  40080. export enum InternalTextureSource {
  40081. /**
  40082. * The source of the texture data is unknown
  40083. */
  40084. Unknown = 0,
  40085. /**
  40086. * Texture data comes from an URL
  40087. */
  40088. Url = 1,
  40089. /**
  40090. * Texture data is only used for temporary storage
  40091. */
  40092. Temp = 2,
  40093. /**
  40094. * Texture data comes from raw data (ArrayBuffer)
  40095. */
  40096. Raw = 3,
  40097. /**
  40098. * Texture content is dynamic (video or dynamic texture)
  40099. */
  40100. Dynamic = 4,
  40101. /**
  40102. * Texture content is generated by rendering to it
  40103. */
  40104. RenderTarget = 5,
  40105. /**
  40106. * Texture content is part of a multi render target process
  40107. */
  40108. MultiRenderTarget = 6,
  40109. /**
  40110. * Texture data comes from a cube data file
  40111. */
  40112. Cube = 7,
  40113. /**
  40114. * Texture data comes from a raw cube data
  40115. */
  40116. CubeRaw = 8,
  40117. /**
  40118. * Texture data come from a prefiltered cube data file
  40119. */
  40120. CubePrefiltered = 9,
  40121. /**
  40122. * Texture content is raw 3D data
  40123. */
  40124. Raw3D = 10,
  40125. /**
  40126. * Texture content is raw 2D array data
  40127. */
  40128. Raw2DArray = 11,
  40129. /**
  40130. * Texture content is a depth texture
  40131. */
  40132. Depth = 12,
  40133. /**
  40134. * Texture data comes from a raw cube data encoded with RGBD
  40135. */
  40136. CubeRawRGBD = 13
  40137. }
  40138. /**
  40139. * Class used to store data associated with WebGL texture data for the engine
  40140. * This class should not be used directly
  40141. */
  40142. export class InternalTexture {
  40143. /** @hidden */
  40144. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  40145. /**
  40146. * Defines if the texture is ready
  40147. */
  40148. isReady: boolean;
  40149. /**
  40150. * Defines if the texture is a cube texture
  40151. */
  40152. isCube: boolean;
  40153. /**
  40154. * Defines if the texture contains 3D data
  40155. */
  40156. is3D: boolean;
  40157. /**
  40158. * Defines if the texture contains 2D array data
  40159. */
  40160. is2DArray: boolean;
  40161. /**
  40162. * Defines if the texture contains multiview data
  40163. */
  40164. isMultiview: boolean;
  40165. /**
  40166. * Gets the URL used to load this texture
  40167. */
  40168. url: string;
  40169. /** @hidden */
  40170. _originalUrl: string;
  40171. /**
  40172. * Gets the sampling mode of the texture
  40173. */
  40174. samplingMode: number;
  40175. /**
  40176. * Gets a boolean indicating if the texture needs mipmaps generation
  40177. */
  40178. generateMipMaps: boolean;
  40179. /**
  40180. * Gets the number of samples used by the texture (WebGL2+ only)
  40181. */
  40182. samples: number;
  40183. /**
  40184. * Gets the type of the texture (int, float...)
  40185. */
  40186. type: number;
  40187. /**
  40188. * Gets the format of the texture (RGB, RGBA...)
  40189. */
  40190. format: number;
  40191. /**
  40192. * Observable called when the texture is loaded
  40193. */
  40194. onLoadedObservable: Observable<InternalTexture>;
  40195. /**
  40196. * Gets the width of the texture
  40197. */
  40198. width: number;
  40199. /**
  40200. * Gets the height of the texture
  40201. */
  40202. height: number;
  40203. /**
  40204. * Gets the depth of the texture
  40205. */
  40206. depth: number;
  40207. /**
  40208. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  40209. */
  40210. baseWidth: number;
  40211. /**
  40212. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  40213. */
  40214. baseHeight: number;
  40215. /**
  40216. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  40217. */
  40218. baseDepth: number;
  40219. /**
  40220. * Gets a boolean indicating if the texture is inverted on Y axis
  40221. */
  40222. invertY: boolean;
  40223. /** @hidden */
  40224. _invertVScale: boolean;
  40225. /** @hidden */
  40226. _associatedChannel: number;
  40227. /** @hidden */
  40228. _source: InternalTextureSource;
  40229. /** @hidden */
  40230. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  40231. /** @hidden */
  40232. _bufferView: Nullable<ArrayBufferView>;
  40233. /** @hidden */
  40234. _bufferViewArray: Nullable<ArrayBufferView[]>;
  40235. /** @hidden */
  40236. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  40237. /** @hidden */
  40238. _size: number;
  40239. /** @hidden */
  40240. _extension: string;
  40241. /** @hidden */
  40242. _files: Nullable<string[]>;
  40243. /** @hidden */
  40244. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  40245. /** @hidden */
  40246. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  40247. /** @hidden */
  40248. _framebuffer: Nullable<WebGLFramebuffer>;
  40249. /** @hidden */
  40250. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  40251. /** @hidden */
  40252. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  40253. /** @hidden */
  40254. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  40255. /** @hidden */
  40256. _attachments: Nullable<number[]>;
  40257. /** @hidden */
  40258. _textureArray: Nullable<InternalTexture[]>;
  40259. /** @hidden */
  40260. _cachedCoordinatesMode: Nullable<number>;
  40261. /** @hidden */
  40262. _cachedWrapU: Nullable<number>;
  40263. /** @hidden */
  40264. _cachedWrapV: Nullable<number>;
  40265. /** @hidden */
  40266. _cachedWrapR: Nullable<number>;
  40267. /** @hidden */
  40268. _cachedAnisotropicFilteringLevel: Nullable<number>;
  40269. /** @hidden */
  40270. _isDisabled: boolean;
  40271. /** @hidden */
  40272. _compression: Nullable<string>;
  40273. /** @hidden */
  40274. _generateStencilBuffer: boolean;
  40275. /** @hidden */
  40276. _generateDepthBuffer: boolean;
  40277. /** @hidden */
  40278. _comparisonFunction: number;
  40279. /** @hidden */
  40280. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  40281. /** @hidden */
  40282. _lodGenerationScale: number;
  40283. /** @hidden */
  40284. _lodGenerationOffset: number;
  40285. /** @hidden */
  40286. _depthStencilTexture: Nullable<InternalTexture>;
  40287. /** @hidden */
  40288. _colorTextureArray: Nullable<WebGLTexture>;
  40289. /** @hidden */
  40290. _depthStencilTextureArray: Nullable<WebGLTexture>;
  40291. /** @hidden */
  40292. _lodTextureHigh: Nullable<BaseTexture>;
  40293. /** @hidden */
  40294. _lodTextureMid: Nullable<BaseTexture>;
  40295. /** @hidden */
  40296. _lodTextureLow: Nullable<BaseTexture>;
  40297. /** @hidden */
  40298. _isRGBD: boolean;
  40299. /** @hidden */
  40300. _linearSpecularLOD: boolean;
  40301. /** @hidden */
  40302. _irradianceTexture: Nullable<BaseTexture>;
  40303. /** @hidden */
  40304. _webGLTexture: Nullable<WebGLTexture>;
  40305. /** @hidden */
  40306. _references: number;
  40307. /** @hidden */
  40308. _gammaSpace: Nullable<boolean>;
  40309. private _engine;
  40310. /**
  40311. * Gets the Engine the texture belongs to.
  40312. * @returns The babylon engine
  40313. */
  40314. getEngine(): ThinEngine;
  40315. /**
  40316. * Gets the data source type of the texture
  40317. */
  40318. get source(): InternalTextureSource;
  40319. /**
  40320. * Creates a new InternalTexture
  40321. * @param engine defines the engine to use
  40322. * @param source defines the type of data that will be used
  40323. * @param delayAllocation if the texture allocation should be delayed (default: false)
  40324. */
  40325. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  40326. /**
  40327. * Increments the number of references (ie. the number of Texture that point to it)
  40328. */
  40329. incrementReferences(): void;
  40330. /**
  40331. * Change the size of the texture (not the size of the content)
  40332. * @param width defines the new width
  40333. * @param height defines the new height
  40334. * @param depth defines the new depth (1 by default)
  40335. */
  40336. updateSize(width: int, height: int, depth?: int): void;
  40337. /** @hidden */
  40338. _rebuild(): void;
  40339. /** @hidden */
  40340. _swapAndDie(target: InternalTexture): void;
  40341. /**
  40342. * Dispose the current allocated resources
  40343. */
  40344. dispose(): void;
  40345. }
  40346. }
  40347. declare module BABYLON {
  40348. /**
  40349. * Interface used to present a loading screen while loading a scene
  40350. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  40351. */
  40352. export interface ILoadingScreen {
  40353. /**
  40354. * Function called to display the loading screen
  40355. */
  40356. displayLoadingUI: () => void;
  40357. /**
  40358. * Function called to hide the loading screen
  40359. */
  40360. hideLoadingUI: () => void;
  40361. /**
  40362. * Gets or sets the color to use for the background
  40363. */
  40364. loadingUIBackgroundColor: string;
  40365. /**
  40366. * Gets or sets the text to display while loading
  40367. */
  40368. loadingUIText: string;
  40369. }
  40370. /**
  40371. * Class used for the default loading screen
  40372. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  40373. */
  40374. export class DefaultLoadingScreen implements ILoadingScreen {
  40375. private _renderingCanvas;
  40376. private _loadingText;
  40377. private _loadingDivBackgroundColor;
  40378. private _loadingDiv;
  40379. private _loadingTextDiv;
  40380. /** Gets or sets the logo url to use for the default loading screen */
  40381. static DefaultLogoUrl: string;
  40382. /** Gets or sets the spinner url to use for the default loading screen */
  40383. static DefaultSpinnerUrl: string;
  40384. /**
  40385. * Creates a new default loading screen
  40386. * @param _renderingCanvas defines the canvas used to render the scene
  40387. * @param _loadingText defines the default text to display
  40388. * @param _loadingDivBackgroundColor defines the default background color
  40389. */
  40390. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  40391. /**
  40392. * Function called to display the loading screen
  40393. */
  40394. displayLoadingUI(): void;
  40395. /**
  40396. * Function called to hide the loading screen
  40397. */
  40398. hideLoadingUI(): void;
  40399. /**
  40400. * Gets or sets the text to display while loading
  40401. */
  40402. set loadingUIText(text: string);
  40403. get loadingUIText(): string;
  40404. /**
  40405. * Gets or sets the color to use for the background
  40406. */
  40407. get loadingUIBackgroundColor(): string;
  40408. set loadingUIBackgroundColor(color: string);
  40409. private _resizeLoadingUI;
  40410. }
  40411. }
  40412. declare module BABYLON {
  40413. /**
  40414. * Interface for any object that can request an animation frame
  40415. */
  40416. export interface ICustomAnimationFrameRequester {
  40417. /**
  40418. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  40419. */
  40420. renderFunction?: Function;
  40421. /**
  40422. * Called to request the next frame to render to
  40423. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  40424. */
  40425. requestAnimationFrame: Function;
  40426. /**
  40427. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  40428. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  40429. */
  40430. requestID?: number;
  40431. }
  40432. }
  40433. declare module BABYLON {
  40434. /**
  40435. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  40436. */
  40437. export class PerformanceMonitor {
  40438. private _enabled;
  40439. private _rollingFrameTime;
  40440. private _lastFrameTimeMs;
  40441. /**
  40442. * constructor
  40443. * @param frameSampleSize The number of samples required to saturate the sliding window
  40444. */
  40445. constructor(frameSampleSize?: number);
  40446. /**
  40447. * Samples current frame
  40448. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  40449. */
  40450. sampleFrame(timeMs?: number): void;
  40451. /**
  40452. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  40453. */
  40454. get averageFrameTime(): number;
  40455. /**
  40456. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  40457. */
  40458. get averageFrameTimeVariance(): number;
  40459. /**
  40460. * Returns the frame time of the most recent frame
  40461. */
  40462. get instantaneousFrameTime(): number;
  40463. /**
  40464. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  40465. */
  40466. get averageFPS(): number;
  40467. /**
  40468. * Returns the average framerate in frames per second using the most recent frame time
  40469. */
  40470. get instantaneousFPS(): number;
  40471. /**
  40472. * Returns true if enough samples have been taken to completely fill the sliding window
  40473. */
  40474. get isSaturated(): boolean;
  40475. /**
  40476. * Enables contributions to the sliding window sample set
  40477. */
  40478. enable(): void;
  40479. /**
  40480. * Disables contributions to the sliding window sample set
  40481. * Samples will not be interpolated over the disabled period
  40482. */
  40483. disable(): void;
  40484. /**
  40485. * Returns true if sampling is enabled
  40486. */
  40487. get isEnabled(): boolean;
  40488. /**
  40489. * Resets performance monitor
  40490. */
  40491. reset(): void;
  40492. }
  40493. /**
  40494. * RollingAverage
  40495. *
  40496. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  40497. */
  40498. export class RollingAverage {
  40499. /**
  40500. * Current average
  40501. */
  40502. average: number;
  40503. /**
  40504. * Current variance
  40505. */
  40506. variance: number;
  40507. protected _samples: Array<number>;
  40508. protected _sampleCount: number;
  40509. protected _pos: number;
  40510. protected _m2: number;
  40511. /**
  40512. * constructor
  40513. * @param length The number of samples required to saturate the sliding window
  40514. */
  40515. constructor(length: number);
  40516. /**
  40517. * Adds a sample to the sample set
  40518. * @param v The sample value
  40519. */
  40520. add(v: number): void;
  40521. /**
  40522. * Returns previously added values or null if outside of history or outside the sliding window domain
  40523. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  40524. * @return Value previously recorded with add() or null if outside of range
  40525. */
  40526. history(i: number): number;
  40527. /**
  40528. * Returns true if enough samples have been taken to completely fill the sliding window
  40529. * @return true if sample-set saturated
  40530. */
  40531. isSaturated(): boolean;
  40532. /**
  40533. * Resets the rolling average (equivalent to 0 samples taken so far)
  40534. */
  40535. reset(): void;
  40536. /**
  40537. * Wraps a value around the sample range boundaries
  40538. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  40539. * @return Wrapped position in sample range
  40540. */
  40541. protected _wrapPosition(i: number): number;
  40542. }
  40543. }
  40544. declare module BABYLON {
  40545. /**
  40546. * This class is used to track a performance counter which is number based.
  40547. * The user has access to many properties which give statistics of different nature.
  40548. *
  40549. * The implementer can track two kinds of Performance Counter: time and count.
  40550. * 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.
  40551. * 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.
  40552. */
  40553. export class PerfCounter {
  40554. /**
  40555. * Gets or sets a global boolean to turn on and off all the counters
  40556. */
  40557. static Enabled: boolean;
  40558. /**
  40559. * Returns the smallest value ever
  40560. */
  40561. get min(): number;
  40562. /**
  40563. * Returns the biggest value ever
  40564. */
  40565. get max(): number;
  40566. /**
  40567. * Returns the average value since the performance counter is running
  40568. */
  40569. get average(): number;
  40570. /**
  40571. * Returns the average value of the last second the counter was monitored
  40572. */
  40573. get lastSecAverage(): number;
  40574. /**
  40575. * Returns the current value
  40576. */
  40577. get current(): number;
  40578. /**
  40579. * Gets the accumulated total
  40580. */
  40581. get total(): number;
  40582. /**
  40583. * Gets the total value count
  40584. */
  40585. get count(): number;
  40586. /**
  40587. * Creates a new counter
  40588. */
  40589. constructor();
  40590. /**
  40591. * Call this method to start monitoring a new frame.
  40592. * 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.
  40593. */
  40594. fetchNewFrame(): void;
  40595. /**
  40596. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  40597. * @param newCount the count value to add to the monitored count
  40598. * @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.
  40599. */
  40600. addCount(newCount: number, fetchResult: boolean): void;
  40601. /**
  40602. * Start monitoring this performance counter
  40603. */
  40604. beginMonitoring(): void;
  40605. /**
  40606. * Compute the time lapsed since the previous beginMonitoring() call.
  40607. * @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
  40608. */
  40609. endMonitoring(newFrame?: boolean): void;
  40610. private _fetchResult;
  40611. private _startMonitoringTime;
  40612. private _min;
  40613. private _max;
  40614. private _average;
  40615. private _current;
  40616. private _totalValueCount;
  40617. private _totalAccumulated;
  40618. private _lastSecAverage;
  40619. private _lastSecAccumulated;
  40620. private _lastSecTime;
  40621. private _lastSecValueCount;
  40622. }
  40623. }
  40624. declare module BABYLON {
  40625. interface ThinEngine {
  40626. /** @hidden */
  40627. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  40628. }
  40629. }
  40630. declare module BABYLON {
  40631. /**
  40632. * Class used to work with sound analyzer using fast fourier transform (FFT)
  40633. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  40634. */
  40635. export class Analyser {
  40636. /**
  40637. * Gets or sets the smoothing
  40638. * @ignorenaming
  40639. */
  40640. SMOOTHING: number;
  40641. /**
  40642. * Gets or sets the FFT table size
  40643. * @ignorenaming
  40644. */
  40645. FFT_SIZE: number;
  40646. /**
  40647. * Gets or sets the bar graph amplitude
  40648. * @ignorenaming
  40649. */
  40650. BARGRAPHAMPLITUDE: number;
  40651. /**
  40652. * Gets or sets the position of the debug canvas
  40653. * @ignorenaming
  40654. */
  40655. DEBUGCANVASPOS: {
  40656. x: number;
  40657. y: number;
  40658. };
  40659. /**
  40660. * Gets or sets the debug canvas size
  40661. * @ignorenaming
  40662. */
  40663. DEBUGCANVASSIZE: {
  40664. width: number;
  40665. height: number;
  40666. };
  40667. private _byteFreqs;
  40668. private _byteTime;
  40669. private _floatFreqs;
  40670. private _webAudioAnalyser;
  40671. private _debugCanvas;
  40672. private _debugCanvasContext;
  40673. private _scene;
  40674. private _registerFunc;
  40675. private _audioEngine;
  40676. /**
  40677. * Creates a new analyser
  40678. * @param scene defines hosting scene
  40679. */
  40680. constructor(scene: Scene);
  40681. /**
  40682. * Get the number of data values you will have to play with for the visualization
  40683. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  40684. * @returns a number
  40685. */
  40686. getFrequencyBinCount(): number;
  40687. /**
  40688. * Gets the current frequency data as a byte array
  40689. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  40690. * @returns a Uint8Array
  40691. */
  40692. getByteFrequencyData(): Uint8Array;
  40693. /**
  40694. * Gets the current waveform as a byte array
  40695. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  40696. * @returns a Uint8Array
  40697. */
  40698. getByteTimeDomainData(): Uint8Array;
  40699. /**
  40700. * Gets the current frequency data as a float array
  40701. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  40702. * @returns a Float32Array
  40703. */
  40704. getFloatFrequencyData(): Float32Array;
  40705. /**
  40706. * Renders the debug canvas
  40707. */
  40708. drawDebugCanvas(): void;
  40709. /**
  40710. * Stops rendering the debug canvas and removes it
  40711. */
  40712. stopDebugCanvas(): void;
  40713. /**
  40714. * Connects two audio nodes
  40715. * @param inputAudioNode defines first node to connect
  40716. * @param outputAudioNode defines second node to connect
  40717. */
  40718. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  40719. /**
  40720. * Releases all associated resources
  40721. */
  40722. dispose(): void;
  40723. }
  40724. }
  40725. declare module BABYLON {
  40726. /**
  40727. * This represents an audio engine and it is responsible
  40728. * to play, synchronize and analyse sounds throughout the application.
  40729. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  40730. */
  40731. export interface IAudioEngine extends IDisposable {
  40732. /**
  40733. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  40734. */
  40735. readonly canUseWebAudio: boolean;
  40736. /**
  40737. * Gets the current AudioContext if available.
  40738. */
  40739. readonly audioContext: Nullable<AudioContext>;
  40740. /**
  40741. * The master gain node defines the global audio volume of your audio engine.
  40742. */
  40743. readonly masterGain: GainNode;
  40744. /**
  40745. * Gets whether or not mp3 are supported by your browser.
  40746. */
  40747. readonly isMP3supported: boolean;
  40748. /**
  40749. * Gets whether or not ogg are supported by your browser.
  40750. */
  40751. readonly isOGGsupported: boolean;
  40752. /**
  40753. * Defines if Babylon should emit a warning if WebAudio is not supported.
  40754. * @ignoreNaming
  40755. */
  40756. WarnedWebAudioUnsupported: boolean;
  40757. /**
  40758. * Defines if the audio engine relies on a custom unlocked button.
  40759. * In this case, the embedded button will not be displayed.
  40760. */
  40761. useCustomUnlockedButton: boolean;
  40762. /**
  40763. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  40764. */
  40765. readonly unlocked: boolean;
  40766. /**
  40767. * Event raised when audio has been unlocked on the browser.
  40768. */
  40769. onAudioUnlockedObservable: Observable<IAudioEngine>;
  40770. /**
  40771. * Event raised when audio has been locked on the browser.
  40772. */
  40773. onAudioLockedObservable: Observable<IAudioEngine>;
  40774. /**
  40775. * Flags the audio engine in Locked state.
  40776. * This happens due to new browser policies preventing audio to autoplay.
  40777. */
  40778. lock(): void;
  40779. /**
  40780. * Unlocks the audio engine once a user action has been done on the dom.
  40781. * This is helpful to resume play once browser policies have been satisfied.
  40782. */
  40783. unlock(): void;
  40784. /**
  40785. * Gets the global volume sets on the master gain.
  40786. * @returns the global volume if set or -1 otherwise
  40787. */
  40788. getGlobalVolume(): number;
  40789. /**
  40790. * Sets the global volume of your experience (sets on the master gain).
  40791. * @param newVolume Defines the new global volume of the application
  40792. */
  40793. setGlobalVolume(newVolume: number): void;
  40794. /**
  40795. * Connect the audio engine to an audio analyser allowing some amazing
  40796. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  40797. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  40798. * @param analyser The analyser to connect to the engine
  40799. */
  40800. connectToAnalyser(analyser: Analyser): void;
  40801. }
  40802. }
  40803. declare module BABYLON {
  40804. /**
  40805. * Defines the interface used by display changed events
  40806. */
  40807. export interface IDisplayChangedEventArgs {
  40808. /** Gets the vrDisplay object (if any) */
  40809. vrDisplay: Nullable<any>;
  40810. /** Gets a boolean indicating if webVR is supported */
  40811. vrSupported: boolean;
  40812. }
  40813. /**
  40814. * Defines the interface used by objects containing a viewport (like a camera)
  40815. */
  40816. interface IViewportOwnerLike {
  40817. /**
  40818. * Gets or sets the viewport
  40819. */
  40820. viewport: IViewportLike;
  40821. }
  40822. /**
  40823. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  40824. */
  40825. export class Engine extends ThinEngine {
  40826. /** Defines that alpha blending is disabled */
  40827. static readonly ALPHA_DISABLE: number;
  40828. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  40829. static readonly ALPHA_ADD: number;
  40830. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  40831. static readonly ALPHA_COMBINE: number;
  40832. /** Defines that alpha blending to DEST - SRC * DEST */
  40833. static readonly ALPHA_SUBTRACT: number;
  40834. /** Defines that alpha blending to SRC * DEST */
  40835. static readonly ALPHA_MULTIPLY: number;
  40836. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  40837. static readonly ALPHA_MAXIMIZED: number;
  40838. /** Defines that alpha blending to SRC + DEST */
  40839. static readonly ALPHA_ONEONE: number;
  40840. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  40841. static readonly ALPHA_PREMULTIPLIED: number;
  40842. /**
  40843. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  40844. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  40845. */
  40846. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  40847. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  40848. static readonly ALPHA_INTERPOLATE: number;
  40849. /**
  40850. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  40851. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  40852. */
  40853. static readonly ALPHA_SCREENMODE: number;
  40854. /** Defines that the ressource is not delayed*/
  40855. static readonly DELAYLOADSTATE_NONE: number;
  40856. /** Defines that the ressource was successfully delay loaded */
  40857. static readonly DELAYLOADSTATE_LOADED: number;
  40858. /** Defines that the ressource is currently delay loading */
  40859. static readonly DELAYLOADSTATE_LOADING: number;
  40860. /** Defines that the ressource is delayed and has not started loading */
  40861. static readonly DELAYLOADSTATE_NOTLOADED: number;
  40862. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  40863. static readonly NEVER: number;
  40864. /** 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 */
  40865. static readonly ALWAYS: number;
  40866. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  40867. static readonly LESS: number;
  40868. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  40869. static readonly EQUAL: number;
  40870. /** 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 */
  40871. static readonly LEQUAL: number;
  40872. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  40873. static readonly GREATER: number;
  40874. /** 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 */
  40875. static readonly GEQUAL: number;
  40876. /** 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 */
  40877. static readonly NOTEQUAL: number;
  40878. /** Passed to stencilOperation to specify that stencil value must be kept */
  40879. static readonly KEEP: number;
  40880. /** Passed to stencilOperation to specify that stencil value must be replaced */
  40881. static readonly REPLACE: number;
  40882. /** Passed to stencilOperation to specify that stencil value must be incremented */
  40883. static readonly INCR: number;
  40884. /** Passed to stencilOperation to specify that stencil value must be decremented */
  40885. static readonly DECR: number;
  40886. /** Passed to stencilOperation to specify that stencil value must be inverted */
  40887. static readonly INVERT: number;
  40888. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  40889. static readonly INCR_WRAP: number;
  40890. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  40891. static readonly DECR_WRAP: number;
  40892. /** Texture is not repeating outside of 0..1 UVs */
  40893. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  40894. /** Texture is repeating outside of 0..1 UVs */
  40895. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  40896. /** Texture is repeating and mirrored */
  40897. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  40898. /** ALPHA */
  40899. static readonly TEXTUREFORMAT_ALPHA: number;
  40900. /** LUMINANCE */
  40901. static readonly TEXTUREFORMAT_LUMINANCE: number;
  40902. /** LUMINANCE_ALPHA */
  40903. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  40904. /** RGB */
  40905. static readonly TEXTUREFORMAT_RGB: number;
  40906. /** RGBA */
  40907. static readonly TEXTUREFORMAT_RGBA: number;
  40908. /** RED */
  40909. static readonly TEXTUREFORMAT_RED: number;
  40910. /** RED (2nd reference) */
  40911. static readonly TEXTUREFORMAT_R: number;
  40912. /** RG */
  40913. static readonly TEXTUREFORMAT_RG: number;
  40914. /** RED_INTEGER */
  40915. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  40916. /** RED_INTEGER (2nd reference) */
  40917. static readonly TEXTUREFORMAT_R_INTEGER: number;
  40918. /** RG_INTEGER */
  40919. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  40920. /** RGB_INTEGER */
  40921. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  40922. /** RGBA_INTEGER */
  40923. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  40924. /** UNSIGNED_BYTE */
  40925. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  40926. /** UNSIGNED_BYTE (2nd reference) */
  40927. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  40928. /** FLOAT */
  40929. static readonly TEXTURETYPE_FLOAT: number;
  40930. /** HALF_FLOAT */
  40931. static readonly TEXTURETYPE_HALF_FLOAT: number;
  40932. /** BYTE */
  40933. static readonly TEXTURETYPE_BYTE: number;
  40934. /** SHORT */
  40935. static readonly TEXTURETYPE_SHORT: number;
  40936. /** UNSIGNED_SHORT */
  40937. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  40938. /** INT */
  40939. static readonly TEXTURETYPE_INT: number;
  40940. /** UNSIGNED_INT */
  40941. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  40942. /** UNSIGNED_SHORT_4_4_4_4 */
  40943. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  40944. /** UNSIGNED_SHORT_5_5_5_1 */
  40945. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  40946. /** UNSIGNED_SHORT_5_6_5 */
  40947. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  40948. /** UNSIGNED_INT_2_10_10_10_REV */
  40949. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  40950. /** UNSIGNED_INT_24_8 */
  40951. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  40952. /** UNSIGNED_INT_10F_11F_11F_REV */
  40953. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  40954. /** UNSIGNED_INT_5_9_9_9_REV */
  40955. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  40956. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  40957. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  40958. /** nearest is mag = nearest and min = nearest and mip = linear */
  40959. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  40960. /** Bilinear is mag = linear and min = linear and mip = nearest */
  40961. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  40962. /** Trilinear is mag = linear and min = linear and mip = linear */
  40963. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  40964. /** nearest is mag = nearest and min = nearest and mip = linear */
  40965. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  40966. /** Bilinear is mag = linear and min = linear and mip = nearest */
  40967. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  40968. /** Trilinear is mag = linear and min = linear and mip = linear */
  40969. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  40970. /** mag = nearest and min = nearest and mip = nearest */
  40971. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  40972. /** mag = nearest and min = linear and mip = nearest */
  40973. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  40974. /** mag = nearest and min = linear and mip = linear */
  40975. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  40976. /** mag = nearest and min = linear and mip = none */
  40977. static readonly TEXTURE_NEAREST_LINEAR: number;
  40978. /** mag = nearest and min = nearest and mip = none */
  40979. static readonly TEXTURE_NEAREST_NEAREST: number;
  40980. /** mag = linear and min = nearest and mip = nearest */
  40981. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  40982. /** mag = linear and min = nearest and mip = linear */
  40983. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  40984. /** mag = linear and min = linear and mip = none */
  40985. static readonly TEXTURE_LINEAR_LINEAR: number;
  40986. /** mag = linear and min = nearest and mip = none */
  40987. static readonly TEXTURE_LINEAR_NEAREST: number;
  40988. /** Explicit coordinates mode */
  40989. static readonly TEXTURE_EXPLICIT_MODE: number;
  40990. /** Spherical coordinates mode */
  40991. static readonly TEXTURE_SPHERICAL_MODE: number;
  40992. /** Planar coordinates mode */
  40993. static readonly TEXTURE_PLANAR_MODE: number;
  40994. /** Cubic coordinates mode */
  40995. static readonly TEXTURE_CUBIC_MODE: number;
  40996. /** Projection coordinates mode */
  40997. static readonly TEXTURE_PROJECTION_MODE: number;
  40998. /** Skybox coordinates mode */
  40999. static readonly TEXTURE_SKYBOX_MODE: number;
  41000. /** Inverse Cubic coordinates mode */
  41001. static readonly TEXTURE_INVCUBIC_MODE: number;
  41002. /** Equirectangular coordinates mode */
  41003. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  41004. /** Equirectangular Fixed coordinates mode */
  41005. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  41006. /** Equirectangular Fixed Mirrored coordinates mode */
  41007. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  41008. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  41009. static readonly SCALEMODE_FLOOR: number;
  41010. /** Defines that texture rescaling will look for the nearest power of 2 size */
  41011. static readonly SCALEMODE_NEAREST: number;
  41012. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  41013. static readonly SCALEMODE_CEILING: number;
  41014. /**
  41015. * Returns the current npm package of the sdk
  41016. */
  41017. static get NpmPackage(): string;
  41018. /**
  41019. * Returns the current version of the framework
  41020. */
  41021. static get Version(): string;
  41022. /** Gets the list of created engines */
  41023. static get Instances(): Engine[];
  41024. /**
  41025. * Gets the latest created engine
  41026. */
  41027. static get LastCreatedEngine(): Nullable<Engine>;
  41028. /**
  41029. * Gets the latest created scene
  41030. */
  41031. static get LastCreatedScene(): Nullable<Scene>;
  41032. /**
  41033. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  41034. * @param flag defines which part of the materials must be marked as dirty
  41035. * @param predicate defines a predicate used to filter which materials should be affected
  41036. */
  41037. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  41038. /**
  41039. * Method called to create the default loading screen.
  41040. * This can be overriden in your own app.
  41041. * @param canvas The rendering canvas element
  41042. * @returns The loading screen
  41043. */
  41044. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  41045. /**
  41046. * Method called to create the default rescale post process on each engine.
  41047. */
  41048. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  41049. /**
  41050. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  41051. **/
  41052. enableOfflineSupport: boolean;
  41053. /**
  41054. * 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)
  41055. **/
  41056. disableManifestCheck: boolean;
  41057. /**
  41058. * Gets the list of created scenes
  41059. */
  41060. scenes: Scene[];
  41061. /**
  41062. * Event raised when a new scene is created
  41063. */
  41064. onNewSceneAddedObservable: Observable<Scene>;
  41065. /**
  41066. * Gets the list of created postprocesses
  41067. */
  41068. postProcesses: PostProcess[];
  41069. /**
  41070. * Gets a boolean indicating if the pointer is currently locked
  41071. */
  41072. isPointerLock: boolean;
  41073. /**
  41074. * Observable event triggered each time the rendering canvas is resized
  41075. */
  41076. onResizeObservable: Observable<Engine>;
  41077. /**
  41078. * Observable event triggered each time the canvas loses focus
  41079. */
  41080. onCanvasBlurObservable: Observable<Engine>;
  41081. /**
  41082. * Observable event triggered each time the canvas gains focus
  41083. */
  41084. onCanvasFocusObservable: Observable<Engine>;
  41085. /**
  41086. * Observable event triggered each time the canvas receives pointerout event
  41087. */
  41088. onCanvasPointerOutObservable: Observable<PointerEvent>;
  41089. /**
  41090. * Observable raised when the engine begins a new frame
  41091. */
  41092. onBeginFrameObservable: Observable<Engine>;
  41093. /**
  41094. * If set, will be used to request the next animation frame for the render loop
  41095. */
  41096. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  41097. /**
  41098. * Observable raised when the engine ends the current frame
  41099. */
  41100. onEndFrameObservable: Observable<Engine>;
  41101. /**
  41102. * Observable raised when the engine is about to compile a shader
  41103. */
  41104. onBeforeShaderCompilationObservable: Observable<Engine>;
  41105. /**
  41106. * Observable raised when the engine has jsut compiled a shader
  41107. */
  41108. onAfterShaderCompilationObservable: Observable<Engine>;
  41109. /**
  41110. * Gets the audio engine
  41111. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  41112. * @ignorenaming
  41113. */
  41114. static audioEngine: IAudioEngine;
  41115. /**
  41116. * Default AudioEngine factory responsible of creating the Audio Engine.
  41117. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  41118. */
  41119. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  41120. /**
  41121. * Default offline support factory responsible of creating a tool used to store data locally.
  41122. * By default, this will create a Database object if the workload has been embedded.
  41123. */
  41124. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  41125. private _loadingScreen;
  41126. private _pointerLockRequested;
  41127. private _rescalePostProcess;
  41128. private _deterministicLockstep;
  41129. private _lockstepMaxSteps;
  41130. private _timeStep;
  41131. protected get _supportsHardwareTextureRescaling(): boolean;
  41132. private _fps;
  41133. private _deltaTime;
  41134. /** @hidden */
  41135. _drawCalls: PerfCounter;
  41136. /** Gets or sets the tab index to set to the rendering canvas. 1 is the minimum value to set to be able to capture keyboard events */
  41137. canvasTabIndex: number;
  41138. /**
  41139. * Turn this value on if you want to pause FPS computation when in background
  41140. */
  41141. disablePerformanceMonitorInBackground: boolean;
  41142. private _performanceMonitor;
  41143. /**
  41144. * Gets the performance monitor attached to this engine
  41145. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  41146. */
  41147. get performanceMonitor(): PerformanceMonitor;
  41148. private _onFocus;
  41149. private _onBlur;
  41150. private _onCanvasPointerOut;
  41151. private _onCanvasBlur;
  41152. private _onCanvasFocus;
  41153. private _onFullscreenChange;
  41154. private _onPointerLockChange;
  41155. /**
  41156. * Gets the HTML element used to attach event listeners
  41157. * @returns a HTML element
  41158. */
  41159. getInputElement(): Nullable<HTMLElement>;
  41160. /**
  41161. * Creates a new engine
  41162. * @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
  41163. * @param antialias defines enable antialiasing (default: false)
  41164. * @param options defines further options to be sent to the getContext() function
  41165. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  41166. */
  41167. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  41168. /**
  41169. * Gets current aspect ratio
  41170. * @param viewportOwner defines the camera to use to get the aspect ratio
  41171. * @param useScreen defines if screen size must be used (or the current render target if any)
  41172. * @returns a number defining the aspect ratio
  41173. */
  41174. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  41175. /**
  41176. * Gets current screen aspect ratio
  41177. * @returns a number defining the aspect ratio
  41178. */
  41179. getScreenAspectRatio(): number;
  41180. /**
  41181. * Gets the client rect of the HTML canvas attached with the current webGL context
  41182. * @returns a client rectanglee
  41183. */
  41184. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  41185. /**
  41186. * Gets the client rect of the HTML element used for events
  41187. * @returns a client rectanglee
  41188. */
  41189. getInputElementClientRect(): Nullable<ClientRect>;
  41190. /**
  41191. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  41192. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41193. * @returns true if engine is in deterministic lock step mode
  41194. */
  41195. isDeterministicLockStep(): boolean;
  41196. /**
  41197. * Gets the max steps when engine is running in deterministic lock step
  41198. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41199. * @returns the max steps
  41200. */
  41201. getLockstepMaxSteps(): number;
  41202. /**
  41203. * Returns the time in ms between steps when using deterministic lock step.
  41204. * @returns time step in (ms)
  41205. */
  41206. getTimeStep(): number;
  41207. /**
  41208. * Force the mipmap generation for the given render target texture
  41209. * @param texture defines the render target texture to use
  41210. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  41211. */
  41212. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  41213. /** States */
  41214. /**
  41215. * Set various states to the webGL context
  41216. * @param culling defines backface culling state
  41217. * @param zOffset defines the value to apply to zOffset (0 by default)
  41218. * @param force defines if states must be applied even if cache is up to date
  41219. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  41220. */
  41221. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  41222. /**
  41223. * Set the z offset to apply to current rendering
  41224. * @param value defines the offset to apply
  41225. */
  41226. setZOffset(value: number): void;
  41227. /**
  41228. * Gets the current value of the zOffset
  41229. * @returns the current zOffset state
  41230. */
  41231. getZOffset(): number;
  41232. /**
  41233. * Enable or disable depth buffering
  41234. * @param enable defines the state to set
  41235. */
  41236. setDepthBuffer(enable: boolean): void;
  41237. /**
  41238. * Gets a boolean indicating if depth writing is enabled
  41239. * @returns the current depth writing state
  41240. */
  41241. getDepthWrite(): boolean;
  41242. /**
  41243. * Enable or disable depth writing
  41244. * @param enable defines the state to set
  41245. */
  41246. setDepthWrite(enable: boolean): void;
  41247. /**
  41248. * Gets a boolean indicating if stencil buffer is enabled
  41249. * @returns the current stencil buffer state
  41250. */
  41251. getStencilBuffer(): boolean;
  41252. /**
  41253. * Enable or disable the stencil buffer
  41254. * @param enable defines if the stencil buffer must be enabled or disabled
  41255. */
  41256. setStencilBuffer(enable: boolean): void;
  41257. /**
  41258. * Gets the current stencil mask
  41259. * @returns a number defining the new stencil mask to use
  41260. */
  41261. getStencilMask(): number;
  41262. /**
  41263. * Sets the current stencil mask
  41264. * @param mask defines the new stencil mask to use
  41265. */
  41266. setStencilMask(mask: number): void;
  41267. /**
  41268. * Gets the current stencil function
  41269. * @returns a number defining the stencil function to use
  41270. */
  41271. getStencilFunction(): number;
  41272. /**
  41273. * Gets the current stencil reference value
  41274. * @returns a number defining the stencil reference value to use
  41275. */
  41276. getStencilFunctionReference(): number;
  41277. /**
  41278. * Gets the current stencil mask
  41279. * @returns a number defining the stencil mask to use
  41280. */
  41281. getStencilFunctionMask(): number;
  41282. /**
  41283. * Sets the current stencil function
  41284. * @param stencilFunc defines the new stencil function to use
  41285. */
  41286. setStencilFunction(stencilFunc: number): void;
  41287. /**
  41288. * Sets the current stencil reference
  41289. * @param reference defines the new stencil reference to use
  41290. */
  41291. setStencilFunctionReference(reference: number): void;
  41292. /**
  41293. * Sets the current stencil mask
  41294. * @param mask defines the new stencil mask to use
  41295. */
  41296. setStencilFunctionMask(mask: number): void;
  41297. /**
  41298. * Gets the current stencil operation when stencil fails
  41299. * @returns a number defining stencil operation to use when stencil fails
  41300. */
  41301. getStencilOperationFail(): number;
  41302. /**
  41303. * Gets the current stencil operation when depth fails
  41304. * @returns a number defining stencil operation to use when depth fails
  41305. */
  41306. getStencilOperationDepthFail(): number;
  41307. /**
  41308. * Gets the current stencil operation when stencil passes
  41309. * @returns a number defining stencil operation to use when stencil passes
  41310. */
  41311. getStencilOperationPass(): number;
  41312. /**
  41313. * Sets the stencil operation to use when stencil fails
  41314. * @param operation defines the stencil operation to use when stencil fails
  41315. */
  41316. setStencilOperationFail(operation: number): void;
  41317. /**
  41318. * Sets the stencil operation to use when depth fails
  41319. * @param operation defines the stencil operation to use when depth fails
  41320. */
  41321. setStencilOperationDepthFail(operation: number): void;
  41322. /**
  41323. * Sets the stencil operation to use when stencil passes
  41324. * @param operation defines the stencil operation to use when stencil passes
  41325. */
  41326. setStencilOperationPass(operation: number): void;
  41327. /**
  41328. * Sets a boolean indicating if the dithering state is enabled or disabled
  41329. * @param value defines the dithering state
  41330. */
  41331. setDitheringState(value: boolean): void;
  41332. /**
  41333. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  41334. * @param value defines the rasterizer state
  41335. */
  41336. setRasterizerState(value: boolean): void;
  41337. /**
  41338. * Gets the current depth function
  41339. * @returns a number defining the depth function
  41340. */
  41341. getDepthFunction(): Nullable<number>;
  41342. /**
  41343. * Sets the current depth function
  41344. * @param depthFunc defines the function to use
  41345. */
  41346. setDepthFunction(depthFunc: number): void;
  41347. /**
  41348. * Sets the current depth function to GREATER
  41349. */
  41350. setDepthFunctionToGreater(): void;
  41351. /**
  41352. * Sets the current depth function to GEQUAL
  41353. */
  41354. setDepthFunctionToGreaterOrEqual(): void;
  41355. /**
  41356. * Sets the current depth function to LESS
  41357. */
  41358. setDepthFunctionToLess(): void;
  41359. /**
  41360. * Sets the current depth function to LEQUAL
  41361. */
  41362. setDepthFunctionToLessOrEqual(): void;
  41363. private _cachedStencilBuffer;
  41364. private _cachedStencilFunction;
  41365. private _cachedStencilMask;
  41366. private _cachedStencilOperationPass;
  41367. private _cachedStencilOperationFail;
  41368. private _cachedStencilOperationDepthFail;
  41369. private _cachedStencilReference;
  41370. /**
  41371. * Caches the the state of the stencil buffer
  41372. */
  41373. cacheStencilState(): void;
  41374. /**
  41375. * Restores the state of the stencil buffer
  41376. */
  41377. restoreStencilState(): void;
  41378. /**
  41379. * Directly set the WebGL Viewport
  41380. * @param x defines the x coordinate of the viewport (in screen space)
  41381. * @param y defines the y coordinate of the viewport (in screen space)
  41382. * @param width defines the width of the viewport (in screen space)
  41383. * @param height defines the height of the viewport (in screen space)
  41384. * @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
  41385. */
  41386. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  41387. /**
  41388. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  41389. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  41390. * @param y defines the y-coordinate of the corner of the clear rectangle
  41391. * @param width defines the width of the clear rectangle
  41392. * @param height defines the height of the clear rectangle
  41393. * @param clearColor defines the clear color
  41394. */
  41395. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  41396. /**
  41397. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  41398. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  41399. * @param y defines the y-coordinate of the corner of the clear rectangle
  41400. * @param width defines the width of the clear rectangle
  41401. * @param height defines the height of the clear rectangle
  41402. */
  41403. enableScissor(x: number, y: number, width: number, height: number): void;
  41404. /**
  41405. * Disable previously set scissor test rectangle
  41406. */
  41407. disableScissor(): void;
  41408. protected _reportDrawCall(): void;
  41409. /**
  41410. * Initializes a webVR display and starts listening to display change events
  41411. * The onVRDisplayChangedObservable will be notified upon these changes
  41412. * @returns The onVRDisplayChangedObservable
  41413. */
  41414. initWebVR(): Observable<IDisplayChangedEventArgs>;
  41415. /** @hidden */
  41416. _prepareVRComponent(): void;
  41417. /** @hidden */
  41418. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  41419. /** @hidden */
  41420. _submitVRFrame(): void;
  41421. /**
  41422. * Call this function to leave webVR mode
  41423. * Will do nothing if webVR is not supported or if there is no webVR device
  41424. * @see https://doc.babylonjs.com/how_to/webvr_camera
  41425. */
  41426. disableVR(): void;
  41427. /**
  41428. * Gets a boolean indicating that the system is in VR mode and is presenting
  41429. * @returns true if VR mode is engaged
  41430. */
  41431. isVRPresenting(): boolean;
  41432. /** @hidden */
  41433. _requestVRFrame(): void;
  41434. /** @hidden */
  41435. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  41436. /**
  41437. * Gets the source code of the vertex shader associated with a specific webGL program
  41438. * @param program defines the program to use
  41439. * @returns a string containing the source code of the vertex shader associated with the program
  41440. */
  41441. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  41442. /**
  41443. * Gets the source code of the fragment shader associated with a specific webGL program
  41444. * @param program defines the program to use
  41445. * @returns a string containing the source code of the fragment shader associated with the program
  41446. */
  41447. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  41448. /**
  41449. * Sets a depth stencil texture from a render target to the according uniform.
  41450. * @param channel The texture channel
  41451. * @param uniform The uniform to set
  41452. * @param texture The render target texture containing the depth stencil texture to apply
  41453. */
  41454. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  41455. /**
  41456. * Sets a texture to the webGL context from a postprocess
  41457. * @param channel defines the channel to use
  41458. * @param postProcess defines the source postprocess
  41459. */
  41460. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  41461. /**
  41462. * Binds the output of the passed in post process to the texture channel specified
  41463. * @param channel The channel the texture should be bound to
  41464. * @param postProcess The post process which's output should be bound
  41465. */
  41466. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  41467. protected _rebuildBuffers(): void;
  41468. /** @hidden */
  41469. _renderFrame(): void;
  41470. _renderLoop(): void;
  41471. /** @hidden */
  41472. _renderViews(): boolean;
  41473. /**
  41474. * Toggle full screen mode
  41475. * @param requestPointerLock defines if a pointer lock should be requested from the user
  41476. */
  41477. switchFullscreen(requestPointerLock: boolean): void;
  41478. /**
  41479. * Enters full screen mode
  41480. * @param requestPointerLock defines if a pointer lock should be requested from the user
  41481. */
  41482. enterFullscreen(requestPointerLock: boolean): void;
  41483. /**
  41484. * Exits full screen mode
  41485. */
  41486. exitFullscreen(): void;
  41487. /**
  41488. * Enters Pointerlock mode
  41489. */
  41490. enterPointerlock(): void;
  41491. /**
  41492. * Exits Pointerlock mode
  41493. */
  41494. exitPointerlock(): void;
  41495. /**
  41496. * Begin a new frame
  41497. */
  41498. beginFrame(): void;
  41499. /**
  41500. * Enf the current frame
  41501. */
  41502. endFrame(): void;
  41503. resize(): void;
  41504. /**
  41505. * Force a specific size of the canvas
  41506. * @param width defines the new canvas' width
  41507. * @param height defines the new canvas' height
  41508. * @returns true if the size was changed
  41509. */
  41510. setSize(width: number, height: number): boolean;
  41511. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  41512. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  41513. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  41514. _releaseTexture(texture: InternalTexture): void;
  41515. /**
  41516. * @hidden
  41517. * Rescales a texture
  41518. * @param source input texutre
  41519. * @param destination destination texture
  41520. * @param scene scene to use to render the resize
  41521. * @param internalFormat format to use when resizing
  41522. * @param onComplete callback to be called when resize has completed
  41523. */
  41524. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  41525. /**
  41526. * Gets the current framerate
  41527. * @returns a number representing the framerate
  41528. */
  41529. getFps(): number;
  41530. /**
  41531. * Gets the time spent between current and previous frame
  41532. * @returns a number representing the delta time in ms
  41533. */
  41534. getDeltaTime(): number;
  41535. private _measureFps;
  41536. /** @hidden */
  41537. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  41538. /**
  41539. * Updates the sample count of a render target texture
  41540. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  41541. * @param texture defines the texture to update
  41542. * @param samples defines the sample count to set
  41543. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  41544. */
  41545. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  41546. /**
  41547. * Updates a depth texture Comparison Mode and Function.
  41548. * If the comparison Function is equal to 0, the mode will be set to none.
  41549. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  41550. * @param texture The texture to set the comparison function for
  41551. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  41552. */
  41553. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  41554. /**
  41555. * Creates a webGL buffer to use with instanciation
  41556. * @param capacity defines the size of the buffer
  41557. * @returns the webGL buffer
  41558. */
  41559. createInstancesBuffer(capacity: number): DataBuffer;
  41560. /**
  41561. * Delete a webGL buffer used with instanciation
  41562. * @param buffer defines the webGL buffer to delete
  41563. */
  41564. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  41565. private _clientWaitAsync;
  41566. /** @hidden */
  41567. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  41568. dispose(): void;
  41569. private _disableTouchAction;
  41570. /**
  41571. * Display the loading screen
  41572. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  41573. */
  41574. displayLoadingUI(): void;
  41575. /**
  41576. * Hide the loading screen
  41577. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  41578. */
  41579. hideLoadingUI(): void;
  41580. /**
  41581. * Gets the current loading screen object
  41582. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  41583. */
  41584. get loadingScreen(): ILoadingScreen;
  41585. /**
  41586. * Sets the current loading screen object
  41587. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  41588. */
  41589. set loadingScreen(loadingScreen: ILoadingScreen);
  41590. /**
  41591. * Sets the current loading screen text
  41592. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  41593. */
  41594. set loadingUIText(text: string);
  41595. /**
  41596. * Sets the current loading screen background color
  41597. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  41598. */
  41599. set loadingUIBackgroundColor(color: string);
  41600. /** Pointerlock and fullscreen */
  41601. /**
  41602. * Ask the browser to promote the current element to pointerlock mode
  41603. * @param element defines the DOM element to promote
  41604. */
  41605. static _RequestPointerlock(element: HTMLElement): void;
  41606. /**
  41607. * Asks the browser to exit pointerlock mode
  41608. */
  41609. static _ExitPointerlock(): void;
  41610. /**
  41611. * Ask the browser to promote the current element to fullscreen rendering mode
  41612. * @param element defines the DOM element to promote
  41613. */
  41614. static _RequestFullscreen(element: HTMLElement): void;
  41615. /**
  41616. * Asks the browser to exit fullscreen mode
  41617. */
  41618. static _ExitFullscreen(): void;
  41619. }
  41620. }
  41621. declare module BABYLON {
  41622. /**
  41623. * The engine store class is responsible to hold all the instances of Engine and Scene created
  41624. * during the life time of the application.
  41625. */
  41626. export class EngineStore {
  41627. /** Gets the list of created engines */
  41628. static Instances: Engine[];
  41629. /** @hidden */
  41630. static _LastCreatedScene: Nullable<Scene>;
  41631. /**
  41632. * Gets the latest created engine
  41633. */
  41634. static get LastCreatedEngine(): Nullable<Engine>;
  41635. /**
  41636. * Gets the latest created scene
  41637. */
  41638. static get LastCreatedScene(): Nullable<Scene>;
  41639. /**
  41640. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  41641. * @ignorenaming
  41642. */
  41643. static UseFallbackTexture: boolean;
  41644. /**
  41645. * Texture content used if a texture cannot loaded
  41646. * @ignorenaming
  41647. */
  41648. static FallbackTexture: string;
  41649. }
  41650. }
  41651. declare module BABYLON {
  41652. /**
  41653. * Helper class that provides a small promise polyfill
  41654. */
  41655. export class PromisePolyfill {
  41656. /**
  41657. * Static function used to check if the polyfill is required
  41658. * If this is the case then the function will inject the polyfill to window.Promise
  41659. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  41660. */
  41661. static Apply(force?: boolean): void;
  41662. }
  41663. }
  41664. declare module BABYLON {
  41665. /**
  41666. * Interface for screenshot methods with describe argument called `size` as object with options
  41667. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  41668. */
  41669. export interface IScreenshotSize {
  41670. /**
  41671. * number in pixels for canvas height
  41672. */
  41673. height?: number;
  41674. /**
  41675. * multiplier allowing render at a higher or lower resolution
  41676. * If value is defined then height and width will be ignored and taken from camera
  41677. */
  41678. precision?: number;
  41679. /**
  41680. * number in pixels for canvas width
  41681. */
  41682. width?: number;
  41683. }
  41684. }
  41685. declare module BABYLON {
  41686. interface IColor4Like {
  41687. r: float;
  41688. g: float;
  41689. b: float;
  41690. a: float;
  41691. }
  41692. /**
  41693. * Class containing a set of static utilities functions
  41694. */
  41695. export class Tools {
  41696. /**
  41697. * Gets or sets the base URL to use to load assets
  41698. */
  41699. static get BaseUrl(): string;
  41700. static set BaseUrl(value: string);
  41701. /**
  41702. * Enable/Disable Custom HTTP Request Headers globally.
  41703. * default = false
  41704. * @see CustomRequestHeaders
  41705. */
  41706. static UseCustomRequestHeaders: boolean;
  41707. /**
  41708. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  41709. * i.e. when loading files, where the server/service expects an Authorization header
  41710. */
  41711. static CustomRequestHeaders: {
  41712. [key: string]: string;
  41713. };
  41714. /**
  41715. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  41716. */
  41717. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  41718. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  41719. /**
  41720. * Default behaviour for cors in the application.
  41721. * It can be a string if the expected behavior is identical in the entire app.
  41722. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  41723. */
  41724. static get CorsBehavior(): string | ((url: string | string[]) => string);
  41725. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  41726. /**
  41727. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  41728. * @ignorenaming
  41729. */
  41730. static get UseFallbackTexture(): boolean;
  41731. static set UseFallbackTexture(value: boolean);
  41732. /**
  41733. * Use this object to register external classes like custom textures or material
  41734. * to allow the laoders to instantiate them
  41735. */
  41736. static get RegisteredExternalClasses(): {
  41737. [key: string]: Object;
  41738. };
  41739. static set RegisteredExternalClasses(classes: {
  41740. [key: string]: Object;
  41741. });
  41742. /**
  41743. * Texture content used if a texture cannot loaded
  41744. * @ignorenaming
  41745. */
  41746. static get fallbackTexture(): string;
  41747. static set fallbackTexture(value: string);
  41748. /**
  41749. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  41750. * @param u defines the coordinate on X axis
  41751. * @param v defines the coordinate on Y axis
  41752. * @param width defines the width of the source data
  41753. * @param height defines the height of the source data
  41754. * @param pixels defines the source byte array
  41755. * @param color defines the output color
  41756. */
  41757. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  41758. /**
  41759. * Interpolates between a and b via alpha
  41760. * @param a The lower value (returned when alpha = 0)
  41761. * @param b The upper value (returned when alpha = 1)
  41762. * @param alpha The interpolation-factor
  41763. * @return The mixed value
  41764. */
  41765. static Mix(a: number, b: number, alpha: number): number;
  41766. /**
  41767. * Tries to instantiate a new object from a given class name
  41768. * @param className defines the class name to instantiate
  41769. * @returns the new object or null if the system was not able to do the instantiation
  41770. */
  41771. static Instantiate(className: string): any;
  41772. /**
  41773. * Provides a slice function that will work even on IE
  41774. * @param data defines the array to slice
  41775. * @param start defines the start of the data (optional)
  41776. * @param end defines the end of the data (optional)
  41777. * @returns the new sliced array
  41778. */
  41779. static Slice<T>(data: T, start?: number, end?: number): T;
  41780. /**
  41781. * Provides a slice function that will work even on IE
  41782. * The difference between this and Slice is that this will force-convert to array
  41783. * @param data defines the array to slice
  41784. * @param start defines the start of the data (optional)
  41785. * @param end defines the end of the data (optional)
  41786. * @returns the new sliced array
  41787. */
  41788. static SliceToArray<T, P>(data: T, start?: number, end?: number): Array<P>;
  41789. /**
  41790. * Polyfill for setImmediate
  41791. * @param action defines the action to execute after the current execution block
  41792. */
  41793. static SetImmediate(action: () => void): void;
  41794. /**
  41795. * Function indicating if a number is an exponent of 2
  41796. * @param value defines the value to test
  41797. * @returns true if the value is an exponent of 2
  41798. */
  41799. static IsExponentOfTwo(value: number): boolean;
  41800. private static _tmpFloatArray;
  41801. /**
  41802. * Returns the nearest 32-bit single precision float representation of a Number
  41803. * @param value A Number. If the parameter is of a different type, it will get converted
  41804. * to a number or to NaN if it cannot be converted
  41805. * @returns number
  41806. */
  41807. static FloatRound(value: number): number;
  41808. /**
  41809. * Extracts the filename from a path
  41810. * @param path defines the path to use
  41811. * @returns the filename
  41812. */
  41813. static GetFilename(path: string): string;
  41814. /**
  41815. * Extracts the "folder" part of a path (everything before the filename).
  41816. * @param uri The URI to extract the info from
  41817. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  41818. * @returns The "folder" part of the path
  41819. */
  41820. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  41821. /**
  41822. * Extracts text content from a DOM element hierarchy
  41823. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  41824. */
  41825. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  41826. /**
  41827. * Convert an angle in radians to degrees
  41828. * @param angle defines the angle to convert
  41829. * @returns the angle in degrees
  41830. */
  41831. static ToDegrees(angle: number): number;
  41832. /**
  41833. * Convert an angle in degrees to radians
  41834. * @param angle defines the angle to convert
  41835. * @returns the angle in radians
  41836. */
  41837. static ToRadians(angle: number): number;
  41838. /**
  41839. * Returns an array if obj is not an array
  41840. * @param obj defines the object to evaluate as an array
  41841. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  41842. * @returns either obj directly if obj is an array or a new array containing obj
  41843. */
  41844. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  41845. /**
  41846. * Gets the pointer prefix to use
  41847. * @param engine defines the engine we are finding the prefix for
  41848. * @returns "pointer" if touch is enabled. Else returns "mouse"
  41849. */
  41850. static GetPointerPrefix(engine: Engine): string;
  41851. /**
  41852. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  41853. * @param url define the url we are trying
  41854. * @param element define the dom element where to configure the cors policy
  41855. */
  41856. static SetCorsBehavior(url: string | string[], element: {
  41857. crossOrigin: string | null;
  41858. }): void;
  41859. /**
  41860. * Removes unwanted characters from an url
  41861. * @param url defines the url to clean
  41862. * @returns the cleaned url
  41863. */
  41864. static CleanUrl(url: string): string;
  41865. /**
  41866. * Gets or sets a function used to pre-process url before using them to load assets
  41867. */
  41868. static get PreprocessUrl(): (url: string) => string;
  41869. static set PreprocessUrl(processor: (url: string) => string);
  41870. /**
  41871. * Loads an image as an HTMLImageElement.
  41872. * @param input url string, ArrayBuffer, or Blob to load
  41873. * @param onLoad callback called when the image successfully loads
  41874. * @param onError callback called when the image fails to load
  41875. * @param offlineProvider offline provider for caching
  41876. * @param mimeType optional mime type
  41877. * @returns the HTMLImageElement of the loaded image
  41878. */
  41879. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  41880. /**
  41881. * Loads a file from a url
  41882. * @param url url string, ArrayBuffer, or Blob to load
  41883. * @param onSuccess callback called when the file successfully loads
  41884. * @param onProgress callback called while file is loading (if the server supports this mode)
  41885. * @param offlineProvider defines the offline provider for caching
  41886. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  41887. * @param onError callback called when the file fails to load
  41888. * @returns a file request object
  41889. */
  41890. 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;
  41891. /**
  41892. * Loads a file from a url
  41893. * @param url the file url to load
  41894. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  41895. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  41896. */
  41897. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  41898. /**
  41899. * Load a script (identified by an url). When the url returns, the
  41900. * content of this file is added into a new script element, attached to the DOM (body element)
  41901. * @param scriptUrl defines the url of the script to laod
  41902. * @param onSuccess defines the callback called when the script is loaded
  41903. * @param onError defines the callback to call if an error occurs
  41904. * @param scriptId defines the id of the script element
  41905. */
  41906. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  41907. /**
  41908. * Load an asynchronous script (identified by an url). When the url returns, the
  41909. * content of this file is added into a new script element, attached to the DOM (body element)
  41910. * @param scriptUrl defines the url of the script to laod
  41911. * @param scriptId defines the id of the script element
  41912. * @returns a promise request object
  41913. */
  41914. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  41915. /**
  41916. * Loads a file from a blob
  41917. * @param fileToLoad defines the blob to use
  41918. * @param callback defines the callback to call when data is loaded
  41919. * @param progressCallback defines the callback to call during loading process
  41920. * @returns a file request object
  41921. */
  41922. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  41923. /**
  41924. * Reads a file from a File object
  41925. * @param file defines the file to load
  41926. * @param onSuccess defines the callback to call when data is loaded
  41927. * @param onProgress defines the callback to call during loading process
  41928. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  41929. * @param onError defines the callback to call when an error occurs
  41930. * @returns a file request object
  41931. */
  41932. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  41933. /**
  41934. * Creates a data url from a given string content
  41935. * @param content defines the content to convert
  41936. * @returns the new data url link
  41937. */
  41938. static FileAsURL(content: string): string;
  41939. /**
  41940. * Format the given number to a specific decimal format
  41941. * @param value defines the number to format
  41942. * @param decimals defines the number of decimals to use
  41943. * @returns the formatted string
  41944. */
  41945. static Format(value: number, decimals?: number): string;
  41946. /**
  41947. * Tries to copy an object by duplicating every property
  41948. * @param source defines the source object
  41949. * @param destination defines the target object
  41950. * @param doNotCopyList defines a list of properties to avoid
  41951. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  41952. */
  41953. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  41954. /**
  41955. * Gets a boolean indicating if the given object has no own property
  41956. * @param obj defines the object to test
  41957. * @returns true if object has no own property
  41958. */
  41959. static IsEmpty(obj: any): boolean;
  41960. /**
  41961. * Function used to register events at window level
  41962. * @param windowElement defines the Window object to use
  41963. * @param events defines the events to register
  41964. */
  41965. static RegisterTopRootEvents(windowElement: Window, events: {
  41966. name: string;
  41967. handler: Nullable<(e: FocusEvent) => any>;
  41968. }[]): void;
  41969. /**
  41970. * Function used to unregister events from window level
  41971. * @param windowElement defines the Window object to use
  41972. * @param events defines the events to unregister
  41973. */
  41974. static UnregisterTopRootEvents(windowElement: Window, events: {
  41975. name: string;
  41976. handler: Nullable<(e: FocusEvent) => any>;
  41977. }[]): void;
  41978. /**
  41979. * @ignore
  41980. */
  41981. static _ScreenshotCanvas: HTMLCanvasElement;
  41982. /**
  41983. * Dumps the current bound framebuffer
  41984. * @param width defines the rendering width
  41985. * @param height defines the rendering height
  41986. * @param engine defines the hosting engine
  41987. * @param successCallback defines the callback triggered once the data are available
  41988. * @param mimeType defines the mime type of the result
  41989. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  41990. */
  41991. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  41992. /**
  41993. * Converts the canvas data to blob.
  41994. * This acts as a polyfill for browsers not supporting the to blob function.
  41995. * @param canvas Defines the canvas to extract the data from
  41996. * @param successCallback Defines the callback triggered once the data are available
  41997. * @param mimeType Defines the mime type of the result
  41998. */
  41999. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  42000. /**
  42001. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  42002. * @param successCallback defines the callback triggered once the data are available
  42003. * @param mimeType defines the mime type of the result
  42004. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  42005. */
  42006. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  42007. /**
  42008. * Downloads a blob in the browser
  42009. * @param blob defines the blob to download
  42010. * @param fileName defines the name of the downloaded file
  42011. */
  42012. static Download(blob: Blob, fileName: string): void;
  42013. /**
  42014. * Will return the right value of the noPreventDefault variable
  42015. * Needed to keep backwards compatibility to the old API.
  42016. *
  42017. * @param args arguments passed to the attachControl function
  42018. * @returns the correct value for noPreventDefault
  42019. */
  42020. static BackCompatCameraNoPreventDefault(args: IArguments): boolean;
  42021. /**
  42022. * Captures a screenshot of the current rendering
  42023. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  42024. * @param engine defines the rendering engine
  42025. * @param camera defines the source camera
  42026. * @param size This parameter can be set to a single number or to an object with the
  42027. * following (optional) properties: precision, width, height. If a single number is passed,
  42028. * it will be used for both width and height. If an object is passed, the screenshot size
  42029. * will be derived from the parameters. The precision property is a multiplier allowing
  42030. * rendering at a higher or lower resolution
  42031. * @param successCallback defines the callback receives a single parameter which contains the
  42032. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  42033. * src parameter of an <img> to display it
  42034. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  42035. * Check your browser for supported MIME types
  42036. */
  42037. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  42038. /**
  42039. * Captures a screenshot of the current rendering
  42040. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  42041. * @param engine defines the rendering engine
  42042. * @param camera defines the source camera
  42043. * @param size This parameter can be set to a single number or to an object with the
  42044. * following (optional) properties: precision, width, height. If a single number is passed,
  42045. * it will be used for both width and height. If an object is passed, the screenshot size
  42046. * will be derived from the parameters. The precision property is a multiplier allowing
  42047. * rendering at a higher or lower resolution
  42048. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  42049. * Check your browser for supported MIME types
  42050. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  42051. * to the src parameter of an <img> to display it
  42052. */
  42053. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  42054. /**
  42055. * Generates an image screenshot from the specified camera.
  42056. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  42057. * @param engine The engine to use for rendering
  42058. * @param camera The camera to use for rendering
  42059. * @param size This parameter can be set to a single number or to an object with the
  42060. * following (optional) properties: precision, width, height. If a single number is passed,
  42061. * it will be used for both width and height. If an object is passed, the screenshot size
  42062. * will be derived from the parameters. The precision property is a multiplier allowing
  42063. * rendering at a higher or lower resolution
  42064. * @param successCallback The callback receives a single parameter which contains the
  42065. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  42066. * src parameter of an <img> to display it
  42067. * @param mimeType The MIME type of the screenshot image (default: image/png).
  42068. * Check your browser for supported MIME types
  42069. * @param samples Texture samples (default: 1)
  42070. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  42071. * @param fileName A name for for the downloaded file.
  42072. */
  42073. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  42074. /**
  42075. * Generates an image screenshot from the specified camera.
  42076. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  42077. * @param engine The engine to use for rendering
  42078. * @param camera The camera to use for rendering
  42079. * @param size This parameter can be set to a single number or to an object with the
  42080. * following (optional) properties: precision, width, height. If a single number is passed,
  42081. * it will be used for both width and height. If an object is passed, the screenshot size
  42082. * will be derived from the parameters. The precision property is a multiplier allowing
  42083. * rendering at a higher or lower resolution
  42084. * @param mimeType The MIME type of the screenshot image (default: image/png).
  42085. * Check your browser for supported MIME types
  42086. * @param samples Texture samples (default: 1)
  42087. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  42088. * @param fileName A name for for the downloaded file.
  42089. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  42090. * to the src parameter of an <img> to display it
  42091. */
  42092. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  42093. /**
  42094. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  42095. * Be aware Math.random() could cause collisions, but:
  42096. * "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"
  42097. * @returns a pseudo random id
  42098. */
  42099. static RandomId(): string;
  42100. /**
  42101. * Test if the given uri is a base64 string
  42102. * @param uri The uri to test
  42103. * @return True if the uri is a base64 string or false otherwise
  42104. */
  42105. static IsBase64(uri: string): boolean;
  42106. /**
  42107. * Decode the given base64 uri.
  42108. * @param uri The uri to decode
  42109. * @return The decoded base64 data.
  42110. */
  42111. static DecodeBase64(uri: string): ArrayBuffer;
  42112. /**
  42113. * Gets the absolute url.
  42114. * @param url the input url
  42115. * @return the absolute url
  42116. */
  42117. static GetAbsoluteUrl(url: string): string;
  42118. /**
  42119. * No log
  42120. */
  42121. static readonly NoneLogLevel: number;
  42122. /**
  42123. * Only message logs
  42124. */
  42125. static readonly MessageLogLevel: number;
  42126. /**
  42127. * Only warning logs
  42128. */
  42129. static readonly WarningLogLevel: number;
  42130. /**
  42131. * Only error logs
  42132. */
  42133. static readonly ErrorLogLevel: number;
  42134. /**
  42135. * All logs
  42136. */
  42137. static readonly AllLogLevel: number;
  42138. /**
  42139. * Gets a value indicating the number of loading errors
  42140. * @ignorenaming
  42141. */
  42142. static get errorsCount(): number;
  42143. /**
  42144. * Callback called when a new log is added
  42145. */
  42146. static OnNewCacheEntry: (entry: string) => void;
  42147. /**
  42148. * Log a message to the console
  42149. * @param message defines the message to log
  42150. */
  42151. static Log(message: string): void;
  42152. /**
  42153. * Write a warning message to the console
  42154. * @param message defines the message to log
  42155. */
  42156. static Warn(message: string): void;
  42157. /**
  42158. * Write an error message to the console
  42159. * @param message defines the message to log
  42160. */
  42161. static Error(message: string): void;
  42162. /**
  42163. * Gets current log cache (list of logs)
  42164. */
  42165. static get LogCache(): string;
  42166. /**
  42167. * Clears the log cache
  42168. */
  42169. static ClearLogCache(): void;
  42170. /**
  42171. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  42172. */
  42173. static set LogLevels(level: number);
  42174. /**
  42175. * Checks if the window object exists
  42176. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  42177. */
  42178. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  42179. /**
  42180. * No performance log
  42181. */
  42182. static readonly PerformanceNoneLogLevel: number;
  42183. /**
  42184. * Use user marks to log performance
  42185. */
  42186. static readonly PerformanceUserMarkLogLevel: number;
  42187. /**
  42188. * Log performance to the console
  42189. */
  42190. static readonly PerformanceConsoleLogLevel: number;
  42191. private static _performance;
  42192. /**
  42193. * Sets the current performance log level
  42194. */
  42195. static set PerformanceLogLevel(level: number);
  42196. private static _StartPerformanceCounterDisabled;
  42197. private static _EndPerformanceCounterDisabled;
  42198. private static _StartUserMark;
  42199. private static _EndUserMark;
  42200. private static _StartPerformanceConsole;
  42201. private static _EndPerformanceConsole;
  42202. /**
  42203. * Starts a performance counter
  42204. */
  42205. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  42206. /**
  42207. * Ends a specific performance coutner
  42208. */
  42209. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  42210. /**
  42211. * Gets either window.performance.now() if supported or Date.now() else
  42212. */
  42213. static get Now(): number;
  42214. /**
  42215. * This method will return the name of the class used to create the instance of the given object.
  42216. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  42217. * @param object the object to get the class name from
  42218. * @param isType defines if the object is actually a type
  42219. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  42220. */
  42221. static GetClassName(object: any, isType?: boolean): string;
  42222. /**
  42223. * Gets the first element of an array satisfying a given predicate
  42224. * @param array defines the array to browse
  42225. * @param predicate defines the predicate to use
  42226. * @returns null if not found or the element
  42227. */
  42228. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  42229. /**
  42230. * This method will return the name of the full name of the class, including its owning module (if any).
  42231. * 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).
  42232. * @param object the object to get the class name from
  42233. * @param isType defines if the object is actually a type
  42234. * @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.
  42235. * @ignorenaming
  42236. */
  42237. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  42238. /**
  42239. * Returns a promise that resolves after the given amount of time.
  42240. * @param delay Number of milliseconds to delay
  42241. * @returns Promise that resolves after the given amount of time
  42242. */
  42243. static DelayAsync(delay: number): Promise<void>;
  42244. /**
  42245. * Utility function to detect if the current user agent is Safari
  42246. * @returns whether or not the current user agent is safari
  42247. */
  42248. static IsSafari(): boolean;
  42249. }
  42250. /**
  42251. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  42252. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  42253. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  42254. * @param name The name of the class, case should be preserved
  42255. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  42256. */
  42257. export function className(name: string, module?: string): (target: Object) => void;
  42258. /**
  42259. * An implementation of a loop for asynchronous functions.
  42260. */
  42261. export class AsyncLoop {
  42262. /**
  42263. * Defines the number of iterations for the loop
  42264. */
  42265. iterations: number;
  42266. /**
  42267. * Defines the current index of the loop.
  42268. */
  42269. index: number;
  42270. private _done;
  42271. private _fn;
  42272. private _successCallback;
  42273. /**
  42274. * Constructor.
  42275. * @param iterations the number of iterations.
  42276. * @param func the function to run each iteration
  42277. * @param successCallback the callback that will be called upon succesful execution
  42278. * @param offset starting offset.
  42279. */
  42280. constructor(
  42281. /**
  42282. * Defines the number of iterations for the loop
  42283. */
  42284. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  42285. /**
  42286. * Execute the next iteration. Must be called after the last iteration was finished.
  42287. */
  42288. executeNext(): void;
  42289. /**
  42290. * Break the loop and run the success callback.
  42291. */
  42292. breakLoop(): void;
  42293. /**
  42294. * Create and run an async loop.
  42295. * @param iterations the number of iterations.
  42296. * @param fn the function to run each iteration
  42297. * @param successCallback the callback that will be called upon succesful execution
  42298. * @param offset starting offset.
  42299. * @returns the created async loop object
  42300. */
  42301. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  42302. /**
  42303. * A for-loop that will run a given number of iterations synchronous and the rest async.
  42304. * @param iterations total number of iterations
  42305. * @param syncedIterations number of synchronous iterations in each async iteration.
  42306. * @param fn the function to call each iteration.
  42307. * @param callback a success call back that will be called when iterating stops.
  42308. * @param breakFunction a break condition (optional)
  42309. * @param timeout timeout settings for the setTimeout function. default - 0.
  42310. * @returns the created async loop object
  42311. */
  42312. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  42313. }
  42314. }
  42315. declare module BABYLON {
  42316. /**
  42317. * This class implement a typical dictionary using a string as key and the generic type T as value.
  42318. * The underlying implementation relies on an associative array to ensure the best performances.
  42319. * The value can be anything including 'null' but except 'undefined'
  42320. */
  42321. export class StringDictionary<T> {
  42322. /**
  42323. * This will clear this dictionary and copy the content from the 'source' one.
  42324. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  42325. * @param source the dictionary to take the content from and copy to this dictionary
  42326. */
  42327. copyFrom(source: StringDictionary<T>): void;
  42328. /**
  42329. * Get a value based from its key
  42330. * @param key the given key to get the matching value from
  42331. * @return the value if found, otherwise undefined is returned
  42332. */
  42333. get(key: string): T | undefined;
  42334. /**
  42335. * Get a value from its key or add it if it doesn't exist.
  42336. * This method will ensure you that a given key/data will be present in the dictionary.
  42337. * @param key the given key to get the matching value from
  42338. * @param factory the factory that will create the value if the key is not present in the dictionary.
  42339. * The factory will only be invoked if there's no data for the given key.
  42340. * @return the value corresponding to the key.
  42341. */
  42342. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  42343. /**
  42344. * Get a value from its key if present in the dictionary otherwise add it
  42345. * @param key the key to get the value from
  42346. * @param val if there's no such key/value pair in the dictionary add it with this value
  42347. * @return the value corresponding to the key
  42348. */
  42349. getOrAdd(key: string, val: T): T;
  42350. /**
  42351. * Check if there's a given key in the dictionary
  42352. * @param key the key to check for
  42353. * @return true if the key is present, false otherwise
  42354. */
  42355. contains(key: string): boolean;
  42356. /**
  42357. * Add a new key and its corresponding value
  42358. * @param key the key to add
  42359. * @param value the value corresponding to the key
  42360. * @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
  42361. */
  42362. add(key: string, value: T): boolean;
  42363. /**
  42364. * Update a specific value associated to a key
  42365. * @param key defines the key to use
  42366. * @param value defines the value to store
  42367. * @returns true if the value was updated (or false if the key was not found)
  42368. */
  42369. set(key: string, value: T): boolean;
  42370. /**
  42371. * Get the element of the given key and remove it from the dictionary
  42372. * @param key defines the key to search
  42373. * @returns the value associated with the key or null if not found
  42374. */
  42375. getAndRemove(key: string): Nullable<T>;
  42376. /**
  42377. * Remove a key/value from the dictionary.
  42378. * @param key the key to remove
  42379. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  42380. */
  42381. remove(key: string): boolean;
  42382. /**
  42383. * Clear the whole content of the dictionary
  42384. */
  42385. clear(): void;
  42386. /**
  42387. * Gets the current count
  42388. */
  42389. get count(): number;
  42390. /**
  42391. * Execute a callback on each key/val of the dictionary.
  42392. * Note that you can remove any element in this dictionary in the callback implementation
  42393. * @param callback the callback to execute on a given key/value pair
  42394. */
  42395. forEach(callback: (key: string, val: T) => void): void;
  42396. /**
  42397. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  42398. * If the callback returns null or undefined the method will iterate to the next key/value pair
  42399. * Note that you can remove any element in this dictionary in the callback implementation
  42400. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  42401. * @returns the first item
  42402. */
  42403. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  42404. private _count;
  42405. private _data;
  42406. }
  42407. }
  42408. declare module BABYLON {
  42409. /** @hidden */
  42410. export interface ICollisionCoordinator {
  42411. createCollider(): Collider;
  42412. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  42413. init(scene: Scene): void;
  42414. }
  42415. /** @hidden */
  42416. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  42417. private _scene;
  42418. private _scaledPosition;
  42419. private _scaledVelocity;
  42420. private _finalPosition;
  42421. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  42422. createCollider(): Collider;
  42423. init(scene: Scene): void;
  42424. private _collideWithWorld;
  42425. }
  42426. }
  42427. declare module BABYLON {
  42428. /**
  42429. * Class used to manage all inputs for the scene.
  42430. */
  42431. export class InputManager {
  42432. /** The distance in pixel that you have to move to prevent some events */
  42433. static DragMovementThreshold: number;
  42434. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  42435. static LongPressDelay: number;
  42436. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  42437. static DoubleClickDelay: number;
  42438. /** If you need to check double click without raising a single click at first click, enable this flag */
  42439. static ExclusiveDoubleClickMode: boolean;
  42440. /** This is a defensive check to not allow control attachment prior to an already active one. If already attached, previous control is unattached before attaching the new one. */
  42441. private _alreadyAttached;
  42442. private _alreadyAttachedTo;
  42443. private _wheelEventName;
  42444. private _onPointerMove;
  42445. private _onPointerDown;
  42446. private _onPointerUp;
  42447. private _initClickEvent;
  42448. private _initActionManager;
  42449. private _delayedSimpleClick;
  42450. private _delayedSimpleClickTimeout;
  42451. private _previousDelayedSimpleClickTimeout;
  42452. private _meshPickProceed;
  42453. private _previousButtonPressed;
  42454. private _currentPickResult;
  42455. private _previousPickResult;
  42456. private _totalPointersPressed;
  42457. private _doubleClickOccured;
  42458. private _pointerOverMesh;
  42459. private _pickedDownMesh;
  42460. private _pickedUpMesh;
  42461. private _pointerX;
  42462. private _pointerY;
  42463. private _unTranslatedPointerX;
  42464. private _unTranslatedPointerY;
  42465. private _startingPointerPosition;
  42466. private _previousStartingPointerPosition;
  42467. private _startingPointerTime;
  42468. private _previousStartingPointerTime;
  42469. private _pointerCaptures;
  42470. private _meshUnderPointerId;
  42471. private _onKeyDown;
  42472. private _onKeyUp;
  42473. private _keyboardIsAttached;
  42474. private _onCanvasFocusObserver;
  42475. private _onCanvasBlurObserver;
  42476. private _scene;
  42477. /**
  42478. * Creates a new InputManager
  42479. * @param scene defines the hosting scene
  42480. */
  42481. constructor(scene: Scene);
  42482. /**
  42483. * Gets the mesh that is currently under the pointer
  42484. */
  42485. get meshUnderPointer(): Nullable<AbstractMesh>;
  42486. /**
  42487. * When using more than one pointer (for example in XR) you can get the mesh under the specific pointer
  42488. * @param pointerId the pointer id to use
  42489. * @returns The mesh under this pointer id or null if not found
  42490. */
  42491. getMeshUnderPointerByPointerId(pointerId: number): Nullable<AbstractMesh>;
  42492. /**
  42493. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  42494. */
  42495. get unTranslatedPointer(): Vector2;
  42496. /**
  42497. * Gets or sets the current on-screen X position of the pointer
  42498. */
  42499. get pointerX(): number;
  42500. set pointerX(value: number);
  42501. /**
  42502. * Gets or sets the current on-screen Y position of the pointer
  42503. */
  42504. get pointerY(): number;
  42505. set pointerY(value: number);
  42506. private _updatePointerPosition;
  42507. private _processPointerMove;
  42508. private _setRayOnPointerInfo;
  42509. private _checkPrePointerObservable;
  42510. /**
  42511. * Use this method to simulate a pointer move on a mesh
  42512. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  42513. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  42514. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  42515. */
  42516. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  42517. /**
  42518. * Use this method to simulate a pointer down on a mesh
  42519. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  42520. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  42521. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  42522. */
  42523. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  42524. private _processPointerDown;
  42525. /** @hidden */
  42526. _isPointerSwiping(): boolean;
  42527. /**
  42528. * Use this method to simulate a pointer up on a mesh
  42529. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  42530. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  42531. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  42532. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  42533. */
  42534. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  42535. private _processPointerUp;
  42536. /**
  42537. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  42538. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  42539. * @returns true if the pointer was captured
  42540. */
  42541. isPointerCaptured(pointerId?: number): boolean;
  42542. /**
  42543. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  42544. * @param attachUp defines if you want to attach events to pointerup
  42545. * @param attachDown defines if you want to attach events to pointerdown
  42546. * @param attachMove defines if you want to attach events to pointermove
  42547. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  42548. */
  42549. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  42550. /**
  42551. * Detaches all event handlers
  42552. */
  42553. detachControl(): void;
  42554. /**
  42555. * Force the value of meshUnderPointer
  42556. * @param mesh defines the mesh to use
  42557. * @param pointerId optional pointer id when using more than one pointer. Defaults to 0
  42558. */
  42559. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  42560. /**
  42561. * Gets the mesh under the pointer
  42562. * @returns a Mesh or null if no mesh is under the pointer
  42563. */
  42564. getPointerOverMesh(): Nullable<AbstractMesh>;
  42565. }
  42566. }
  42567. declare module BABYLON {
  42568. /**
  42569. * This class defines the direct association between an animation and a target
  42570. */
  42571. export class TargetedAnimation {
  42572. /**
  42573. * Animation to perform
  42574. */
  42575. animation: Animation;
  42576. /**
  42577. * Target to animate
  42578. */
  42579. target: any;
  42580. /**
  42581. * Returns the string "TargetedAnimation"
  42582. * @returns "TargetedAnimation"
  42583. */
  42584. getClassName(): string;
  42585. /**
  42586. * Serialize the object
  42587. * @returns the JSON object representing the current entity
  42588. */
  42589. serialize(): any;
  42590. }
  42591. /**
  42592. * Use this class to create coordinated animations on multiple targets
  42593. */
  42594. export class AnimationGroup implements IDisposable {
  42595. /** The name of the animation group */
  42596. name: string;
  42597. private _scene;
  42598. private _targetedAnimations;
  42599. private _animatables;
  42600. private _from;
  42601. private _to;
  42602. private _isStarted;
  42603. private _isPaused;
  42604. private _speedRatio;
  42605. private _loopAnimation;
  42606. private _isAdditive;
  42607. /**
  42608. * Gets or sets the unique id of the node
  42609. */
  42610. uniqueId: number;
  42611. /**
  42612. * This observable will notify when one animation have ended
  42613. */
  42614. onAnimationEndObservable: Observable<TargetedAnimation>;
  42615. /**
  42616. * Observer raised when one animation loops
  42617. */
  42618. onAnimationLoopObservable: Observable<TargetedAnimation>;
  42619. /**
  42620. * Observer raised when all animations have looped
  42621. */
  42622. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  42623. /**
  42624. * This observable will notify when all animations have ended.
  42625. */
  42626. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  42627. /**
  42628. * This observable will notify when all animations have paused.
  42629. */
  42630. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  42631. /**
  42632. * This observable will notify when all animations are playing.
  42633. */
  42634. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  42635. /**
  42636. * Gets the first frame
  42637. */
  42638. get from(): number;
  42639. /**
  42640. * Gets the last frame
  42641. */
  42642. get to(): number;
  42643. /**
  42644. * Define if the animations are started
  42645. */
  42646. get isStarted(): boolean;
  42647. /**
  42648. * Gets a value indicating that the current group is playing
  42649. */
  42650. get isPlaying(): boolean;
  42651. /**
  42652. * Gets or sets the speed ratio to use for all animations
  42653. */
  42654. get speedRatio(): number;
  42655. /**
  42656. * Gets or sets the speed ratio to use for all animations
  42657. */
  42658. set speedRatio(value: number);
  42659. /**
  42660. * Gets or sets if all animations should loop or not
  42661. */
  42662. get loopAnimation(): boolean;
  42663. set loopAnimation(value: boolean);
  42664. /**
  42665. * Gets or sets if all animations should be evaluated additively
  42666. */
  42667. get isAdditive(): boolean;
  42668. set isAdditive(value: boolean);
  42669. /**
  42670. * Gets the targeted animations for this animation group
  42671. */
  42672. get targetedAnimations(): Array<TargetedAnimation>;
  42673. /**
  42674. * returning the list of animatables controlled by this animation group.
  42675. */
  42676. get animatables(): Array<Animatable>;
  42677. /**
  42678. * Gets the list of target animations
  42679. */
  42680. get children(): TargetedAnimation[];
  42681. /**
  42682. * Instantiates a new Animation Group.
  42683. * This helps managing several animations at once.
  42684. * @see https://doc.babylonjs.com/how_to/group
  42685. * @param name Defines the name of the group
  42686. * @param scene Defines the scene the group belongs to
  42687. */
  42688. constructor(
  42689. /** The name of the animation group */
  42690. name: string, scene?: Nullable<Scene>);
  42691. /**
  42692. * Add an animation (with its target) in the group
  42693. * @param animation defines the animation we want to add
  42694. * @param target defines the target of the animation
  42695. * @returns the TargetedAnimation object
  42696. */
  42697. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  42698. /**
  42699. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  42700. * It can add constant keys at begin or end
  42701. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  42702. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  42703. * @returns the animation group
  42704. */
  42705. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  42706. private _animationLoopCount;
  42707. private _animationLoopFlags;
  42708. private _processLoop;
  42709. /**
  42710. * Start all animations on given targets
  42711. * @param loop defines if animations must loop
  42712. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  42713. * @param from defines the from key (optional)
  42714. * @param to defines the to key (optional)
  42715. * @param isAdditive defines the additive state for the resulting animatables (optional)
  42716. * @returns the current animation group
  42717. */
  42718. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  42719. /**
  42720. * Pause all animations
  42721. * @returns the animation group
  42722. */
  42723. pause(): AnimationGroup;
  42724. /**
  42725. * Play all animations to initial state
  42726. * This function will start() the animations if they were not started or will restart() them if they were paused
  42727. * @param loop defines if animations must loop
  42728. * @returns the animation group
  42729. */
  42730. play(loop?: boolean): AnimationGroup;
  42731. /**
  42732. * Reset all animations to initial state
  42733. * @returns the animation group
  42734. */
  42735. reset(): AnimationGroup;
  42736. /**
  42737. * Restart animations from key 0
  42738. * @returns the animation group
  42739. */
  42740. restart(): AnimationGroup;
  42741. /**
  42742. * Stop all animations
  42743. * @returns the animation group
  42744. */
  42745. stop(): AnimationGroup;
  42746. /**
  42747. * Set animation weight for all animatables
  42748. * @param weight defines the weight to use
  42749. * @return the animationGroup
  42750. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  42751. */
  42752. setWeightForAllAnimatables(weight: number): AnimationGroup;
  42753. /**
  42754. * Synchronize and normalize all animatables with a source animatable
  42755. * @param root defines the root animatable to synchronize with
  42756. * @return the animationGroup
  42757. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  42758. */
  42759. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  42760. /**
  42761. * Goes to a specific frame in this animation group
  42762. * @param frame the frame number to go to
  42763. * @return the animationGroup
  42764. */
  42765. goToFrame(frame: number): AnimationGroup;
  42766. /**
  42767. * Dispose all associated resources
  42768. */
  42769. dispose(): void;
  42770. private _checkAnimationGroupEnded;
  42771. /**
  42772. * Clone the current animation group and returns a copy
  42773. * @param newName defines the name of the new group
  42774. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  42775. * @returns the new aniamtion group
  42776. */
  42777. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  42778. /**
  42779. * Serializes the animationGroup to an object
  42780. * @returns Serialized object
  42781. */
  42782. serialize(): any;
  42783. /**
  42784. * Returns a new AnimationGroup object parsed from the source provided.
  42785. * @param parsedAnimationGroup defines the source
  42786. * @param scene defines the scene that will receive the animationGroup
  42787. * @returns a new AnimationGroup
  42788. */
  42789. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  42790. /**
  42791. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  42792. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  42793. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  42794. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  42795. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  42796. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  42797. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  42798. */
  42799. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  42800. /**
  42801. * Returns the string "AnimationGroup"
  42802. * @returns "AnimationGroup"
  42803. */
  42804. getClassName(): string;
  42805. /**
  42806. * Creates a detailled string about the object
  42807. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  42808. * @returns a string representing the object
  42809. */
  42810. toString(fullDetails?: boolean): string;
  42811. }
  42812. }
  42813. declare module BABYLON {
  42814. /**
  42815. * Define an interface for all classes that will hold resources
  42816. */
  42817. export interface IDisposable {
  42818. /**
  42819. * Releases all held resources
  42820. */
  42821. dispose(): void;
  42822. }
  42823. /** Interface defining initialization parameters for Scene class */
  42824. export interface SceneOptions {
  42825. /**
  42826. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  42827. * It will improve performance when the number of geometries becomes important.
  42828. */
  42829. useGeometryUniqueIdsMap?: boolean;
  42830. /**
  42831. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  42832. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  42833. */
  42834. useMaterialMeshMap?: boolean;
  42835. /**
  42836. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  42837. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  42838. */
  42839. useClonedMeshMap?: boolean;
  42840. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  42841. virtual?: boolean;
  42842. }
  42843. /**
  42844. * Represents a scene to be rendered by the engine.
  42845. * @see https://doc.babylonjs.com/features/scene
  42846. */
  42847. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  42848. /** The fog is deactivated */
  42849. static readonly FOGMODE_NONE: number;
  42850. /** The fog density is following an exponential function */
  42851. static readonly FOGMODE_EXP: number;
  42852. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  42853. static readonly FOGMODE_EXP2: number;
  42854. /** The fog density is following a linear function. */
  42855. static readonly FOGMODE_LINEAR: number;
  42856. /**
  42857. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  42858. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  42859. */
  42860. static MinDeltaTime: number;
  42861. /**
  42862. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  42863. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  42864. */
  42865. static MaxDeltaTime: number;
  42866. /**
  42867. * Factory used to create the default material.
  42868. * @param name The name of the material to create
  42869. * @param scene The scene to create the material for
  42870. * @returns The default material
  42871. */
  42872. static DefaultMaterialFactory(scene: Scene): Material;
  42873. /**
  42874. * Factory used to create the a collision coordinator.
  42875. * @returns The collision coordinator
  42876. */
  42877. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  42878. /** @hidden */
  42879. _inputManager: InputManager;
  42880. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  42881. cameraToUseForPointers: Nullable<Camera>;
  42882. /** @hidden */
  42883. readonly _isScene: boolean;
  42884. /** @hidden */
  42885. _blockEntityCollection: boolean;
  42886. /**
  42887. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  42888. */
  42889. autoClear: boolean;
  42890. /**
  42891. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  42892. */
  42893. autoClearDepthAndStencil: boolean;
  42894. /**
  42895. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  42896. */
  42897. clearColor: Color4;
  42898. /**
  42899. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  42900. */
  42901. ambientColor: Color3;
  42902. /**
  42903. * This is use to store the default BRDF lookup for PBR materials in your scene.
  42904. * It should only be one of the following (if not the default embedded one):
  42905. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  42906. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  42907. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  42908. * The material properties need to be setup according to the type of texture in use.
  42909. */
  42910. environmentBRDFTexture: BaseTexture;
  42911. /**
  42912. * Texture used in all pbr material as the reflection texture.
  42913. * As in the majority of the scene they are the same (exception for multi room and so on),
  42914. * this is easier to reference from here than from all the materials.
  42915. */
  42916. get environmentTexture(): Nullable<BaseTexture>;
  42917. /**
  42918. * Texture used in all pbr material as the reflection texture.
  42919. * As in the majority of the scene they are the same (exception for multi room and so on),
  42920. * this is easier to set here than in all the materials.
  42921. */
  42922. set environmentTexture(value: Nullable<BaseTexture>);
  42923. /** @hidden */
  42924. protected _environmentIntensity: number;
  42925. /**
  42926. * Intensity of the environment in all pbr material.
  42927. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  42928. * As in the majority of the scene they are the same (exception for multi room and so on),
  42929. * this is easier to reference from here than from all the materials.
  42930. */
  42931. get environmentIntensity(): number;
  42932. /**
  42933. * Intensity of the environment in all pbr material.
  42934. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  42935. * As in the majority of the scene they are the same (exception for multi room and so on),
  42936. * this is easier to set here than in all the materials.
  42937. */
  42938. set environmentIntensity(value: number);
  42939. /** @hidden */
  42940. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  42941. /**
  42942. * Default image processing configuration used either in the rendering
  42943. * Forward main pass or through the imageProcessingPostProcess if present.
  42944. * As in the majority of the scene they are the same (exception for multi camera),
  42945. * this is easier to reference from here than from all the materials and post process.
  42946. *
  42947. * No setter as we it is a shared configuration, you can set the values instead.
  42948. */
  42949. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  42950. private _forceWireframe;
  42951. /**
  42952. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  42953. */
  42954. set forceWireframe(value: boolean);
  42955. get forceWireframe(): boolean;
  42956. private _skipFrustumClipping;
  42957. /**
  42958. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  42959. */
  42960. set skipFrustumClipping(value: boolean);
  42961. get skipFrustumClipping(): boolean;
  42962. private _forcePointsCloud;
  42963. /**
  42964. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  42965. */
  42966. set forcePointsCloud(value: boolean);
  42967. get forcePointsCloud(): boolean;
  42968. /**
  42969. * Gets or sets the active clipplane 1
  42970. */
  42971. clipPlane: Nullable<Plane>;
  42972. /**
  42973. * Gets or sets the active clipplane 2
  42974. */
  42975. clipPlane2: Nullable<Plane>;
  42976. /**
  42977. * Gets or sets the active clipplane 3
  42978. */
  42979. clipPlane3: Nullable<Plane>;
  42980. /**
  42981. * Gets or sets the active clipplane 4
  42982. */
  42983. clipPlane4: Nullable<Plane>;
  42984. /**
  42985. * Gets or sets the active clipplane 5
  42986. */
  42987. clipPlane5: Nullable<Plane>;
  42988. /**
  42989. * Gets or sets the active clipplane 6
  42990. */
  42991. clipPlane6: Nullable<Plane>;
  42992. /**
  42993. * Gets or sets a boolean indicating if animations are enabled
  42994. */
  42995. animationsEnabled: boolean;
  42996. private _animationPropertiesOverride;
  42997. /**
  42998. * Gets or sets the animation properties override
  42999. */
  43000. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  43001. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  43002. /**
  43003. * Gets or sets a boolean indicating if a constant deltatime has to be used
  43004. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  43005. */
  43006. useConstantAnimationDeltaTime: boolean;
  43007. /**
  43008. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  43009. * Please note that it requires to run a ray cast through the scene on every frame
  43010. */
  43011. constantlyUpdateMeshUnderPointer: boolean;
  43012. /**
  43013. * Defines the HTML cursor to use when hovering over interactive elements
  43014. */
  43015. hoverCursor: string;
  43016. /**
  43017. * Defines the HTML default cursor to use (empty by default)
  43018. */
  43019. defaultCursor: string;
  43020. /**
  43021. * Defines whether cursors are handled by the scene.
  43022. */
  43023. doNotHandleCursors: boolean;
  43024. /**
  43025. * This is used to call preventDefault() on pointer down
  43026. * in order to block unwanted artifacts like system double clicks
  43027. */
  43028. preventDefaultOnPointerDown: boolean;
  43029. /**
  43030. * This is used to call preventDefault() on pointer up
  43031. * in order to block unwanted artifacts like system double clicks
  43032. */
  43033. preventDefaultOnPointerUp: boolean;
  43034. /**
  43035. * Gets or sets user defined metadata
  43036. */
  43037. metadata: any;
  43038. /**
  43039. * For internal use only. Please do not use.
  43040. */
  43041. reservedDataStore: any;
  43042. /**
  43043. * Gets the name of the plugin used to load this scene (null by default)
  43044. */
  43045. loadingPluginName: string;
  43046. /**
  43047. * Use this array to add regular expressions used to disable offline support for specific urls
  43048. */
  43049. disableOfflineSupportExceptionRules: RegExp[];
  43050. /**
  43051. * An event triggered when the scene is disposed.
  43052. */
  43053. onDisposeObservable: Observable<Scene>;
  43054. private _onDisposeObserver;
  43055. /** Sets a function to be executed when this scene is disposed. */
  43056. set onDispose(callback: () => void);
  43057. /**
  43058. * An event triggered before rendering the scene (right after animations and physics)
  43059. */
  43060. onBeforeRenderObservable: Observable<Scene>;
  43061. private _onBeforeRenderObserver;
  43062. /** Sets a function to be executed before rendering this scene */
  43063. set beforeRender(callback: Nullable<() => void>);
  43064. /**
  43065. * An event triggered after rendering the scene
  43066. */
  43067. onAfterRenderObservable: Observable<Scene>;
  43068. /**
  43069. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  43070. */
  43071. onAfterRenderCameraObservable: Observable<Camera>;
  43072. private _onAfterRenderObserver;
  43073. /** Sets a function to be executed after rendering this scene */
  43074. set afterRender(callback: Nullable<() => void>);
  43075. /**
  43076. * An event triggered before animating the scene
  43077. */
  43078. onBeforeAnimationsObservable: Observable<Scene>;
  43079. /**
  43080. * An event triggered after animations processing
  43081. */
  43082. onAfterAnimationsObservable: Observable<Scene>;
  43083. /**
  43084. * An event triggered before draw calls are ready to be sent
  43085. */
  43086. onBeforeDrawPhaseObservable: Observable<Scene>;
  43087. /**
  43088. * An event triggered after draw calls have been sent
  43089. */
  43090. onAfterDrawPhaseObservable: Observable<Scene>;
  43091. /**
  43092. * An event triggered when the scene is ready
  43093. */
  43094. onReadyObservable: Observable<Scene>;
  43095. /**
  43096. * An event triggered before rendering a camera
  43097. */
  43098. onBeforeCameraRenderObservable: Observable<Camera>;
  43099. private _onBeforeCameraRenderObserver;
  43100. /** Sets a function to be executed before rendering a camera*/
  43101. set beforeCameraRender(callback: () => void);
  43102. /**
  43103. * An event triggered after rendering a camera
  43104. */
  43105. onAfterCameraRenderObservable: Observable<Camera>;
  43106. private _onAfterCameraRenderObserver;
  43107. /** Sets a function to be executed after rendering a camera*/
  43108. set afterCameraRender(callback: () => void);
  43109. /**
  43110. * An event triggered when active meshes evaluation is about to start
  43111. */
  43112. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  43113. /**
  43114. * An event triggered when active meshes evaluation is done
  43115. */
  43116. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  43117. /**
  43118. * An event triggered when particles rendering is about to start
  43119. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  43120. */
  43121. onBeforeParticlesRenderingObservable: Observable<Scene>;
  43122. /**
  43123. * An event triggered when particles rendering is done
  43124. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  43125. */
  43126. onAfterParticlesRenderingObservable: Observable<Scene>;
  43127. /**
  43128. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  43129. */
  43130. onDataLoadedObservable: Observable<Scene>;
  43131. /**
  43132. * An event triggered when a camera is created
  43133. */
  43134. onNewCameraAddedObservable: Observable<Camera>;
  43135. /**
  43136. * An event triggered when a camera is removed
  43137. */
  43138. onCameraRemovedObservable: Observable<Camera>;
  43139. /**
  43140. * An event triggered when a light is created
  43141. */
  43142. onNewLightAddedObservable: Observable<Light>;
  43143. /**
  43144. * An event triggered when a light is removed
  43145. */
  43146. onLightRemovedObservable: Observable<Light>;
  43147. /**
  43148. * An event triggered when a geometry is created
  43149. */
  43150. onNewGeometryAddedObservable: Observable<Geometry>;
  43151. /**
  43152. * An event triggered when a geometry is removed
  43153. */
  43154. onGeometryRemovedObservable: Observable<Geometry>;
  43155. /**
  43156. * An event triggered when a transform node is created
  43157. */
  43158. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  43159. /**
  43160. * An event triggered when a transform node is removed
  43161. */
  43162. onTransformNodeRemovedObservable: Observable<TransformNode>;
  43163. /**
  43164. * An event triggered when a mesh is created
  43165. */
  43166. onNewMeshAddedObservable: Observable<AbstractMesh>;
  43167. /**
  43168. * An event triggered when a mesh is removed
  43169. */
  43170. onMeshRemovedObservable: Observable<AbstractMesh>;
  43171. /**
  43172. * An event triggered when a skeleton is created
  43173. */
  43174. onNewSkeletonAddedObservable: Observable<Skeleton>;
  43175. /**
  43176. * An event triggered when a skeleton is removed
  43177. */
  43178. onSkeletonRemovedObservable: Observable<Skeleton>;
  43179. /**
  43180. * An event triggered when a material is created
  43181. */
  43182. onNewMaterialAddedObservable: Observable<Material>;
  43183. /**
  43184. * An event triggered when a multi material is created
  43185. */
  43186. onNewMultiMaterialAddedObservable: Observable<MultiMaterial>;
  43187. /**
  43188. * An event triggered when a material is removed
  43189. */
  43190. onMaterialRemovedObservable: Observable<Material>;
  43191. /**
  43192. * An event triggered when a multi material is removed
  43193. */
  43194. onMultiMaterialRemovedObservable: Observable<MultiMaterial>;
  43195. /**
  43196. * An event triggered when a texture is created
  43197. */
  43198. onNewTextureAddedObservable: Observable<BaseTexture>;
  43199. /**
  43200. * An event triggered when a texture is removed
  43201. */
  43202. onTextureRemovedObservable: Observable<BaseTexture>;
  43203. /**
  43204. * An event triggered when render targets are about to be rendered
  43205. * Can happen multiple times per frame.
  43206. */
  43207. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  43208. /**
  43209. * An event triggered when render targets were rendered.
  43210. * Can happen multiple times per frame.
  43211. */
  43212. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  43213. /**
  43214. * An event triggered before calculating deterministic simulation step
  43215. */
  43216. onBeforeStepObservable: Observable<Scene>;
  43217. /**
  43218. * An event triggered after calculating deterministic simulation step
  43219. */
  43220. onAfterStepObservable: Observable<Scene>;
  43221. /**
  43222. * An event triggered when the activeCamera property is updated
  43223. */
  43224. onActiveCameraChanged: Observable<Scene>;
  43225. /**
  43226. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  43227. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  43228. * 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)
  43229. */
  43230. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  43231. /**
  43232. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  43233. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  43234. * 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)
  43235. */
  43236. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  43237. /**
  43238. * This Observable will when a mesh has been imported into the scene.
  43239. */
  43240. onMeshImportedObservable: Observable<AbstractMesh>;
  43241. /**
  43242. * This Observable will when an animation file has been imported into the scene.
  43243. */
  43244. onAnimationFileImportedObservable: Observable<Scene>;
  43245. /**
  43246. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  43247. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  43248. */
  43249. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  43250. /** @hidden */
  43251. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  43252. /**
  43253. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  43254. */
  43255. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  43256. /**
  43257. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  43258. */
  43259. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  43260. /**
  43261. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  43262. */
  43263. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  43264. /** Callback called when a pointer move is detected */
  43265. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  43266. /** Callback called when a pointer down is detected */
  43267. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  43268. /** Callback called when a pointer up is detected */
  43269. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  43270. /** Callback called when a pointer pick is detected */
  43271. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  43272. /**
  43273. * 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).
  43274. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  43275. */
  43276. onPrePointerObservable: Observable<PointerInfoPre>;
  43277. /**
  43278. * Observable event triggered each time an input event is received from the rendering canvas
  43279. */
  43280. onPointerObservable: Observable<PointerInfo>;
  43281. /**
  43282. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  43283. */
  43284. get unTranslatedPointer(): Vector2;
  43285. /**
  43286. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  43287. */
  43288. static get DragMovementThreshold(): number;
  43289. static set DragMovementThreshold(value: number);
  43290. /**
  43291. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  43292. */
  43293. static get LongPressDelay(): number;
  43294. static set LongPressDelay(value: number);
  43295. /**
  43296. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  43297. */
  43298. static get DoubleClickDelay(): number;
  43299. static set DoubleClickDelay(value: number);
  43300. /** If you need to check double click without raising a single click at first click, enable this flag */
  43301. static get ExclusiveDoubleClickMode(): boolean;
  43302. static set ExclusiveDoubleClickMode(value: boolean);
  43303. /** @hidden */
  43304. _mirroredCameraPosition: Nullable<Vector3>;
  43305. /**
  43306. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  43307. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  43308. */
  43309. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  43310. /**
  43311. * Observable event triggered each time an keyboard event is received from the hosting window
  43312. */
  43313. onKeyboardObservable: Observable<KeyboardInfo>;
  43314. private _useRightHandedSystem;
  43315. /**
  43316. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  43317. */
  43318. set useRightHandedSystem(value: boolean);
  43319. get useRightHandedSystem(): boolean;
  43320. private _timeAccumulator;
  43321. private _currentStepId;
  43322. private _currentInternalStep;
  43323. /**
  43324. * Sets the step Id used by deterministic lock step
  43325. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  43326. * @param newStepId defines the step Id
  43327. */
  43328. setStepId(newStepId: number): void;
  43329. /**
  43330. * Gets the step Id used by deterministic lock step
  43331. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  43332. * @returns the step Id
  43333. */
  43334. getStepId(): number;
  43335. /**
  43336. * Gets the internal step used by deterministic lock step
  43337. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  43338. * @returns the internal step
  43339. */
  43340. getInternalStep(): number;
  43341. private _fogEnabled;
  43342. /**
  43343. * Gets or sets a boolean indicating if fog is enabled on this scene
  43344. * @see https://doc.babylonjs.com/babylon101/environment#fog
  43345. * (Default is true)
  43346. */
  43347. set fogEnabled(value: boolean);
  43348. get fogEnabled(): boolean;
  43349. private _fogMode;
  43350. /**
  43351. * Gets or sets the fog mode to use
  43352. * @see https://doc.babylonjs.com/babylon101/environment#fog
  43353. * | mode | value |
  43354. * | --- | --- |
  43355. * | FOGMODE_NONE | 0 |
  43356. * | FOGMODE_EXP | 1 |
  43357. * | FOGMODE_EXP2 | 2 |
  43358. * | FOGMODE_LINEAR | 3 |
  43359. */
  43360. set fogMode(value: number);
  43361. get fogMode(): number;
  43362. /**
  43363. * Gets or sets the fog color to use
  43364. * @see https://doc.babylonjs.com/babylon101/environment#fog
  43365. * (Default is Color3(0.2, 0.2, 0.3))
  43366. */
  43367. fogColor: Color3;
  43368. /**
  43369. * Gets or sets the fog density to use
  43370. * @see https://doc.babylonjs.com/babylon101/environment#fog
  43371. * (Default is 0.1)
  43372. */
  43373. fogDensity: number;
  43374. /**
  43375. * Gets or sets the fog start distance to use
  43376. * @see https://doc.babylonjs.com/babylon101/environment#fog
  43377. * (Default is 0)
  43378. */
  43379. fogStart: number;
  43380. /**
  43381. * Gets or sets the fog end distance to use
  43382. * @see https://doc.babylonjs.com/babylon101/environment#fog
  43383. * (Default is 1000)
  43384. */
  43385. fogEnd: number;
  43386. /**
  43387. * Flag indicating that the frame buffer binding is handled by another component
  43388. */
  43389. prePass: boolean;
  43390. private _shadowsEnabled;
  43391. /**
  43392. * Gets or sets a boolean indicating if shadows are enabled on this scene
  43393. */
  43394. set shadowsEnabled(value: boolean);
  43395. get shadowsEnabled(): boolean;
  43396. private _lightsEnabled;
  43397. /**
  43398. * Gets or sets a boolean indicating if lights are enabled on this scene
  43399. */
  43400. set lightsEnabled(value: boolean);
  43401. get lightsEnabled(): boolean;
  43402. /** All of the active cameras added to this scene. */
  43403. activeCameras: Camera[];
  43404. /** @hidden */
  43405. _activeCamera: Nullable<Camera>;
  43406. /** Gets or sets the current active camera */
  43407. get activeCamera(): Nullable<Camera>;
  43408. set activeCamera(value: Nullable<Camera>);
  43409. private _defaultMaterial;
  43410. /** The default material used on meshes when no material is affected */
  43411. get defaultMaterial(): Material;
  43412. /** The default material used on meshes when no material is affected */
  43413. set defaultMaterial(value: Material);
  43414. private _texturesEnabled;
  43415. /**
  43416. * Gets or sets a boolean indicating if textures are enabled on this scene
  43417. */
  43418. set texturesEnabled(value: boolean);
  43419. get texturesEnabled(): boolean;
  43420. /**
  43421. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  43422. */
  43423. physicsEnabled: boolean;
  43424. /**
  43425. * Gets or sets a boolean indicating if particles are enabled on this scene
  43426. */
  43427. particlesEnabled: boolean;
  43428. /**
  43429. * Gets or sets a boolean indicating if sprites are enabled on this scene
  43430. */
  43431. spritesEnabled: boolean;
  43432. private _skeletonsEnabled;
  43433. /**
  43434. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  43435. */
  43436. set skeletonsEnabled(value: boolean);
  43437. get skeletonsEnabled(): boolean;
  43438. /**
  43439. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  43440. */
  43441. lensFlaresEnabled: boolean;
  43442. /**
  43443. * Gets or sets a boolean indicating if collisions are enabled on this scene
  43444. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  43445. */
  43446. collisionsEnabled: boolean;
  43447. private _collisionCoordinator;
  43448. /** @hidden */
  43449. get collisionCoordinator(): ICollisionCoordinator;
  43450. /**
  43451. * Defines the gravity applied to this scene (used only for collisions)
  43452. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  43453. */
  43454. gravity: Vector3;
  43455. /**
  43456. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  43457. */
  43458. postProcessesEnabled: boolean;
  43459. /**
  43460. * Gets the current postprocess manager
  43461. */
  43462. postProcessManager: PostProcessManager;
  43463. /**
  43464. * Gets or sets a boolean indicating if render targets are enabled on this scene
  43465. */
  43466. renderTargetsEnabled: boolean;
  43467. /**
  43468. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  43469. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  43470. */
  43471. dumpNextRenderTargets: boolean;
  43472. /**
  43473. * The list of user defined render targets added to the scene
  43474. */
  43475. customRenderTargets: RenderTargetTexture[];
  43476. /**
  43477. * Defines if texture loading must be delayed
  43478. * If true, textures will only be loaded when they need to be rendered
  43479. */
  43480. useDelayedTextureLoading: boolean;
  43481. /**
  43482. * Gets the list of meshes imported to the scene through SceneLoader
  43483. */
  43484. importedMeshesFiles: String[];
  43485. /**
  43486. * Gets or sets a boolean indicating if probes are enabled on this scene
  43487. */
  43488. probesEnabled: boolean;
  43489. /**
  43490. * Gets or sets the current offline provider to use to store scene data
  43491. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  43492. */
  43493. offlineProvider: IOfflineProvider;
  43494. /**
  43495. * Gets or sets the action manager associated with the scene
  43496. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  43497. */
  43498. actionManager: AbstractActionManager;
  43499. private _meshesForIntersections;
  43500. /**
  43501. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  43502. */
  43503. proceduralTexturesEnabled: boolean;
  43504. private _engine;
  43505. private _totalVertices;
  43506. /** @hidden */
  43507. _activeIndices: PerfCounter;
  43508. /** @hidden */
  43509. _activeParticles: PerfCounter;
  43510. /** @hidden */
  43511. _activeBones: PerfCounter;
  43512. private _animationRatio;
  43513. /** @hidden */
  43514. _animationTimeLast: number;
  43515. /** @hidden */
  43516. _animationTime: number;
  43517. /**
  43518. * Gets or sets a general scale for animation speed
  43519. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  43520. */
  43521. animationTimeScale: number;
  43522. /** @hidden */
  43523. _cachedMaterial: Nullable<Material>;
  43524. /** @hidden */
  43525. _cachedEffect: Nullable<Effect>;
  43526. /** @hidden */
  43527. _cachedVisibility: Nullable<number>;
  43528. private _renderId;
  43529. private _frameId;
  43530. private _executeWhenReadyTimeoutId;
  43531. private _intermediateRendering;
  43532. private _viewUpdateFlag;
  43533. private _projectionUpdateFlag;
  43534. /** @hidden */
  43535. _toBeDisposed: Nullable<IDisposable>[];
  43536. private _activeRequests;
  43537. /** @hidden */
  43538. _pendingData: any[];
  43539. private _isDisposed;
  43540. /**
  43541. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  43542. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  43543. */
  43544. dispatchAllSubMeshesOfActiveMeshes: boolean;
  43545. private _activeMeshes;
  43546. private _processedMaterials;
  43547. private _renderTargets;
  43548. /** @hidden */
  43549. _activeParticleSystems: SmartArray<IParticleSystem>;
  43550. private _activeSkeletons;
  43551. private _softwareSkinnedMeshes;
  43552. private _renderingManager;
  43553. /** @hidden */
  43554. _activeAnimatables: Animatable[];
  43555. private _transformMatrix;
  43556. private _sceneUbo;
  43557. /** @hidden */
  43558. _viewMatrix: Matrix;
  43559. private _projectionMatrix;
  43560. /** @hidden */
  43561. _forcedViewPosition: Nullable<Vector3>;
  43562. /** @hidden */
  43563. _frustumPlanes: Plane[];
  43564. /**
  43565. * Gets the list of frustum planes (built from the active camera)
  43566. */
  43567. get frustumPlanes(): Plane[];
  43568. /**
  43569. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  43570. * This is useful if there are more lights that the maximum simulteanous authorized
  43571. */
  43572. requireLightSorting: boolean;
  43573. /** @hidden */
  43574. readonly useMaterialMeshMap: boolean;
  43575. /** @hidden */
  43576. readonly useClonedMeshMap: boolean;
  43577. private _externalData;
  43578. private _uid;
  43579. /**
  43580. * @hidden
  43581. * Backing store of defined scene components.
  43582. */
  43583. _components: ISceneComponent[];
  43584. /**
  43585. * @hidden
  43586. * Backing store of defined scene components.
  43587. */
  43588. _serializableComponents: ISceneSerializableComponent[];
  43589. /**
  43590. * List of components to register on the next registration step.
  43591. */
  43592. private _transientComponents;
  43593. /**
  43594. * Registers the transient components if needed.
  43595. */
  43596. private _registerTransientComponents;
  43597. /**
  43598. * @hidden
  43599. * Add a component to the scene.
  43600. * Note that the ccomponent could be registered on th next frame if this is called after
  43601. * the register component stage.
  43602. * @param component Defines the component to add to the scene
  43603. */
  43604. _addComponent(component: ISceneComponent): void;
  43605. /**
  43606. * @hidden
  43607. * Gets a component from the scene.
  43608. * @param name defines the name of the component to retrieve
  43609. * @returns the component or null if not present
  43610. */
  43611. _getComponent(name: string): Nullable<ISceneComponent>;
  43612. /**
  43613. * @hidden
  43614. * Defines the actions happening before camera updates.
  43615. */
  43616. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  43617. /**
  43618. * @hidden
  43619. * Defines the actions happening before clear the canvas.
  43620. */
  43621. _beforeClearStage: Stage<SimpleStageAction>;
  43622. /**
  43623. * @hidden
  43624. * Defines the actions when collecting render targets for the frame.
  43625. */
  43626. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  43627. /**
  43628. * @hidden
  43629. * Defines the actions happening for one camera in the frame.
  43630. */
  43631. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  43632. /**
  43633. * @hidden
  43634. * Defines the actions happening during the per mesh ready checks.
  43635. */
  43636. _isReadyForMeshStage: Stage<MeshStageAction>;
  43637. /**
  43638. * @hidden
  43639. * Defines the actions happening before evaluate active mesh checks.
  43640. */
  43641. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  43642. /**
  43643. * @hidden
  43644. * Defines the actions happening during the evaluate sub mesh checks.
  43645. */
  43646. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  43647. /**
  43648. * @hidden
  43649. * Defines the actions happening during the active mesh stage.
  43650. */
  43651. _preActiveMeshStage: Stage<PreActiveMeshStageAction>;
  43652. /**
  43653. * @hidden
  43654. * Defines the actions happening during the per camera render target step.
  43655. */
  43656. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  43657. /**
  43658. * @hidden
  43659. * Defines the actions happening just before the active camera is drawing.
  43660. */
  43661. _beforeCameraDrawStage: Stage<CameraStageAction>;
  43662. /**
  43663. * @hidden
  43664. * Defines the actions happening just before a render target is drawing.
  43665. */
  43666. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  43667. /**
  43668. * @hidden
  43669. * Defines the actions happening just before a rendering group is drawing.
  43670. */
  43671. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  43672. /**
  43673. * @hidden
  43674. * Defines the actions happening just before a mesh is drawing.
  43675. */
  43676. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  43677. /**
  43678. * @hidden
  43679. * Defines the actions happening just after a mesh has been drawn.
  43680. */
  43681. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  43682. /**
  43683. * @hidden
  43684. * Defines the actions happening just after a rendering group has been drawn.
  43685. */
  43686. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  43687. /**
  43688. * @hidden
  43689. * Defines the actions happening just after the active camera has been drawn.
  43690. */
  43691. _afterCameraDrawStage: Stage<CameraStageAction>;
  43692. /**
  43693. * @hidden
  43694. * Defines the actions happening just after a render target has been drawn.
  43695. */
  43696. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  43697. /**
  43698. * @hidden
  43699. * Defines the actions happening just after rendering all cameras and computing intersections.
  43700. */
  43701. _afterRenderStage: Stage<SimpleStageAction>;
  43702. /**
  43703. * @hidden
  43704. * Defines the actions happening when a pointer move event happens.
  43705. */
  43706. _pointerMoveStage: Stage<PointerMoveStageAction>;
  43707. /**
  43708. * @hidden
  43709. * Defines the actions happening when a pointer down event happens.
  43710. */
  43711. _pointerDownStage: Stage<PointerUpDownStageAction>;
  43712. /**
  43713. * @hidden
  43714. * Defines the actions happening when a pointer up event happens.
  43715. */
  43716. _pointerUpStage: Stage<PointerUpDownStageAction>;
  43717. /**
  43718. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  43719. */
  43720. private geometriesByUniqueId;
  43721. /**
  43722. * Creates a new Scene
  43723. * @param engine defines the engine to use to render this scene
  43724. * @param options defines the scene options
  43725. */
  43726. constructor(engine: Engine, options?: SceneOptions);
  43727. /**
  43728. * Gets a string identifying the name of the class
  43729. * @returns "Scene" string
  43730. */
  43731. getClassName(): string;
  43732. private _defaultMeshCandidates;
  43733. /**
  43734. * @hidden
  43735. */
  43736. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  43737. private _defaultSubMeshCandidates;
  43738. /**
  43739. * @hidden
  43740. */
  43741. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  43742. /**
  43743. * Sets the default candidate providers for the scene.
  43744. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  43745. * and getCollidingSubMeshCandidates to their default function
  43746. */
  43747. setDefaultCandidateProviders(): void;
  43748. /**
  43749. * Gets the mesh that is currently under the pointer
  43750. */
  43751. get meshUnderPointer(): Nullable<AbstractMesh>;
  43752. /**
  43753. * Gets or sets the current on-screen X position of the pointer
  43754. */
  43755. get pointerX(): number;
  43756. set pointerX(value: number);
  43757. /**
  43758. * Gets or sets the current on-screen Y position of the pointer
  43759. */
  43760. get pointerY(): number;
  43761. set pointerY(value: number);
  43762. /**
  43763. * Gets the cached material (ie. the latest rendered one)
  43764. * @returns the cached material
  43765. */
  43766. getCachedMaterial(): Nullable<Material>;
  43767. /**
  43768. * Gets the cached effect (ie. the latest rendered one)
  43769. * @returns the cached effect
  43770. */
  43771. getCachedEffect(): Nullable<Effect>;
  43772. /**
  43773. * Gets the cached visibility state (ie. the latest rendered one)
  43774. * @returns the cached visibility state
  43775. */
  43776. getCachedVisibility(): Nullable<number>;
  43777. /**
  43778. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  43779. * @param material defines the current material
  43780. * @param effect defines the current effect
  43781. * @param visibility defines the current visibility state
  43782. * @returns true if one parameter is not cached
  43783. */
  43784. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  43785. /**
  43786. * Gets the engine associated with the scene
  43787. * @returns an Engine
  43788. */
  43789. getEngine(): Engine;
  43790. /**
  43791. * Gets the total number of vertices rendered per frame
  43792. * @returns the total number of vertices rendered per frame
  43793. */
  43794. getTotalVertices(): number;
  43795. /**
  43796. * Gets the performance counter for total vertices
  43797. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  43798. */
  43799. get totalVerticesPerfCounter(): PerfCounter;
  43800. /**
  43801. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  43802. * @returns the total number of active indices rendered per frame
  43803. */
  43804. getActiveIndices(): number;
  43805. /**
  43806. * Gets the performance counter for active indices
  43807. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  43808. */
  43809. get totalActiveIndicesPerfCounter(): PerfCounter;
  43810. /**
  43811. * Gets the total number of active particles rendered per frame
  43812. * @returns the total number of active particles rendered per frame
  43813. */
  43814. getActiveParticles(): number;
  43815. /**
  43816. * Gets the performance counter for active particles
  43817. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  43818. */
  43819. get activeParticlesPerfCounter(): PerfCounter;
  43820. /**
  43821. * Gets the total number of active bones rendered per frame
  43822. * @returns the total number of active bones rendered per frame
  43823. */
  43824. getActiveBones(): number;
  43825. /**
  43826. * Gets the performance counter for active bones
  43827. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  43828. */
  43829. get activeBonesPerfCounter(): PerfCounter;
  43830. /**
  43831. * Gets the array of active meshes
  43832. * @returns an array of AbstractMesh
  43833. */
  43834. getActiveMeshes(): SmartArray<AbstractMesh>;
  43835. /**
  43836. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  43837. * @returns a number
  43838. */
  43839. getAnimationRatio(): number;
  43840. /**
  43841. * Gets an unique Id for the current render phase
  43842. * @returns a number
  43843. */
  43844. getRenderId(): number;
  43845. /**
  43846. * Gets an unique Id for the current frame
  43847. * @returns a number
  43848. */
  43849. getFrameId(): number;
  43850. /** Call this function if you want to manually increment the render Id*/
  43851. incrementRenderId(): void;
  43852. private _createUbo;
  43853. /**
  43854. * Use this method to simulate a pointer move on a mesh
  43855. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  43856. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  43857. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  43858. * @returns the current scene
  43859. */
  43860. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  43861. /**
  43862. * Use this method to simulate a pointer down on a mesh
  43863. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  43864. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  43865. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  43866. * @returns the current scene
  43867. */
  43868. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  43869. /**
  43870. * Use this method to simulate a pointer up on a mesh
  43871. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  43872. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  43873. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  43874. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  43875. * @returns the current scene
  43876. */
  43877. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  43878. /**
  43879. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  43880. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  43881. * @returns true if the pointer was captured
  43882. */
  43883. isPointerCaptured(pointerId?: number): boolean;
  43884. /**
  43885. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  43886. * @param attachUp defines if you want to attach events to pointerup
  43887. * @param attachDown defines if you want to attach events to pointerdown
  43888. * @param attachMove defines if you want to attach events to pointermove
  43889. */
  43890. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  43891. /** Detaches all event handlers*/
  43892. detachControl(): void;
  43893. /**
  43894. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  43895. * Delay loaded resources are not taking in account
  43896. * @return true if all required resources are ready
  43897. */
  43898. isReady(): boolean;
  43899. /** Resets all cached information relative to material (including effect and visibility) */
  43900. resetCachedMaterial(): void;
  43901. /**
  43902. * Registers a function to be called before every frame render
  43903. * @param func defines the function to register
  43904. */
  43905. registerBeforeRender(func: () => void): void;
  43906. /**
  43907. * Unregisters a function called before every frame render
  43908. * @param func defines the function to unregister
  43909. */
  43910. unregisterBeforeRender(func: () => void): void;
  43911. /**
  43912. * Registers a function to be called after every frame render
  43913. * @param func defines the function to register
  43914. */
  43915. registerAfterRender(func: () => void): void;
  43916. /**
  43917. * Unregisters a function called after every frame render
  43918. * @param func defines the function to unregister
  43919. */
  43920. unregisterAfterRender(func: () => void): void;
  43921. private _executeOnceBeforeRender;
  43922. /**
  43923. * The provided function will run before render once and will be disposed afterwards.
  43924. * A timeout delay can be provided so that the function will be executed in N ms.
  43925. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  43926. * @param func The function to be executed.
  43927. * @param timeout optional delay in ms
  43928. */
  43929. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  43930. /** @hidden */
  43931. _addPendingData(data: any): void;
  43932. /** @hidden */
  43933. _removePendingData(data: any): void;
  43934. /**
  43935. * Returns the number of items waiting to be loaded
  43936. * @returns the number of items waiting to be loaded
  43937. */
  43938. getWaitingItemsCount(): number;
  43939. /**
  43940. * Returns a boolean indicating if the scene is still loading data
  43941. */
  43942. get isLoading(): boolean;
  43943. /**
  43944. * Registers a function to be executed when the scene is ready
  43945. * @param {Function} func - the function to be executed
  43946. */
  43947. executeWhenReady(func: () => void): void;
  43948. /**
  43949. * Returns a promise that resolves when the scene is ready
  43950. * @returns A promise that resolves when the scene is ready
  43951. */
  43952. whenReadyAsync(): Promise<void>;
  43953. /** @hidden */
  43954. _checkIsReady(): void;
  43955. /**
  43956. * Gets all animatable attached to the scene
  43957. */
  43958. get animatables(): Animatable[];
  43959. /**
  43960. * Resets the last animation time frame.
  43961. * Useful to override when animations start running when loading a scene for the first time.
  43962. */
  43963. resetLastAnimationTimeFrame(): void;
  43964. /**
  43965. * Gets the current view matrix
  43966. * @returns a Matrix
  43967. */
  43968. getViewMatrix(): Matrix;
  43969. /**
  43970. * Gets the current projection matrix
  43971. * @returns a Matrix
  43972. */
  43973. getProjectionMatrix(): Matrix;
  43974. /**
  43975. * Gets the current transform matrix
  43976. * @returns a Matrix made of View * Projection
  43977. */
  43978. getTransformMatrix(): Matrix;
  43979. /**
  43980. * Sets the current transform matrix
  43981. * @param viewL defines the View matrix to use
  43982. * @param projectionL defines the Projection matrix to use
  43983. * @param viewR defines the right View matrix to use (if provided)
  43984. * @param projectionR defines the right Projection matrix to use (if provided)
  43985. */
  43986. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  43987. /**
  43988. * Gets the uniform buffer used to store scene data
  43989. * @returns a UniformBuffer
  43990. */
  43991. getSceneUniformBuffer(): UniformBuffer;
  43992. /**
  43993. * Gets an unique (relatively to the current scene) Id
  43994. * @returns an unique number for the scene
  43995. */
  43996. getUniqueId(): number;
  43997. /**
  43998. * Add a mesh to the list of scene's meshes
  43999. * @param newMesh defines the mesh to add
  44000. * @param recursive if all child meshes should also be added to the scene
  44001. */
  44002. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  44003. /**
  44004. * Remove a mesh for the list of scene's meshes
  44005. * @param toRemove defines the mesh to remove
  44006. * @param recursive if all child meshes should also be removed from the scene
  44007. * @returns the index where the mesh was in the mesh list
  44008. */
  44009. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  44010. /**
  44011. * Add a transform node to the list of scene's transform nodes
  44012. * @param newTransformNode defines the transform node to add
  44013. */
  44014. addTransformNode(newTransformNode: TransformNode): void;
  44015. /**
  44016. * Remove a transform node for the list of scene's transform nodes
  44017. * @param toRemove defines the transform node to remove
  44018. * @returns the index where the transform node was in the transform node list
  44019. */
  44020. removeTransformNode(toRemove: TransformNode): number;
  44021. /**
  44022. * Remove a skeleton for the list of scene's skeletons
  44023. * @param toRemove defines the skeleton to remove
  44024. * @returns the index where the skeleton was in the skeleton list
  44025. */
  44026. removeSkeleton(toRemove: Skeleton): number;
  44027. /**
  44028. * Remove a morph target for the list of scene's morph targets
  44029. * @param toRemove defines the morph target to remove
  44030. * @returns the index where the morph target was in the morph target list
  44031. */
  44032. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  44033. /**
  44034. * Remove a light for the list of scene's lights
  44035. * @param toRemove defines the light to remove
  44036. * @returns the index where the light was in the light list
  44037. */
  44038. removeLight(toRemove: Light): number;
  44039. /**
  44040. * Remove a camera for the list of scene's cameras
  44041. * @param toRemove defines the camera to remove
  44042. * @returns the index where the camera was in the camera list
  44043. */
  44044. removeCamera(toRemove: Camera): number;
  44045. /**
  44046. * Remove a particle system for the list of scene's particle systems
  44047. * @param toRemove defines the particle system to remove
  44048. * @returns the index where the particle system was in the particle system list
  44049. */
  44050. removeParticleSystem(toRemove: IParticleSystem): number;
  44051. /**
  44052. * Remove a animation for the list of scene's animations
  44053. * @param toRemove defines the animation to remove
  44054. * @returns the index where the animation was in the animation list
  44055. */
  44056. removeAnimation(toRemove: Animation): number;
  44057. /**
  44058. * Will stop the animation of the given target
  44059. * @param target - the target
  44060. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  44061. * @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)
  44062. */
  44063. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  44064. /**
  44065. * Removes the given animation group from this scene.
  44066. * @param toRemove The animation group to remove
  44067. * @returns The index of the removed animation group
  44068. */
  44069. removeAnimationGroup(toRemove: AnimationGroup): number;
  44070. /**
  44071. * Removes the given multi-material from this scene.
  44072. * @param toRemove The multi-material to remove
  44073. * @returns The index of the removed multi-material
  44074. */
  44075. removeMultiMaterial(toRemove: MultiMaterial): number;
  44076. /**
  44077. * Removes the given material from this scene.
  44078. * @param toRemove The material to remove
  44079. * @returns The index of the removed material
  44080. */
  44081. removeMaterial(toRemove: Material): number;
  44082. /**
  44083. * Removes the given action manager from this scene.
  44084. * @param toRemove The action manager to remove
  44085. * @returns The index of the removed action manager
  44086. */
  44087. removeActionManager(toRemove: AbstractActionManager): number;
  44088. /**
  44089. * Removes the given texture from this scene.
  44090. * @param toRemove The texture to remove
  44091. * @returns The index of the removed texture
  44092. */
  44093. removeTexture(toRemove: BaseTexture): number;
  44094. /**
  44095. * Adds the given light to this scene
  44096. * @param newLight The light to add
  44097. */
  44098. addLight(newLight: Light): void;
  44099. /**
  44100. * Sorts the list list based on light priorities
  44101. */
  44102. sortLightsByPriority(): void;
  44103. /**
  44104. * Adds the given camera to this scene
  44105. * @param newCamera The camera to add
  44106. */
  44107. addCamera(newCamera: Camera): void;
  44108. /**
  44109. * Adds the given skeleton to this scene
  44110. * @param newSkeleton The skeleton to add
  44111. */
  44112. addSkeleton(newSkeleton: Skeleton): void;
  44113. /**
  44114. * Adds the given particle system to this scene
  44115. * @param newParticleSystem The particle system to add
  44116. */
  44117. addParticleSystem(newParticleSystem: IParticleSystem): void;
  44118. /**
  44119. * Adds the given animation to this scene
  44120. * @param newAnimation The animation to add
  44121. */
  44122. addAnimation(newAnimation: Animation): void;
  44123. /**
  44124. * Adds the given animation group to this scene.
  44125. * @param newAnimationGroup The animation group to add
  44126. */
  44127. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  44128. /**
  44129. * Adds the given multi-material to this scene
  44130. * @param newMultiMaterial The multi-material to add
  44131. */
  44132. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  44133. /**
  44134. * Adds the given material to this scene
  44135. * @param newMaterial The material to add
  44136. */
  44137. addMaterial(newMaterial: Material): void;
  44138. /**
  44139. * Adds the given morph target to this scene
  44140. * @param newMorphTargetManager The morph target to add
  44141. */
  44142. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  44143. /**
  44144. * Adds the given geometry to this scene
  44145. * @param newGeometry The geometry to add
  44146. */
  44147. addGeometry(newGeometry: Geometry): void;
  44148. /**
  44149. * Adds the given action manager to this scene
  44150. * @param newActionManager The action manager to add
  44151. */
  44152. addActionManager(newActionManager: AbstractActionManager): void;
  44153. /**
  44154. * Adds the given texture to this scene.
  44155. * @param newTexture The texture to add
  44156. */
  44157. addTexture(newTexture: BaseTexture): void;
  44158. /**
  44159. * Switch active camera
  44160. * @param newCamera defines the new active camera
  44161. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  44162. */
  44163. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  44164. /**
  44165. * sets the active camera of the scene using its ID
  44166. * @param id defines the camera's ID
  44167. * @return the new active camera or null if none found.
  44168. */
  44169. setActiveCameraByID(id: string): Nullable<Camera>;
  44170. /**
  44171. * sets the active camera of the scene using its name
  44172. * @param name defines the camera's name
  44173. * @returns the new active camera or null if none found.
  44174. */
  44175. setActiveCameraByName(name: string): Nullable<Camera>;
  44176. /**
  44177. * get an animation group using its name
  44178. * @param name defines the material's name
  44179. * @return the animation group or null if none found.
  44180. */
  44181. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  44182. /**
  44183. * Get a material using its unique id
  44184. * @param uniqueId defines the material's unique id
  44185. * @return the material or null if none found.
  44186. */
  44187. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  44188. /**
  44189. * get a material using its id
  44190. * @param id defines the material's ID
  44191. * @return the material or null if none found.
  44192. */
  44193. getMaterialByID(id: string): Nullable<Material>;
  44194. /**
  44195. * Gets a the last added material using a given id
  44196. * @param id defines the material's ID
  44197. * @return the last material with the given id or null if none found.
  44198. */
  44199. getLastMaterialByID(id: string): Nullable<Material>;
  44200. /**
  44201. * Gets a material using its name
  44202. * @param name defines the material's name
  44203. * @return the material or null if none found.
  44204. */
  44205. getMaterialByName(name: string): Nullable<Material>;
  44206. /**
  44207. * Get a texture using its unique id
  44208. * @param uniqueId defines the texture's unique id
  44209. * @return the texture or null if none found.
  44210. */
  44211. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  44212. /**
  44213. * Gets a camera using its id
  44214. * @param id defines the id to look for
  44215. * @returns the camera or null if not found
  44216. */
  44217. getCameraByID(id: string): Nullable<Camera>;
  44218. /**
  44219. * Gets a camera using its unique id
  44220. * @param uniqueId defines the unique id to look for
  44221. * @returns the camera or null if not found
  44222. */
  44223. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  44224. /**
  44225. * Gets a camera using its name
  44226. * @param name defines the camera's name
  44227. * @return the camera or null if none found.
  44228. */
  44229. getCameraByName(name: string): Nullable<Camera>;
  44230. /**
  44231. * Gets a bone using its id
  44232. * @param id defines the bone's id
  44233. * @return the bone or null if not found
  44234. */
  44235. getBoneByID(id: string): Nullable<Bone>;
  44236. /**
  44237. * Gets a bone using its id
  44238. * @param name defines the bone's name
  44239. * @return the bone or null if not found
  44240. */
  44241. getBoneByName(name: string): Nullable<Bone>;
  44242. /**
  44243. * Gets a light node using its name
  44244. * @param name defines the the light's name
  44245. * @return the light or null if none found.
  44246. */
  44247. getLightByName(name: string): Nullable<Light>;
  44248. /**
  44249. * Gets a light node using its id
  44250. * @param id defines the light's id
  44251. * @return the light or null if none found.
  44252. */
  44253. getLightByID(id: string): Nullable<Light>;
  44254. /**
  44255. * Gets a light node using its scene-generated unique ID
  44256. * @param uniqueId defines the light's unique id
  44257. * @return the light or null if none found.
  44258. */
  44259. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  44260. /**
  44261. * Gets a particle system by id
  44262. * @param id defines the particle system id
  44263. * @return the corresponding system or null if none found
  44264. */
  44265. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  44266. /**
  44267. * Gets a geometry using its ID
  44268. * @param id defines the geometry's id
  44269. * @return the geometry or null if none found.
  44270. */
  44271. getGeometryByID(id: string): Nullable<Geometry>;
  44272. private _getGeometryByUniqueID;
  44273. /**
  44274. * Add a new geometry to this scene
  44275. * @param geometry defines the geometry to be added to the scene.
  44276. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  44277. * @return a boolean defining if the geometry was added or not
  44278. */
  44279. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  44280. /**
  44281. * Removes an existing geometry
  44282. * @param geometry defines the geometry to be removed from the scene
  44283. * @return a boolean defining if the geometry was removed or not
  44284. */
  44285. removeGeometry(geometry: Geometry): boolean;
  44286. /**
  44287. * Gets the list of geometries attached to the scene
  44288. * @returns an array of Geometry
  44289. */
  44290. getGeometries(): Geometry[];
  44291. /**
  44292. * Gets the first added mesh found of a given ID
  44293. * @param id defines the id to search for
  44294. * @return the mesh found or null if not found at all
  44295. */
  44296. getMeshByID(id: string): Nullable<AbstractMesh>;
  44297. /**
  44298. * Gets a list of meshes using their id
  44299. * @param id defines the id to search for
  44300. * @returns a list of meshes
  44301. */
  44302. getMeshesByID(id: string): Array<AbstractMesh>;
  44303. /**
  44304. * Gets the first added transform node found of a given ID
  44305. * @param id defines the id to search for
  44306. * @return the found transform node or null if not found at all.
  44307. */
  44308. getTransformNodeByID(id: string): Nullable<TransformNode>;
  44309. /**
  44310. * Gets a transform node with its auto-generated unique id
  44311. * @param uniqueId efines the unique id to search for
  44312. * @return the found transform node or null if not found at all.
  44313. */
  44314. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  44315. /**
  44316. * Gets a list of transform nodes using their id
  44317. * @param id defines the id to search for
  44318. * @returns a list of transform nodes
  44319. */
  44320. getTransformNodesByID(id: string): Array<TransformNode>;
  44321. /**
  44322. * Gets a mesh with its auto-generated unique id
  44323. * @param uniqueId defines the unique id to search for
  44324. * @return the found mesh or null if not found at all.
  44325. */
  44326. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  44327. /**
  44328. * Gets a the last added mesh using a given id
  44329. * @param id defines the id to search for
  44330. * @return the found mesh or null if not found at all.
  44331. */
  44332. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  44333. /**
  44334. * Gets a the last added node (Mesh, Camera, Light) using a given id
  44335. * @param id defines the id to search for
  44336. * @return the found node or null if not found at all
  44337. */
  44338. getLastEntryByID(id: string): Nullable<Node>;
  44339. /**
  44340. * Gets a node (Mesh, Camera, Light) using a given id
  44341. * @param id defines the id to search for
  44342. * @return the found node or null if not found at all
  44343. */
  44344. getNodeByID(id: string): Nullable<Node>;
  44345. /**
  44346. * Gets a node (Mesh, Camera, Light) using a given name
  44347. * @param name defines the name to search for
  44348. * @return the found node or null if not found at all.
  44349. */
  44350. getNodeByName(name: string): Nullable<Node>;
  44351. /**
  44352. * Gets a mesh using a given name
  44353. * @param name defines the name to search for
  44354. * @return the found mesh or null if not found at all.
  44355. */
  44356. getMeshByName(name: string): Nullable<AbstractMesh>;
  44357. /**
  44358. * Gets a transform node using a given name
  44359. * @param name defines the name to search for
  44360. * @return the found transform node or null if not found at all.
  44361. */
  44362. getTransformNodeByName(name: string): Nullable<TransformNode>;
  44363. /**
  44364. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  44365. * @param id defines the id to search for
  44366. * @return the found skeleton or null if not found at all.
  44367. */
  44368. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  44369. /**
  44370. * Gets a skeleton using a given auto generated unique id
  44371. * @param uniqueId defines the unique id to search for
  44372. * @return the found skeleton or null if not found at all.
  44373. */
  44374. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  44375. /**
  44376. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  44377. * @param id defines the id to search for
  44378. * @return the found skeleton or null if not found at all.
  44379. */
  44380. getSkeletonById(id: string): Nullable<Skeleton>;
  44381. /**
  44382. * Gets a skeleton using a given name
  44383. * @param name defines the name to search for
  44384. * @return the found skeleton or null if not found at all.
  44385. */
  44386. getSkeletonByName(name: string): Nullable<Skeleton>;
  44387. /**
  44388. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  44389. * @param id defines the id to search for
  44390. * @return the found morph target manager or null if not found at all.
  44391. */
  44392. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  44393. /**
  44394. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  44395. * @param id defines the id to search for
  44396. * @return the found morph target or null if not found at all.
  44397. */
  44398. getMorphTargetById(id: string): Nullable<MorphTarget>;
  44399. /**
  44400. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  44401. * @param name defines the name to search for
  44402. * @return the found morph target or null if not found at all.
  44403. */
  44404. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  44405. /**
  44406. * Gets a post process using a given name (if many are found, this function will pick the first one)
  44407. * @param name defines the name to search for
  44408. * @return the found post process or null if not found at all.
  44409. */
  44410. getPostProcessByName(name: string): Nullable<PostProcess>;
  44411. /**
  44412. * Gets a boolean indicating if the given mesh is active
  44413. * @param mesh defines the mesh to look for
  44414. * @returns true if the mesh is in the active list
  44415. */
  44416. isActiveMesh(mesh: AbstractMesh): boolean;
  44417. /**
  44418. * Return a unique id as a string which can serve as an identifier for the scene
  44419. */
  44420. get uid(): string;
  44421. /**
  44422. * Add an externaly attached data from its key.
  44423. * This method call will fail and return false, if such key already exists.
  44424. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  44425. * @param key the unique key that identifies the data
  44426. * @param data the data object to associate to the key for this Engine instance
  44427. * @return true if no such key were already present and the data was added successfully, false otherwise
  44428. */
  44429. addExternalData<T>(key: string, data: T): boolean;
  44430. /**
  44431. * Get an externaly attached data from its key
  44432. * @param key the unique key that identifies the data
  44433. * @return the associated data, if present (can be null), or undefined if not present
  44434. */
  44435. getExternalData<T>(key: string): Nullable<T>;
  44436. /**
  44437. * Get an externaly attached data from its key, create it using a factory if it's not already present
  44438. * @param key the unique key that identifies the data
  44439. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  44440. * @return the associated data, can be null if the factory returned null.
  44441. */
  44442. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  44443. /**
  44444. * Remove an externaly attached data from the Engine instance
  44445. * @param key the unique key that identifies the data
  44446. * @return true if the data was successfully removed, false if it doesn't exist
  44447. */
  44448. removeExternalData(key: string): boolean;
  44449. private _evaluateSubMesh;
  44450. /**
  44451. * Clear the processed materials smart array preventing retention point in material dispose.
  44452. */
  44453. freeProcessedMaterials(): void;
  44454. private _preventFreeActiveMeshesAndRenderingGroups;
  44455. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  44456. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  44457. * when disposing several meshes in a row or a hierarchy of meshes.
  44458. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  44459. */
  44460. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  44461. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  44462. /**
  44463. * Clear the active meshes smart array preventing retention point in mesh dispose.
  44464. */
  44465. freeActiveMeshes(): void;
  44466. /**
  44467. * Clear the info related to rendering groups preventing retention points during dispose.
  44468. */
  44469. freeRenderingGroups(): void;
  44470. /** @hidden */
  44471. _isInIntermediateRendering(): boolean;
  44472. /**
  44473. * Lambda returning the list of potentially active meshes.
  44474. */
  44475. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  44476. /**
  44477. * Lambda returning the list of potentially active sub meshes.
  44478. */
  44479. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  44480. /**
  44481. * Lambda returning the list of potentially intersecting sub meshes.
  44482. */
  44483. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  44484. /**
  44485. * Lambda returning the list of potentially colliding sub meshes.
  44486. */
  44487. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  44488. private _activeMeshesFrozen;
  44489. private _skipEvaluateActiveMeshesCompletely;
  44490. /**
  44491. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  44492. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  44493. * @param onSuccess optional success callback
  44494. * @param onError optional error callback
  44495. * @returns the current scene
  44496. */
  44497. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean, onSuccess?: () => void, onError?: (message: string) => void): Scene;
  44498. /**
  44499. * Use this function to restart evaluating active meshes on every frame
  44500. * @returns the current scene
  44501. */
  44502. unfreezeActiveMeshes(): Scene;
  44503. private _evaluateActiveMeshes;
  44504. private _activeMesh;
  44505. /**
  44506. * Update the transform matrix to update from the current active camera
  44507. * @param force defines a boolean used to force the update even if cache is up to date
  44508. */
  44509. updateTransformMatrix(force?: boolean): void;
  44510. private _bindFrameBuffer;
  44511. /** @hidden */
  44512. _allowPostProcessClearColor: boolean;
  44513. /** @hidden */
  44514. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  44515. private _processSubCameras;
  44516. private _checkIntersections;
  44517. /** @hidden */
  44518. _advancePhysicsEngineStep(step: number): void;
  44519. /**
  44520. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  44521. */
  44522. getDeterministicFrameTime: () => number;
  44523. /** @hidden */
  44524. _animate(): void;
  44525. /** Execute all animations (for a frame) */
  44526. animate(): void;
  44527. /**
  44528. * Render the scene
  44529. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  44530. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  44531. */
  44532. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  44533. /**
  44534. * Freeze all materials
  44535. * A frozen material will not be updatable but should be faster to render
  44536. */
  44537. freezeMaterials(): void;
  44538. /**
  44539. * Unfreeze all materials
  44540. * A frozen material will not be updatable but should be faster to render
  44541. */
  44542. unfreezeMaterials(): void;
  44543. /**
  44544. * Releases all held ressources
  44545. */
  44546. dispose(): void;
  44547. /**
  44548. * Gets if the scene is already disposed
  44549. */
  44550. get isDisposed(): boolean;
  44551. /**
  44552. * Call this function to reduce memory footprint of the scene.
  44553. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  44554. */
  44555. clearCachedVertexData(): void;
  44556. /**
  44557. * This function will remove the local cached buffer data from texture.
  44558. * It will save memory but will prevent the texture from being rebuilt
  44559. */
  44560. cleanCachedTextureBuffer(): void;
  44561. /**
  44562. * Get the world extend vectors with an optional filter
  44563. *
  44564. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  44565. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  44566. */
  44567. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  44568. min: Vector3;
  44569. max: Vector3;
  44570. };
  44571. /**
  44572. * Creates a ray that can be used to pick in the scene
  44573. * @param x defines the x coordinate of the origin (on-screen)
  44574. * @param y defines the y coordinate of the origin (on-screen)
  44575. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  44576. * @param camera defines the camera to use for the picking
  44577. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  44578. * @returns a Ray
  44579. */
  44580. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  44581. /**
  44582. * Creates a ray that can be used to pick in the scene
  44583. * @param x defines the x coordinate of the origin (on-screen)
  44584. * @param y defines the y coordinate of the origin (on-screen)
  44585. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  44586. * @param result defines the ray where to store the picking ray
  44587. * @param camera defines the camera to use for the picking
  44588. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  44589. * @returns the current scene
  44590. */
  44591. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  44592. /**
  44593. * Creates a ray that can be used to pick in the scene
  44594. * @param x defines the x coordinate of the origin (on-screen)
  44595. * @param y defines the y coordinate of the origin (on-screen)
  44596. * @param camera defines the camera to use for the picking
  44597. * @returns a Ray
  44598. */
  44599. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  44600. /**
  44601. * Creates a ray that can be used to pick in the scene
  44602. * @param x defines the x coordinate of the origin (on-screen)
  44603. * @param y defines the y coordinate of the origin (on-screen)
  44604. * @param result defines the ray where to store the picking ray
  44605. * @param camera defines the camera to use for the picking
  44606. * @returns the current scene
  44607. */
  44608. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  44609. /** Launch a ray to try to pick a mesh in the scene
  44610. * @param x position on screen
  44611. * @param y position on screen
  44612. * @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
  44613. * @param fastCheck defines if the first intersection will be used (and not the closest)
  44614. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  44615. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  44616. * @returns a PickingInfo
  44617. */
  44618. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  44619. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  44620. * @param x position on screen
  44621. * @param y position on screen
  44622. * @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
  44623. * @param fastCheck defines if the first intersection will be used (and not the closest)
  44624. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  44625. * @returns a PickingInfo (Please note that some info will not be set like distance, bv, bu and everything that cannot be capture by only using bounding infos)
  44626. */
  44627. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  44628. /** Use the given ray to pick a mesh in the scene
  44629. * @param ray The ray to use to pick meshes
  44630. * @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
  44631. * @param fastCheck defines if the first intersection will be used (and not the closest)
  44632. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  44633. * @returns a PickingInfo
  44634. */
  44635. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  44636. /**
  44637. * Launch a ray to try to pick a mesh in the scene
  44638. * @param x X position on screen
  44639. * @param y Y position on screen
  44640. * @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
  44641. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  44642. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  44643. * @returns an array of PickingInfo
  44644. */
  44645. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  44646. /**
  44647. * Launch a ray to try to pick a mesh in the scene
  44648. * @param ray Ray to use
  44649. * @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
  44650. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  44651. * @returns an array of PickingInfo
  44652. */
  44653. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  44654. /**
  44655. * Force the value of meshUnderPointer
  44656. * @param mesh defines the mesh to use
  44657. * @param pointerId optional pointer id when using more than one pointer
  44658. */
  44659. setPointerOverMesh(mesh: Nullable<AbstractMesh>, pointerId?: number): void;
  44660. /**
  44661. * Gets the mesh under the pointer
  44662. * @returns a Mesh or null if no mesh is under the pointer
  44663. */
  44664. getPointerOverMesh(): Nullable<AbstractMesh>;
  44665. /** @hidden */
  44666. _rebuildGeometries(): void;
  44667. /** @hidden */
  44668. _rebuildTextures(): void;
  44669. private _getByTags;
  44670. /**
  44671. * Get a list of meshes by tags
  44672. * @param tagsQuery defines the tags query to use
  44673. * @param forEach defines a predicate used to filter results
  44674. * @returns an array of Mesh
  44675. */
  44676. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  44677. /**
  44678. * Get a list of cameras by tags
  44679. * @param tagsQuery defines the tags query to use
  44680. * @param forEach defines a predicate used to filter results
  44681. * @returns an array of Camera
  44682. */
  44683. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  44684. /**
  44685. * Get a list of lights by tags
  44686. * @param tagsQuery defines the tags query to use
  44687. * @param forEach defines a predicate used to filter results
  44688. * @returns an array of Light
  44689. */
  44690. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  44691. /**
  44692. * Get a list of materials by tags
  44693. * @param tagsQuery defines the tags query to use
  44694. * @param forEach defines a predicate used to filter results
  44695. * @returns an array of Material
  44696. */
  44697. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  44698. /**
  44699. * Get a list of transform nodes by tags
  44700. * @param tagsQuery defines the tags query to use
  44701. * @param forEach defines a predicate used to filter results
  44702. * @returns an array of TransformNode
  44703. */
  44704. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  44705. /**
  44706. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  44707. * This allowed control for front to back rendering or reversly depending of the special needs.
  44708. *
  44709. * @param renderingGroupId The rendering group id corresponding to its index
  44710. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  44711. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  44712. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  44713. */
  44714. 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;
  44715. /**
  44716. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  44717. *
  44718. * @param renderingGroupId The rendering group id corresponding to its index
  44719. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  44720. * @param depth Automatically clears depth between groups if true and autoClear is true.
  44721. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  44722. */
  44723. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  44724. /**
  44725. * Gets the current auto clear configuration for one rendering group of the rendering
  44726. * manager.
  44727. * @param index the rendering group index to get the information for
  44728. * @returns The auto clear setup for the requested rendering group
  44729. */
  44730. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  44731. private _blockMaterialDirtyMechanism;
  44732. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  44733. get blockMaterialDirtyMechanism(): boolean;
  44734. set blockMaterialDirtyMechanism(value: boolean);
  44735. /**
  44736. * Will flag all materials as dirty to trigger new shader compilation
  44737. * @param flag defines the flag used to specify which material part must be marked as dirty
  44738. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  44739. */
  44740. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  44741. /** @hidden */
  44742. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  44743. /** @hidden */
  44744. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  44745. /** @hidden */
  44746. _requestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  44747. /** @hidden */
  44748. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  44749. /** @hidden */
  44750. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  44751. /** @hidden */
  44752. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  44753. }
  44754. }
  44755. declare module BABYLON {
  44756. /**
  44757. * Set of assets to keep when moving a scene into an asset container.
  44758. */
  44759. export class KeepAssets extends AbstractScene {
  44760. }
  44761. /**
  44762. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  44763. */
  44764. export class InstantiatedEntries {
  44765. /**
  44766. * List of new root nodes (eg. nodes with no parent)
  44767. */
  44768. rootNodes: TransformNode[];
  44769. /**
  44770. * List of new skeletons
  44771. */
  44772. skeletons: Skeleton[];
  44773. /**
  44774. * List of new animation groups
  44775. */
  44776. animationGroups: AnimationGroup[];
  44777. }
  44778. /**
  44779. * Container with a set of assets that can be added or removed from a scene.
  44780. */
  44781. export class AssetContainer extends AbstractScene {
  44782. private _wasAddedToScene;
  44783. /**
  44784. * The scene the AssetContainer belongs to.
  44785. */
  44786. scene: Scene;
  44787. /**
  44788. * Instantiates an AssetContainer.
  44789. * @param scene The scene the AssetContainer belongs to.
  44790. */
  44791. constructor(scene: Scene);
  44792. /**
  44793. * Instantiate or clone all meshes and add the new ones to the scene.
  44794. * Skeletons and animation groups will all be cloned
  44795. * @param nameFunction defines an optional function used to get new names for clones
  44796. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  44797. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  44798. */
  44799. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  44800. /**
  44801. * Adds all the assets from the container to the scene.
  44802. */
  44803. addAllToScene(): void;
  44804. /**
  44805. * Removes all the assets in the container from the scene
  44806. */
  44807. removeAllFromScene(): void;
  44808. /**
  44809. * Disposes all the assets in the container
  44810. */
  44811. dispose(): void;
  44812. private _moveAssets;
  44813. /**
  44814. * Removes all the assets contained in the scene and adds them to the container.
  44815. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  44816. */
  44817. moveAllFromScene(keepAssets?: KeepAssets): void;
  44818. /**
  44819. * 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.
  44820. * @returns the root mesh
  44821. */
  44822. createRootMesh(): Mesh;
  44823. /**
  44824. * Merge animations (direct and animation groups) from this asset container into a scene
  44825. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  44826. * @param animatables set of animatables to retarget to a node from the scene
  44827. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  44828. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  44829. */
  44830. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  44831. }
  44832. }
  44833. declare module BABYLON {
  44834. /**
  44835. * Defines how the parser contract is defined.
  44836. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  44837. */
  44838. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  44839. /**
  44840. * Defines how the individual parser contract is defined.
  44841. * These parser can parse an individual asset
  44842. */
  44843. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  44844. /**
  44845. * Base class of the scene acting as a container for the different elements composing a scene.
  44846. * This class is dynamically extended by the different components of the scene increasing
  44847. * flexibility and reducing coupling
  44848. */
  44849. export abstract class AbstractScene {
  44850. /**
  44851. * Stores the list of available parsers in the application.
  44852. */
  44853. private static _BabylonFileParsers;
  44854. /**
  44855. * Stores the list of available individual parsers in the application.
  44856. */
  44857. private static _IndividualBabylonFileParsers;
  44858. /**
  44859. * Adds a parser in the list of available ones
  44860. * @param name Defines the name of the parser
  44861. * @param parser Defines the parser to add
  44862. */
  44863. static AddParser(name: string, parser: BabylonFileParser): void;
  44864. /**
  44865. * Gets a general parser from the list of avaialble ones
  44866. * @param name Defines the name of the parser
  44867. * @returns the requested parser or null
  44868. */
  44869. static GetParser(name: string): Nullable<BabylonFileParser>;
  44870. /**
  44871. * Adds n individual parser in the list of available ones
  44872. * @param name Defines the name of the parser
  44873. * @param parser Defines the parser to add
  44874. */
  44875. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  44876. /**
  44877. * Gets an individual parser from the list of avaialble ones
  44878. * @param name Defines the name of the parser
  44879. * @returns the requested parser or null
  44880. */
  44881. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  44882. /**
  44883. * Parser json data and populate both a scene and its associated container object
  44884. * @param jsonData Defines the data to parse
  44885. * @param scene Defines the scene to parse the data for
  44886. * @param container Defines the container attached to the parsing sequence
  44887. * @param rootUrl Defines the root url of the data
  44888. */
  44889. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  44890. /**
  44891. * Gets the list of root nodes (ie. nodes with no parent)
  44892. */
  44893. rootNodes: Node[];
  44894. /** All of the cameras added to this scene
  44895. * @see https://doc.babylonjs.com/babylon101/cameras
  44896. */
  44897. cameras: Camera[];
  44898. /**
  44899. * All of the lights added to this scene
  44900. * @see https://doc.babylonjs.com/babylon101/lights
  44901. */
  44902. lights: Light[];
  44903. /**
  44904. * All of the (abstract) meshes added to this scene
  44905. */
  44906. meshes: AbstractMesh[];
  44907. /**
  44908. * The list of skeletons added to the scene
  44909. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  44910. */
  44911. skeletons: Skeleton[];
  44912. /**
  44913. * All of the particle systems added to this scene
  44914. * @see https://doc.babylonjs.com/babylon101/particles
  44915. */
  44916. particleSystems: IParticleSystem[];
  44917. /**
  44918. * Gets a list of Animations associated with the scene
  44919. */
  44920. animations: Animation[];
  44921. /**
  44922. * All of the animation groups added to this scene
  44923. * @see https://doc.babylonjs.com/how_to/group
  44924. */
  44925. animationGroups: AnimationGroup[];
  44926. /**
  44927. * All of the multi-materials added to this scene
  44928. * @see https://doc.babylonjs.com/how_to/multi_materials
  44929. */
  44930. multiMaterials: MultiMaterial[];
  44931. /**
  44932. * All of the materials added to this scene
  44933. * In the context of a Scene, it is not supposed to be modified manually.
  44934. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  44935. * Note also that the order of the Material within the array is not significant and might change.
  44936. * @see https://doc.babylonjs.com/babylon101/materials
  44937. */
  44938. materials: Material[];
  44939. /**
  44940. * The list of morph target managers added to the scene
  44941. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  44942. */
  44943. morphTargetManagers: MorphTargetManager[];
  44944. /**
  44945. * The list of geometries used in the scene.
  44946. */
  44947. geometries: Geometry[];
  44948. /**
  44949. * All of the tranform nodes added to this scene
  44950. * In the context of a Scene, it is not supposed to be modified manually.
  44951. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  44952. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  44953. * @see https://doc.babylonjs.com/how_to/transformnode
  44954. */
  44955. transformNodes: TransformNode[];
  44956. /**
  44957. * ActionManagers available on the scene.
  44958. */
  44959. actionManagers: AbstractActionManager[];
  44960. /**
  44961. * Textures to keep.
  44962. */
  44963. textures: BaseTexture[];
  44964. /** @hidden */
  44965. protected _environmentTexture: Nullable<BaseTexture>;
  44966. /**
  44967. * Texture used in all pbr material as the reflection texture.
  44968. * As in the majority of the scene they are the same (exception for multi room and so on),
  44969. * this is easier to reference from here than from all the materials.
  44970. */
  44971. get environmentTexture(): Nullable<BaseTexture>;
  44972. set environmentTexture(value: Nullable<BaseTexture>);
  44973. /**
  44974. * The list of postprocesses added to the scene
  44975. */
  44976. postProcesses: PostProcess[];
  44977. /**
  44978. * @returns all meshes, lights, cameras, transformNodes and bones
  44979. */
  44980. getNodes(): Array<Node>;
  44981. }
  44982. }
  44983. declare module BABYLON {
  44984. /**
  44985. * Interface used to define options for Sound class
  44986. */
  44987. export interface ISoundOptions {
  44988. /**
  44989. * Does the sound autoplay once loaded.
  44990. */
  44991. autoplay?: boolean;
  44992. /**
  44993. * Does the sound loop after it finishes playing once.
  44994. */
  44995. loop?: boolean;
  44996. /**
  44997. * Sound's volume
  44998. */
  44999. volume?: number;
  45000. /**
  45001. * Is it a spatial sound?
  45002. */
  45003. spatialSound?: boolean;
  45004. /**
  45005. * Maximum distance to hear that sound
  45006. */
  45007. maxDistance?: number;
  45008. /**
  45009. * Uses user defined attenuation function
  45010. */
  45011. useCustomAttenuation?: boolean;
  45012. /**
  45013. * Define the roll off factor of spatial sounds.
  45014. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  45015. */
  45016. rolloffFactor?: number;
  45017. /**
  45018. * Define the reference distance the sound should be heard perfectly.
  45019. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  45020. */
  45021. refDistance?: number;
  45022. /**
  45023. * Define the distance attenuation model the sound will follow.
  45024. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  45025. */
  45026. distanceModel?: string;
  45027. /**
  45028. * Defines the playback speed (1 by default)
  45029. */
  45030. playbackRate?: number;
  45031. /**
  45032. * Defines if the sound is from a streaming source
  45033. */
  45034. streaming?: boolean;
  45035. /**
  45036. * Defines an optional length (in seconds) inside the sound file
  45037. */
  45038. length?: number;
  45039. /**
  45040. * Defines an optional offset (in seconds) inside the sound file
  45041. */
  45042. offset?: number;
  45043. /**
  45044. * If true, URLs will not be required to state the audio file codec to use.
  45045. */
  45046. skipCodecCheck?: boolean;
  45047. }
  45048. }
  45049. declare module BABYLON {
  45050. /**
  45051. * Defines a sound that can be played in the application.
  45052. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  45053. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  45054. */
  45055. export class Sound {
  45056. /**
  45057. * The name of the sound in the scene.
  45058. */
  45059. name: string;
  45060. /**
  45061. * Does the sound autoplay once loaded.
  45062. */
  45063. autoplay: boolean;
  45064. /**
  45065. * Does the sound loop after it finishes playing once.
  45066. */
  45067. loop: boolean;
  45068. /**
  45069. * Does the sound use a custom attenuation curve to simulate the falloff
  45070. * happening when the source gets further away from the camera.
  45071. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  45072. */
  45073. useCustomAttenuation: boolean;
  45074. /**
  45075. * The sound track id this sound belongs to.
  45076. */
  45077. soundTrackId: number;
  45078. /**
  45079. * Is this sound currently played.
  45080. */
  45081. isPlaying: boolean;
  45082. /**
  45083. * Is this sound currently paused.
  45084. */
  45085. isPaused: boolean;
  45086. /**
  45087. * Does this sound enables spatial sound.
  45088. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  45089. */
  45090. spatialSound: boolean;
  45091. /**
  45092. * Define the reference distance the sound should be heard perfectly.
  45093. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  45094. */
  45095. refDistance: number;
  45096. /**
  45097. * Define the roll off factor of spatial sounds.
  45098. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  45099. */
  45100. rolloffFactor: number;
  45101. /**
  45102. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  45103. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  45104. */
  45105. maxDistance: number;
  45106. /**
  45107. * Define the distance attenuation model the sound will follow.
  45108. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  45109. */
  45110. distanceModel: string;
  45111. /**
  45112. * @hidden
  45113. * Back Compat
  45114. **/
  45115. onended: () => any;
  45116. /**
  45117. * Gets or sets an object used to store user defined information for the sound.
  45118. */
  45119. metadata: any;
  45120. /**
  45121. * Observable event when the current playing sound finishes.
  45122. */
  45123. onEndedObservable: Observable<Sound>;
  45124. /**
  45125. * Gets the current time for the sound.
  45126. */
  45127. get currentTime(): number;
  45128. private _panningModel;
  45129. private _playbackRate;
  45130. private _streaming;
  45131. private _startTime;
  45132. private _startOffset;
  45133. private _position;
  45134. /** @hidden */
  45135. _positionInEmitterSpace: boolean;
  45136. private _localDirection;
  45137. private _volume;
  45138. private _isReadyToPlay;
  45139. private _isDirectional;
  45140. private _readyToPlayCallback;
  45141. private _audioBuffer;
  45142. private _soundSource;
  45143. private _streamingSource;
  45144. private _soundPanner;
  45145. private _soundGain;
  45146. private _inputAudioNode;
  45147. private _outputAudioNode;
  45148. private _coneInnerAngle;
  45149. private _coneOuterAngle;
  45150. private _coneOuterGain;
  45151. private _scene;
  45152. private _connectedTransformNode;
  45153. private _customAttenuationFunction;
  45154. private _registerFunc;
  45155. private _isOutputConnected;
  45156. private _htmlAudioElement;
  45157. private _urlType;
  45158. private _length?;
  45159. private _offset?;
  45160. /** @hidden */
  45161. static _SceneComponentInitialization: (scene: Scene) => void;
  45162. /**
  45163. * Create a sound and attach it to a scene
  45164. * @param name Name of your sound
  45165. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  45166. * @param scene defines the scene the sound belongs to
  45167. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  45168. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  45169. */
  45170. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  45171. /**
  45172. * Release the sound and its associated resources
  45173. */
  45174. dispose(): void;
  45175. /**
  45176. * Gets if the sounds is ready to be played or not.
  45177. * @returns true if ready, otherwise false
  45178. */
  45179. isReady(): boolean;
  45180. private _soundLoaded;
  45181. /**
  45182. * Sets the data of the sound from an audiobuffer
  45183. * @param audioBuffer The audioBuffer containing the data
  45184. */
  45185. setAudioBuffer(audioBuffer: AudioBuffer): void;
  45186. /**
  45187. * Updates the current sounds options such as maxdistance, loop...
  45188. * @param options A JSON object containing values named as the object properties
  45189. */
  45190. updateOptions(options: ISoundOptions): void;
  45191. private _createSpatialParameters;
  45192. private _updateSpatialParameters;
  45193. /**
  45194. * Switch the panning model to HRTF:
  45195. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  45196. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  45197. */
  45198. switchPanningModelToHRTF(): void;
  45199. /**
  45200. * Switch the panning model to Equal Power:
  45201. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  45202. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  45203. */
  45204. switchPanningModelToEqualPower(): void;
  45205. private _switchPanningModel;
  45206. /**
  45207. * Connect this sound to a sound track audio node like gain...
  45208. * @param soundTrackAudioNode the sound track audio node to connect to
  45209. */
  45210. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  45211. /**
  45212. * Transform this sound into a directional source
  45213. * @param coneInnerAngle Size of the inner cone in degree
  45214. * @param coneOuterAngle Size of the outer cone in degree
  45215. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  45216. */
  45217. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  45218. /**
  45219. * Gets or sets the inner angle for the directional cone.
  45220. */
  45221. get directionalConeInnerAngle(): number;
  45222. /**
  45223. * Gets or sets the inner angle for the directional cone.
  45224. */
  45225. set directionalConeInnerAngle(value: number);
  45226. /**
  45227. * Gets or sets the outer angle for the directional cone.
  45228. */
  45229. get directionalConeOuterAngle(): number;
  45230. /**
  45231. * Gets or sets the outer angle for the directional cone.
  45232. */
  45233. set directionalConeOuterAngle(value: number);
  45234. /**
  45235. * Sets the position of the emitter if spatial sound is enabled
  45236. * @param newPosition Defines the new posisiton
  45237. */
  45238. setPosition(newPosition: Vector3): void;
  45239. /**
  45240. * Sets the local direction of the emitter if spatial sound is enabled
  45241. * @param newLocalDirection Defines the new local direction
  45242. */
  45243. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  45244. private _updateDirection;
  45245. /** @hidden */
  45246. updateDistanceFromListener(): void;
  45247. /**
  45248. * Sets a new custom attenuation function for the sound.
  45249. * @param callback Defines the function used for the attenuation
  45250. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  45251. */
  45252. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  45253. /**
  45254. * Play the sound
  45255. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  45256. * @param offset (optional) Start the sound at a specific time in seconds
  45257. * @param length (optional) Sound duration (in seconds)
  45258. */
  45259. play(time?: number, offset?: number, length?: number): void;
  45260. private _onended;
  45261. /**
  45262. * Stop the sound
  45263. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  45264. */
  45265. stop(time?: number): void;
  45266. /**
  45267. * Put the sound in pause
  45268. */
  45269. pause(): void;
  45270. /**
  45271. * Sets a dedicated volume for this sounds
  45272. * @param newVolume Define the new volume of the sound
  45273. * @param time Define time for gradual change to new volume
  45274. */
  45275. setVolume(newVolume: number, time?: number): void;
  45276. /**
  45277. * Set the sound play back rate
  45278. * @param newPlaybackRate Define the playback rate the sound should be played at
  45279. */
  45280. setPlaybackRate(newPlaybackRate: number): void;
  45281. /**
  45282. * Gets the volume of the sound.
  45283. * @returns the volume of the sound
  45284. */
  45285. getVolume(): number;
  45286. /**
  45287. * Attach the sound to a dedicated mesh
  45288. * @param transformNode The transform node to connect the sound with
  45289. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  45290. */
  45291. attachToMesh(transformNode: TransformNode): void;
  45292. /**
  45293. * Detach the sound from the previously attached mesh
  45294. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  45295. */
  45296. detachFromMesh(): void;
  45297. private _onRegisterAfterWorldMatrixUpdate;
  45298. /**
  45299. * Clone the current sound in the scene.
  45300. * @returns the new sound clone
  45301. */
  45302. clone(): Nullable<Sound>;
  45303. /**
  45304. * Gets the current underlying audio buffer containing the data
  45305. * @returns the audio buffer
  45306. */
  45307. getAudioBuffer(): Nullable<AudioBuffer>;
  45308. /**
  45309. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  45310. * @returns the source node
  45311. */
  45312. getSoundSource(): Nullable<AudioBufferSourceNode>;
  45313. /**
  45314. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  45315. * @returns the gain node
  45316. */
  45317. getSoundGain(): Nullable<GainNode>;
  45318. /**
  45319. * Serializes the Sound in a JSON representation
  45320. * @returns the JSON representation of the sound
  45321. */
  45322. serialize(): any;
  45323. /**
  45324. * Parse a JSON representation of a sound to innstantiate in a given scene
  45325. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  45326. * @param scene Define the scene the new parsed sound should be created in
  45327. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  45328. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  45329. * @returns the newly parsed sound
  45330. */
  45331. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  45332. }
  45333. }
  45334. declare module BABYLON {
  45335. /**
  45336. * This defines an action helpful to play a defined sound on a triggered action.
  45337. */
  45338. export class PlaySoundAction extends Action {
  45339. private _sound;
  45340. /**
  45341. * Instantiate the action
  45342. * @param triggerOptions defines the trigger options
  45343. * @param sound defines the sound to play
  45344. * @param condition defines the trigger related conditions
  45345. */
  45346. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  45347. /** @hidden */
  45348. _prepare(): void;
  45349. /**
  45350. * Execute the action and play the sound.
  45351. */
  45352. execute(): void;
  45353. /**
  45354. * Serializes the actions and its related information.
  45355. * @param parent defines the object to serialize in
  45356. * @returns the serialized object
  45357. */
  45358. serialize(parent: any): any;
  45359. }
  45360. /**
  45361. * This defines an action helpful to stop a defined sound on a triggered action.
  45362. */
  45363. export class StopSoundAction extends Action {
  45364. private _sound;
  45365. /**
  45366. * Instantiate the action
  45367. * @param triggerOptions defines the trigger options
  45368. * @param sound defines the sound to stop
  45369. * @param condition defines the trigger related conditions
  45370. */
  45371. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  45372. /** @hidden */
  45373. _prepare(): void;
  45374. /**
  45375. * Execute the action and stop the sound.
  45376. */
  45377. execute(): void;
  45378. /**
  45379. * Serializes the actions and its related information.
  45380. * @param parent defines the object to serialize in
  45381. * @returns the serialized object
  45382. */
  45383. serialize(parent: any): any;
  45384. }
  45385. }
  45386. declare module BABYLON {
  45387. /**
  45388. * This defines an action responsible to change the value of a property
  45389. * by interpolating between its current value and the newly set one once triggered.
  45390. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  45391. */
  45392. export class InterpolateValueAction extends Action {
  45393. /**
  45394. * Defines the path of the property where the value should be interpolated
  45395. */
  45396. propertyPath: string;
  45397. /**
  45398. * Defines the target value at the end of the interpolation.
  45399. */
  45400. value: any;
  45401. /**
  45402. * Defines the time it will take for the property to interpolate to the value.
  45403. */
  45404. duration: number;
  45405. /**
  45406. * Defines if the other scene animations should be stopped when the action has been triggered
  45407. */
  45408. stopOtherAnimations?: boolean;
  45409. /**
  45410. * Defines a callback raised once the interpolation animation has been done.
  45411. */
  45412. onInterpolationDone?: () => void;
  45413. /**
  45414. * Observable triggered once the interpolation animation has been done.
  45415. */
  45416. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  45417. private _target;
  45418. private _effectiveTarget;
  45419. private _property;
  45420. /**
  45421. * Instantiate the action
  45422. * @param triggerOptions defines the trigger options
  45423. * @param target defines the object containing the value to interpolate
  45424. * @param propertyPath defines the path to the property in the target object
  45425. * @param value defines the target value at the end of the interpolation
  45426. * @param duration deines the time it will take for the property to interpolate to the value.
  45427. * @param condition defines the trigger related conditions
  45428. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  45429. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  45430. */
  45431. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  45432. /** @hidden */
  45433. _prepare(): void;
  45434. /**
  45435. * Execute the action starts the value interpolation.
  45436. */
  45437. execute(): void;
  45438. /**
  45439. * Serializes the actions and its related information.
  45440. * @param parent defines the object to serialize in
  45441. * @returns the serialized object
  45442. */
  45443. serialize(parent: any): any;
  45444. }
  45445. }
  45446. declare module BABYLON {
  45447. /**
  45448. * This represents the default audio engine used in babylon.
  45449. * It is responsible to play, synchronize and analyse sounds throughout the application.
  45450. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  45451. */
  45452. export class AudioEngine implements IAudioEngine {
  45453. private _audioContext;
  45454. private _audioContextInitialized;
  45455. private _muteButton;
  45456. private _hostElement;
  45457. /**
  45458. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  45459. */
  45460. canUseWebAudio: boolean;
  45461. /**
  45462. * The master gain node defines the global audio volume of your audio engine.
  45463. */
  45464. masterGain: GainNode;
  45465. /**
  45466. * Defines if Babylon should emit a warning if WebAudio is not supported.
  45467. * @ignoreNaming
  45468. */
  45469. WarnedWebAudioUnsupported: boolean;
  45470. /**
  45471. * Gets whether or not mp3 are supported by your browser.
  45472. */
  45473. isMP3supported: boolean;
  45474. /**
  45475. * Gets whether or not ogg are supported by your browser.
  45476. */
  45477. isOGGsupported: boolean;
  45478. /**
  45479. * Gets whether audio has been unlocked on the device.
  45480. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  45481. * a user interaction has happened.
  45482. */
  45483. unlocked: boolean;
  45484. /**
  45485. * Defines if the audio engine relies on a custom unlocked button.
  45486. * In this case, the embedded button will not be displayed.
  45487. */
  45488. useCustomUnlockedButton: boolean;
  45489. /**
  45490. * Event raised when audio has been unlocked on the browser.
  45491. */
  45492. onAudioUnlockedObservable: Observable<IAudioEngine>;
  45493. /**
  45494. * Event raised when audio has been locked on the browser.
  45495. */
  45496. onAudioLockedObservable: Observable<IAudioEngine>;
  45497. /**
  45498. * Gets the current AudioContext if available.
  45499. */
  45500. get audioContext(): Nullable<AudioContext>;
  45501. private _connectedAnalyser;
  45502. /**
  45503. * Instantiates a new audio engine.
  45504. *
  45505. * There should be only one per page as some browsers restrict the number
  45506. * of audio contexts you can create.
  45507. * @param hostElement defines the host element where to display the mute icon if necessary
  45508. */
  45509. constructor(hostElement?: Nullable<HTMLElement>);
  45510. /**
  45511. * Flags the audio engine in Locked state.
  45512. * This happens due to new browser policies preventing audio to autoplay.
  45513. */
  45514. lock(): void;
  45515. /**
  45516. * Unlocks the audio engine once a user action has been done on the dom.
  45517. * This is helpful to resume play once browser policies have been satisfied.
  45518. */
  45519. unlock(): void;
  45520. private _resumeAudioContext;
  45521. private _initializeAudioContext;
  45522. private _tryToRun;
  45523. private _triggerRunningState;
  45524. private _triggerSuspendedState;
  45525. private _displayMuteButton;
  45526. private _moveButtonToTopLeft;
  45527. private _onResize;
  45528. private _hideMuteButton;
  45529. /**
  45530. * Destroy and release the resources associated with the audio ccontext.
  45531. */
  45532. dispose(): void;
  45533. /**
  45534. * Gets the global volume sets on the master gain.
  45535. * @returns the global volume if set or -1 otherwise
  45536. */
  45537. getGlobalVolume(): number;
  45538. /**
  45539. * Sets the global volume of your experience (sets on the master gain).
  45540. * @param newVolume Defines the new global volume of the application
  45541. */
  45542. setGlobalVolume(newVolume: number): void;
  45543. /**
  45544. * Connect the audio engine to an audio analyser allowing some amazing
  45545. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  45546. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  45547. * @param analyser The analyser to connect to the engine
  45548. */
  45549. connectToAnalyser(analyser: Analyser): void;
  45550. }
  45551. }
  45552. declare module BABYLON {
  45553. /**
  45554. * Options allowed during the creation of a sound track.
  45555. */
  45556. export interface ISoundTrackOptions {
  45557. /**
  45558. * The volume the sound track should take during creation
  45559. */
  45560. volume?: number;
  45561. /**
  45562. * Define if the sound track is the main sound track of the scene
  45563. */
  45564. mainTrack?: boolean;
  45565. }
  45566. /**
  45567. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  45568. * It will be also used in a future release to apply effects on a specific track.
  45569. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  45570. */
  45571. export class SoundTrack {
  45572. /**
  45573. * The unique identifier of the sound track in the scene.
  45574. */
  45575. id: number;
  45576. /**
  45577. * The list of sounds included in the sound track.
  45578. */
  45579. soundCollection: Array<Sound>;
  45580. private _outputAudioNode;
  45581. private _scene;
  45582. private _connectedAnalyser;
  45583. private _options;
  45584. private _isInitialized;
  45585. /**
  45586. * Creates a new sound track.
  45587. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  45588. * @param scene Define the scene the sound track belongs to
  45589. * @param options
  45590. */
  45591. constructor(scene: Scene, options?: ISoundTrackOptions);
  45592. private _initializeSoundTrackAudioGraph;
  45593. /**
  45594. * Release the sound track and its associated resources
  45595. */
  45596. dispose(): void;
  45597. /**
  45598. * Adds a sound to this sound track
  45599. * @param sound define the cound to add
  45600. * @ignoreNaming
  45601. */
  45602. addSound(sound: Sound): void;
  45603. /**
  45604. * Removes a sound to this sound track
  45605. * @param sound define the cound to remove
  45606. * @ignoreNaming
  45607. */
  45608. removeSound(sound: Sound): void;
  45609. /**
  45610. * Set a global volume for the full sound track.
  45611. * @param newVolume Define the new volume of the sound track
  45612. */
  45613. setVolume(newVolume: number): void;
  45614. /**
  45615. * Switch the panning model to HRTF:
  45616. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  45617. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  45618. */
  45619. switchPanningModelToHRTF(): void;
  45620. /**
  45621. * Switch the panning model to Equal Power:
  45622. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  45623. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  45624. */
  45625. switchPanningModelToEqualPower(): void;
  45626. /**
  45627. * Connect the sound track to an audio analyser allowing some amazing
  45628. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  45629. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  45630. * @param analyser The analyser to connect to the engine
  45631. */
  45632. connectToAnalyser(analyser: Analyser): void;
  45633. }
  45634. }
  45635. declare module BABYLON {
  45636. interface AbstractScene {
  45637. /**
  45638. * The list of sounds used in the scene.
  45639. */
  45640. sounds: Nullable<Array<Sound>>;
  45641. }
  45642. interface Scene {
  45643. /**
  45644. * @hidden
  45645. * Backing field
  45646. */
  45647. _mainSoundTrack: SoundTrack;
  45648. /**
  45649. * The main sound track played by the scene.
  45650. * It cotains your primary collection of sounds.
  45651. */
  45652. mainSoundTrack: SoundTrack;
  45653. /**
  45654. * The list of sound tracks added to the scene
  45655. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  45656. */
  45657. soundTracks: Nullable<Array<SoundTrack>>;
  45658. /**
  45659. * Gets a sound using a given name
  45660. * @param name defines the name to search for
  45661. * @return the found sound or null if not found at all.
  45662. */
  45663. getSoundByName(name: string): Nullable<Sound>;
  45664. /**
  45665. * Gets or sets if audio support is enabled
  45666. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  45667. */
  45668. audioEnabled: boolean;
  45669. /**
  45670. * Gets or sets if audio will be output to headphones
  45671. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  45672. */
  45673. headphone: boolean;
  45674. /**
  45675. * Gets or sets custom audio listener position provider
  45676. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  45677. */
  45678. audioListenerPositionProvider: Nullable<() => Vector3>;
  45679. /**
  45680. * Gets or sets a refresh rate when using 3D audio positioning
  45681. */
  45682. audioPositioningRefreshRate: number;
  45683. }
  45684. /**
  45685. * Defines the sound scene component responsible to manage any sounds
  45686. * in a given scene.
  45687. */
  45688. export class AudioSceneComponent implements ISceneSerializableComponent {
  45689. private static _CameraDirectionLH;
  45690. private static _CameraDirectionRH;
  45691. /**
  45692. * The component name helpfull to identify the component in the list of scene components.
  45693. */
  45694. readonly name: string;
  45695. /**
  45696. * The scene the component belongs to.
  45697. */
  45698. scene: Scene;
  45699. private _audioEnabled;
  45700. /**
  45701. * Gets whether audio is enabled or not.
  45702. * Please use related enable/disable method to switch state.
  45703. */
  45704. get audioEnabled(): boolean;
  45705. private _headphone;
  45706. /**
  45707. * Gets whether audio is outputing to headphone or not.
  45708. * Please use the according Switch methods to change output.
  45709. */
  45710. get headphone(): boolean;
  45711. /**
  45712. * Gets or sets a refresh rate when using 3D audio positioning
  45713. */
  45714. audioPositioningRefreshRate: number;
  45715. private _audioListenerPositionProvider;
  45716. /**
  45717. * Gets the current audio listener position provider
  45718. */
  45719. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  45720. /**
  45721. * Sets a custom listener position for all sounds in the scene
  45722. * By default, this is the position of the first active camera
  45723. */
  45724. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  45725. /**
  45726. * Creates a new instance of the component for the given scene
  45727. * @param scene Defines the scene to register the component in
  45728. */
  45729. constructor(scene: Scene);
  45730. /**
  45731. * Registers the component in a given scene
  45732. */
  45733. register(): void;
  45734. /**
  45735. * Rebuilds the elements related to this component in case of
  45736. * context lost for instance.
  45737. */
  45738. rebuild(): void;
  45739. /**
  45740. * Serializes the component data to the specified json object
  45741. * @param serializationObject The object to serialize to
  45742. */
  45743. serialize(serializationObject: any): void;
  45744. /**
  45745. * Adds all the elements from the container to the scene
  45746. * @param container the container holding the elements
  45747. */
  45748. addFromContainer(container: AbstractScene): void;
  45749. /**
  45750. * Removes all the elements in the container from the scene
  45751. * @param container contains the elements to remove
  45752. * @param dispose if the removed element should be disposed (default: false)
  45753. */
  45754. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  45755. /**
  45756. * Disposes the component and the associated ressources.
  45757. */
  45758. dispose(): void;
  45759. /**
  45760. * Disables audio in the associated scene.
  45761. */
  45762. disableAudio(): void;
  45763. /**
  45764. * Enables audio in the associated scene.
  45765. */
  45766. enableAudio(): void;
  45767. /**
  45768. * Switch audio to headphone output.
  45769. */
  45770. switchAudioModeForHeadphones(): void;
  45771. /**
  45772. * Switch audio to normal speakers.
  45773. */
  45774. switchAudioModeForNormalSpeakers(): void;
  45775. private _cachedCameraDirection;
  45776. private _cachedCameraPosition;
  45777. private _lastCheck;
  45778. private _afterRender;
  45779. }
  45780. }
  45781. declare module BABYLON {
  45782. /**
  45783. * Wraps one or more Sound objects and selects one with random weight for playback.
  45784. */
  45785. export class WeightedSound {
  45786. /** When true a Sound will be selected and played when the current playing Sound completes. */
  45787. loop: boolean;
  45788. private _coneInnerAngle;
  45789. private _coneOuterAngle;
  45790. private _volume;
  45791. /** A Sound is currently playing. */
  45792. isPlaying: boolean;
  45793. /** A Sound is currently paused. */
  45794. isPaused: boolean;
  45795. private _sounds;
  45796. private _weights;
  45797. private _currentIndex?;
  45798. /**
  45799. * Creates a new WeightedSound from the list of sounds given.
  45800. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  45801. * @param sounds Array of Sounds that will be selected from.
  45802. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  45803. */
  45804. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  45805. /**
  45806. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  45807. */
  45808. get directionalConeInnerAngle(): number;
  45809. /**
  45810. * The size of cone in degress for a directional sound in which there will be no attenuation.
  45811. */
  45812. set directionalConeInnerAngle(value: number);
  45813. /**
  45814. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  45815. * Listener angles between innerAngle and outerAngle will falloff linearly.
  45816. */
  45817. get directionalConeOuterAngle(): number;
  45818. /**
  45819. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  45820. * Listener angles between innerAngle and outerAngle will falloff linearly.
  45821. */
  45822. set directionalConeOuterAngle(value: number);
  45823. /**
  45824. * Playback volume.
  45825. */
  45826. get volume(): number;
  45827. /**
  45828. * Playback volume.
  45829. */
  45830. set volume(value: number);
  45831. private _onended;
  45832. /**
  45833. * Suspend playback
  45834. */
  45835. pause(): void;
  45836. /**
  45837. * Stop playback
  45838. */
  45839. stop(): void;
  45840. /**
  45841. * Start playback.
  45842. * @param startOffset Position the clip head at a specific time in seconds.
  45843. */
  45844. play(startOffset?: number): void;
  45845. }
  45846. }
  45847. declare module BABYLON {
  45848. /**
  45849. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  45850. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  45851. */
  45852. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  45853. /**
  45854. * Gets the name of the behavior.
  45855. */
  45856. get name(): string;
  45857. /**
  45858. * The easing function used by animations
  45859. */
  45860. static EasingFunction: BackEase;
  45861. /**
  45862. * The easing mode used by animations
  45863. */
  45864. static EasingMode: number;
  45865. /**
  45866. * The duration of the animation, in milliseconds
  45867. */
  45868. transitionDuration: number;
  45869. /**
  45870. * Length of the distance animated by the transition when lower radius is reached
  45871. */
  45872. lowerRadiusTransitionRange: number;
  45873. /**
  45874. * Length of the distance animated by the transition when upper radius is reached
  45875. */
  45876. upperRadiusTransitionRange: number;
  45877. private _autoTransitionRange;
  45878. /**
  45879. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  45880. */
  45881. get autoTransitionRange(): boolean;
  45882. /**
  45883. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  45884. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  45885. */
  45886. set autoTransitionRange(value: boolean);
  45887. private _attachedCamera;
  45888. private _onAfterCheckInputsObserver;
  45889. private _onMeshTargetChangedObserver;
  45890. /**
  45891. * Initializes the behavior.
  45892. */
  45893. init(): void;
  45894. /**
  45895. * Attaches the behavior to its arc rotate camera.
  45896. * @param camera Defines the camera to attach the behavior to
  45897. */
  45898. attach(camera: ArcRotateCamera): void;
  45899. /**
  45900. * Detaches the behavior from its current arc rotate camera.
  45901. */
  45902. detach(): void;
  45903. private _radiusIsAnimating;
  45904. private _radiusBounceTransition;
  45905. private _animatables;
  45906. private _cachedWheelPrecision;
  45907. /**
  45908. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  45909. * @param radiusLimit The limit to check against.
  45910. * @return Bool to indicate if at limit.
  45911. */
  45912. private _isRadiusAtLimit;
  45913. /**
  45914. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  45915. * @param radiusDelta The delta by which to animate to. Can be negative.
  45916. */
  45917. private _applyBoundRadiusAnimation;
  45918. /**
  45919. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  45920. */
  45921. protected _clearAnimationLocks(): void;
  45922. /**
  45923. * Stops and removes all animations that have been applied to the camera
  45924. */
  45925. stopAllAnimations(): void;
  45926. }
  45927. }
  45928. declare module BABYLON {
  45929. /**
  45930. * 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.
  45931. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  45932. */
  45933. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  45934. /**
  45935. * Gets the name of the behavior.
  45936. */
  45937. get name(): string;
  45938. private _mode;
  45939. private _radiusScale;
  45940. private _positionScale;
  45941. private _defaultElevation;
  45942. private _elevationReturnTime;
  45943. private _elevationReturnWaitTime;
  45944. private _zoomStopsAnimation;
  45945. private _framingTime;
  45946. /**
  45947. * The easing function used by animations
  45948. */
  45949. static EasingFunction: ExponentialEase;
  45950. /**
  45951. * The easing mode used by animations
  45952. */
  45953. static EasingMode: number;
  45954. /**
  45955. * Sets the current mode used by the behavior
  45956. */
  45957. set mode(mode: number);
  45958. /**
  45959. * Gets current mode used by the behavior.
  45960. */
  45961. get mode(): number;
  45962. /**
  45963. * Sets the scale applied to the radius (1 by default)
  45964. */
  45965. set radiusScale(radius: number);
  45966. /**
  45967. * Gets the scale applied to the radius
  45968. */
  45969. get radiusScale(): number;
  45970. /**
  45971. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  45972. */
  45973. set positionScale(scale: number);
  45974. /**
  45975. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  45976. */
  45977. get positionScale(): number;
  45978. /**
  45979. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  45980. * behaviour is triggered, in radians.
  45981. */
  45982. set defaultElevation(elevation: number);
  45983. /**
  45984. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  45985. * behaviour is triggered, in radians.
  45986. */
  45987. get defaultElevation(): number;
  45988. /**
  45989. * Sets the time (in milliseconds) taken to return to the default beta position.
  45990. * Negative value indicates camera should not return to default.
  45991. */
  45992. set elevationReturnTime(speed: number);
  45993. /**
  45994. * Gets the time (in milliseconds) taken to return to the default beta position.
  45995. * Negative value indicates camera should not return to default.
  45996. */
  45997. get elevationReturnTime(): number;
  45998. /**
  45999. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  46000. */
  46001. set elevationReturnWaitTime(time: number);
  46002. /**
  46003. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  46004. */
  46005. get elevationReturnWaitTime(): number;
  46006. /**
  46007. * Sets the flag that indicates if user zooming should stop animation.
  46008. */
  46009. set zoomStopsAnimation(flag: boolean);
  46010. /**
  46011. * Gets the flag that indicates if user zooming should stop animation.
  46012. */
  46013. get zoomStopsAnimation(): boolean;
  46014. /**
  46015. * Sets the transition time when framing the mesh, in milliseconds
  46016. */
  46017. set framingTime(time: number);
  46018. /**
  46019. * Gets the transition time when framing the mesh, in milliseconds
  46020. */
  46021. get framingTime(): number;
  46022. /**
  46023. * Define if the behavior should automatically change the configured
  46024. * camera limits and sensibilities.
  46025. */
  46026. autoCorrectCameraLimitsAndSensibility: boolean;
  46027. private _onPrePointerObservableObserver;
  46028. private _onAfterCheckInputsObserver;
  46029. private _onMeshTargetChangedObserver;
  46030. private _attachedCamera;
  46031. private _isPointerDown;
  46032. private _lastInteractionTime;
  46033. /**
  46034. * Initializes the behavior.
  46035. */
  46036. init(): void;
  46037. /**
  46038. * Attaches the behavior to its arc rotate camera.
  46039. * @param camera Defines the camera to attach the behavior to
  46040. */
  46041. attach(camera: ArcRotateCamera): void;
  46042. /**
  46043. * Detaches the behavior from its current arc rotate camera.
  46044. */
  46045. detach(): void;
  46046. private _animatables;
  46047. private _betaIsAnimating;
  46048. private _betaTransition;
  46049. private _radiusTransition;
  46050. private _vectorTransition;
  46051. /**
  46052. * Targets the given mesh and updates zoom level accordingly.
  46053. * @param mesh The mesh to target.
  46054. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  46055. * @param onAnimationEnd Callback triggered at the end of the framing animation
  46056. */
  46057. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  46058. /**
  46059. * Targets the given mesh with its children and updates zoom level accordingly.
  46060. * @param mesh The mesh to target.
  46061. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  46062. * @param onAnimationEnd Callback triggered at the end of the framing animation
  46063. */
  46064. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  46065. /**
  46066. * Targets the given meshes with their children and updates zoom level accordingly.
  46067. * @param meshes The mesh to target.
  46068. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  46069. * @param onAnimationEnd Callback triggered at the end of the framing animation
  46070. */
  46071. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  46072. /**
  46073. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  46074. * @param minimumWorld Determines the smaller position of the bounding box extend
  46075. * @param maximumWorld Determines the bigger position of the bounding box extend
  46076. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  46077. * @param onAnimationEnd Callback triggered at the end of the framing animation
  46078. */
  46079. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  46080. /**
  46081. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  46082. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  46083. * frustum width.
  46084. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  46085. * to fully enclose the mesh in the viewing frustum.
  46086. */
  46087. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  46088. /**
  46089. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  46090. * is automatically returned to its default position (expected to be above ground plane).
  46091. */
  46092. private _maintainCameraAboveGround;
  46093. /**
  46094. * Returns the frustum slope based on the canvas ratio and camera FOV
  46095. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  46096. */
  46097. private _getFrustumSlope;
  46098. /**
  46099. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  46100. */
  46101. private _clearAnimationLocks;
  46102. /**
  46103. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  46104. */
  46105. private _applyUserInteraction;
  46106. /**
  46107. * Stops and removes all animations that have been applied to the camera
  46108. */
  46109. stopAllAnimations(): void;
  46110. /**
  46111. * Gets a value indicating if the user is moving the camera
  46112. */
  46113. get isUserIsMoving(): boolean;
  46114. /**
  46115. * The camera can move all the way towards the mesh.
  46116. */
  46117. static IgnoreBoundsSizeMode: number;
  46118. /**
  46119. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  46120. */
  46121. static FitFrustumSidesMode: number;
  46122. }
  46123. }
  46124. declare module BABYLON {
  46125. /**
  46126. * Base class for Camera Pointer Inputs.
  46127. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  46128. * for example usage.
  46129. */
  46130. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  46131. /**
  46132. * Defines the camera the input is attached to.
  46133. */
  46134. abstract camera: Camera;
  46135. /**
  46136. * Whether keyboard modifier keys are pressed at time of last mouse event.
  46137. */
  46138. protected _altKey: boolean;
  46139. protected _ctrlKey: boolean;
  46140. protected _metaKey: boolean;
  46141. protected _shiftKey: boolean;
  46142. /**
  46143. * Which mouse buttons were pressed at time of last mouse event.
  46144. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  46145. */
  46146. protected _buttonsPressed: number;
  46147. /**
  46148. * Defines the buttons associated with the input to handle camera move.
  46149. */
  46150. buttons: number[];
  46151. /**
  46152. * Attach the input controls to a specific dom element to get the input from.
  46153. * @param element Defines the element the controls should be listened from
  46154. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46155. */
  46156. attachControl(noPreventDefault?: boolean): void;
  46157. /**
  46158. * Detach the current controls from the specified dom element.
  46159. */
  46160. detachControl(): void;
  46161. /**
  46162. * Gets the class name of the current input.
  46163. * @returns the class name
  46164. */
  46165. getClassName(): string;
  46166. /**
  46167. * Get the friendly name associated with the input class.
  46168. * @returns the input friendly name
  46169. */
  46170. getSimpleName(): string;
  46171. /**
  46172. * Called on pointer POINTERDOUBLETAP event.
  46173. * Override this method to provide functionality on POINTERDOUBLETAP event.
  46174. */
  46175. protected onDoubleTap(type: string): void;
  46176. /**
  46177. * Called on pointer POINTERMOVE event if only a single touch is active.
  46178. * Override this method to provide functionality.
  46179. */
  46180. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  46181. /**
  46182. * Called on pointer POINTERMOVE event if multiple touches are active.
  46183. * Override this method to provide functionality.
  46184. */
  46185. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  46186. /**
  46187. * Called on JS contextmenu event.
  46188. * Override this method to provide functionality.
  46189. */
  46190. protected onContextMenu(evt: PointerEvent): void;
  46191. /**
  46192. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  46193. * press.
  46194. * Override this method to provide functionality.
  46195. */
  46196. protected onButtonDown(evt: PointerEvent): void;
  46197. /**
  46198. * Called each time a new POINTERUP event occurs. Ie, for each button
  46199. * release.
  46200. * Override this method to provide functionality.
  46201. */
  46202. protected onButtonUp(evt: PointerEvent): void;
  46203. /**
  46204. * Called when window becomes inactive.
  46205. * Override this method to provide functionality.
  46206. */
  46207. protected onLostFocus(): void;
  46208. private _pointerInput;
  46209. private _observer;
  46210. private _onLostFocus;
  46211. private pointA;
  46212. private pointB;
  46213. }
  46214. }
  46215. declare module BABYLON {
  46216. /**
  46217. * Manage the pointers inputs to control an arc rotate camera.
  46218. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46219. */
  46220. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  46221. /**
  46222. * Defines the camera the input is attached to.
  46223. */
  46224. camera: ArcRotateCamera;
  46225. /**
  46226. * Gets the class name of the current input.
  46227. * @returns the class name
  46228. */
  46229. getClassName(): string;
  46230. /**
  46231. * Defines the buttons associated with the input to handle camera move.
  46232. */
  46233. buttons: number[];
  46234. /**
  46235. * Defines the pointer angular sensibility along the X axis or how fast is
  46236. * the camera rotating.
  46237. */
  46238. angularSensibilityX: number;
  46239. /**
  46240. * Defines the pointer angular sensibility along the Y axis or how fast is
  46241. * the camera rotating.
  46242. */
  46243. angularSensibilityY: number;
  46244. /**
  46245. * Defines the pointer pinch precision or how fast is the camera zooming.
  46246. */
  46247. pinchPrecision: number;
  46248. /**
  46249. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  46250. * from 0.
  46251. * It defines the percentage of current camera.radius to use as delta when
  46252. * pinch zoom is used.
  46253. */
  46254. pinchDeltaPercentage: number;
  46255. /**
  46256. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  46257. * that any object in the plane at the camera's target point will scale
  46258. * perfectly with finger motion.
  46259. * Overrides pinchDeltaPercentage and pinchPrecision.
  46260. */
  46261. useNaturalPinchZoom: boolean;
  46262. /**
  46263. * Defines the pointer panning sensibility or how fast is the camera moving.
  46264. */
  46265. panningSensibility: number;
  46266. /**
  46267. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  46268. */
  46269. multiTouchPanning: boolean;
  46270. /**
  46271. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  46272. * zoom (pinch) through multitouch.
  46273. */
  46274. multiTouchPanAndZoom: boolean;
  46275. /**
  46276. * Revers pinch action direction.
  46277. */
  46278. pinchInwards: boolean;
  46279. private _isPanClick;
  46280. private _twoFingerActivityCount;
  46281. private _isPinching;
  46282. /**
  46283. * Called on pointer POINTERMOVE event if only a single touch is active.
  46284. */
  46285. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  46286. /**
  46287. * Called on pointer POINTERDOUBLETAP event.
  46288. */
  46289. protected onDoubleTap(type: string): void;
  46290. /**
  46291. * Called on pointer POINTERMOVE event if multiple touches are active.
  46292. */
  46293. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  46294. /**
  46295. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  46296. * press.
  46297. */
  46298. protected onButtonDown(evt: PointerEvent): void;
  46299. /**
  46300. * Called each time a new POINTERUP event occurs. Ie, for each button
  46301. * release.
  46302. */
  46303. protected onButtonUp(evt: PointerEvent): void;
  46304. /**
  46305. * Called when window becomes inactive.
  46306. */
  46307. protected onLostFocus(): void;
  46308. }
  46309. }
  46310. declare module BABYLON {
  46311. /**
  46312. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  46313. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46314. */
  46315. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  46316. /**
  46317. * Defines the camera the input is attached to.
  46318. */
  46319. camera: ArcRotateCamera;
  46320. /**
  46321. * Defines the list of key codes associated with the up action (increase alpha)
  46322. */
  46323. keysUp: number[];
  46324. /**
  46325. * Defines the list of key codes associated with the down action (decrease alpha)
  46326. */
  46327. keysDown: number[];
  46328. /**
  46329. * Defines the list of key codes associated with the left action (increase beta)
  46330. */
  46331. keysLeft: number[];
  46332. /**
  46333. * Defines the list of key codes associated with the right action (decrease beta)
  46334. */
  46335. keysRight: number[];
  46336. /**
  46337. * Defines the list of key codes associated with the reset action.
  46338. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  46339. */
  46340. keysReset: number[];
  46341. /**
  46342. * Defines the panning sensibility of the inputs.
  46343. * (How fast is the camera panning)
  46344. */
  46345. panningSensibility: number;
  46346. /**
  46347. * Defines the zooming sensibility of the inputs.
  46348. * (How fast is the camera zooming)
  46349. */
  46350. zoomingSensibility: number;
  46351. /**
  46352. * Defines whether maintaining the alt key down switch the movement mode from
  46353. * orientation to zoom.
  46354. */
  46355. useAltToZoom: boolean;
  46356. /**
  46357. * Rotation speed of the camera
  46358. */
  46359. angularSpeed: number;
  46360. private _keys;
  46361. private _ctrlPressed;
  46362. private _altPressed;
  46363. private _onCanvasBlurObserver;
  46364. private _onKeyboardObserver;
  46365. private _engine;
  46366. private _scene;
  46367. /**
  46368. * Attach the input controls to a specific dom element to get the input from.
  46369. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46370. */
  46371. attachControl(noPreventDefault?: boolean): void;
  46372. /**
  46373. * Detach the current controls from the specified dom element.
  46374. */
  46375. detachControl(): void;
  46376. /**
  46377. * Update the current camera state depending on the inputs that have been used this frame.
  46378. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46379. */
  46380. checkInputs(): void;
  46381. /**
  46382. * Gets the class name of the current intput.
  46383. * @returns the class name
  46384. */
  46385. getClassName(): string;
  46386. /**
  46387. * Get the friendly name associated with the input class.
  46388. * @returns the input friendly name
  46389. */
  46390. getSimpleName(): string;
  46391. }
  46392. }
  46393. declare module BABYLON {
  46394. /**
  46395. * Manage the mouse wheel inputs to control an arc rotate camera.
  46396. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46397. */
  46398. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  46399. /**
  46400. * Defines the camera the input is attached to.
  46401. */
  46402. camera: ArcRotateCamera;
  46403. /**
  46404. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  46405. */
  46406. wheelPrecision: number;
  46407. /**
  46408. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  46409. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  46410. */
  46411. wheelDeltaPercentage: number;
  46412. private _wheel;
  46413. private _observer;
  46414. private computeDeltaFromMouseWheelLegacyEvent;
  46415. /**
  46416. * Attach the input controls to a specific dom element to get the input from.
  46417. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46418. */
  46419. attachControl(noPreventDefault?: boolean): void;
  46420. /**
  46421. * Detach the current controls from the specified dom element.
  46422. */
  46423. detachControl(): void;
  46424. /**
  46425. * Gets the class name of the current intput.
  46426. * @returns the class name
  46427. */
  46428. getClassName(): string;
  46429. /**
  46430. * Get the friendly name associated with the input class.
  46431. * @returns the input friendly name
  46432. */
  46433. getSimpleName(): string;
  46434. }
  46435. }
  46436. declare module BABYLON {
  46437. /**
  46438. * Default Inputs manager for the ArcRotateCamera.
  46439. * It groups all the default supported inputs for ease of use.
  46440. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46441. */
  46442. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  46443. /**
  46444. * Instantiates a new ArcRotateCameraInputsManager.
  46445. * @param camera Defines the camera the inputs belong to
  46446. */
  46447. constructor(camera: ArcRotateCamera);
  46448. /**
  46449. * Add mouse wheel input support to the input manager.
  46450. * @returns the current input manager
  46451. */
  46452. addMouseWheel(): ArcRotateCameraInputsManager;
  46453. /**
  46454. * Add pointers input support to the input manager.
  46455. * @returns the current input manager
  46456. */
  46457. addPointers(): ArcRotateCameraInputsManager;
  46458. /**
  46459. * Add keyboard input support to the input manager.
  46460. * @returns the current input manager
  46461. */
  46462. addKeyboard(): ArcRotateCameraInputsManager;
  46463. }
  46464. }
  46465. declare module BABYLON {
  46466. /**
  46467. * This represents an orbital type of camera.
  46468. *
  46469. * 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.
  46470. * 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.
  46471. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  46472. */
  46473. export class ArcRotateCamera extends TargetCamera {
  46474. /**
  46475. * Defines the rotation angle of the camera along the longitudinal axis.
  46476. */
  46477. alpha: number;
  46478. /**
  46479. * Defines the rotation angle of the camera along the latitudinal axis.
  46480. */
  46481. beta: number;
  46482. /**
  46483. * Defines the radius of the camera from it s target point.
  46484. */
  46485. radius: number;
  46486. protected _target: Vector3;
  46487. protected _targetHost: Nullable<AbstractMesh>;
  46488. /**
  46489. * Defines the target point of the camera.
  46490. * The camera looks towards it form the radius distance.
  46491. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  46492. */
  46493. get target(): Vector3;
  46494. set target(value: Vector3);
  46495. /**
  46496. * Define the current local position of the camera in the scene
  46497. */
  46498. get position(): Vector3;
  46499. set position(newPosition: Vector3);
  46500. protected _upToYMatrix: Matrix;
  46501. protected _YToUpMatrix: Matrix;
  46502. /**
  46503. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  46504. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  46505. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  46506. */
  46507. set upVector(vec: Vector3);
  46508. get upVector(): Vector3;
  46509. /**
  46510. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  46511. */
  46512. setMatUp(): void;
  46513. /**
  46514. * Current inertia value on the longitudinal axis.
  46515. * The bigger this number the longer it will take for the camera to stop.
  46516. */
  46517. inertialAlphaOffset: number;
  46518. /**
  46519. * Current inertia value on the latitudinal axis.
  46520. * The bigger this number the longer it will take for the camera to stop.
  46521. */
  46522. inertialBetaOffset: number;
  46523. /**
  46524. * Current inertia value on the radius axis.
  46525. * The bigger this number the longer it will take for the camera to stop.
  46526. */
  46527. inertialRadiusOffset: number;
  46528. /**
  46529. * Minimum allowed angle on the longitudinal axis.
  46530. * This can help limiting how the Camera is able to move in the scene.
  46531. */
  46532. lowerAlphaLimit: Nullable<number>;
  46533. /**
  46534. * Maximum allowed angle on the longitudinal axis.
  46535. * This can help limiting how the Camera is able to move in the scene.
  46536. */
  46537. upperAlphaLimit: Nullable<number>;
  46538. /**
  46539. * Minimum allowed angle on the latitudinal axis.
  46540. * This can help limiting how the Camera is able to move in the scene.
  46541. */
  46542. lowerBetaLimit: number;
  46543. /**
  46544. * Maximum allowed angle on the latitudinal axis.
  46545. * This can help limiting how the Camera is able to move in the scene.
  46546. */
  46547. upperBetaLimit: number;
  46548. /**
  46549. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  46550. * This can help limiting how the Camera is able to move in the scene.
  46551. */
  46552. lowerRadiusLimit: Nullable<number>;
  46553. /**
  46554. * Maximum allowed distance of the camera to the target (The camera can not get further).
  46555. * This can help limiting how the Camera is able to move in the scene.
  46556. */
  46557. upperRadiusLimit: Nullable<number>;
  46558. /**
  46559. * Defines the current inertia value used during panning of the camera along the X axis.
  46560. */
  46561. inertialPanningX: number;
  46562. /**
  46563. * Defines the current inertia value used during panning of the camera along the Y axis.
  46564. */
  46565. inertialPanningY: number;
  46566. /**
  46567. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  46568. * Basically if your fingers moves away from more than this distance you will be considered
  46569. * in pinch mode.
  46570. */
  46571. pinchToPanMaxDistance: number;
  46572. /**
  46573. * Defines the maximum distance the camera can pan.
  46574. * This could help keeping the cammera always in your scene.
  46575. */
  46576. panningDistanceLimit: Nullable<number>;
  46577. /**
  46578. * Defines the target of the camera before paning.
  46579. */
  46580. panningOriginTarget: Vector3;
  46581. /**
  46582. * Defines the value of the inertia used during panning.
  46583. * 0 would mean stop inertia and one would mean no decelleration at all.
  46584. */
  46585. panningInertia: number;
  46586. /**
  46587. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  46588. */
  46589. get angularSensibilityX(): number;
  46590. set angularSensibilityX(value: number);
  46591. /**
  46592. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  46593. */
  46594. get angularSensibilityY(): number;
  46595. set angularSensibilityY(value: number);
  46596. /**
  46597. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  46598. */
  46599. get pinchPrecision(): number;
  46600. set pinchPrecision(value: number);
  46601. /**
  46602. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  46603. * It will be used instead of pinchDeltaPrecision if different from 0.
  46604. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  46605. */
  46606. get pinchDeltaPercentage(): number;
  46607. set pinchDeltaPercentage(value: number);
  46608. /**
  46609. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  46610. * and pinch delta percentage.
  46611. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  46612. * that any object in the plane at the camera's target point will scale
  46613. * perfectly with finger motion.
  46614. */
  46615. get useNaturalPinchZoom(): boolean;
  46616. set useNaturalPinchZoom(value: boolean);
  46617. /**
  46618. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  46619. */
  46620. get panningSensibility(): number;
  46621. set panningSensibility(value: number);
  46622. /**
  46623. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  46624. */
  46625. get keysUp(): number[];
  46626. set keysUp(value: number[]);
  46627. /**
  46628. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  46629. */
  46630. get keysDown(): number[];
  46631. set keysDown(value: number[]);
  46632. /**
  46633. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  46634. */
  46635. get keysLeft(): number[];
  46636. set keysLeft(value: number[]);
  46637. /**
  46638. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  46639. */
  46640. get keysRight(): number[];
  46641. set keysRight(value: number[]);
  46642. /**
  46643. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  46644. */
  46645. get wheelPrecision(): number;
  46646. set wheelPrecision(value: number);
  46647. /**
  46648. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  46649. * It will be used instead of pinchDeltaPrecision if different from 0.
  46650. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  46651. */
  46652. get wheelDeltaPercentage(): number;
  46653. set wheelDeltaPercentage(value: number);
  46654. /**
  46655. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  46656. */
  46657. zoomOnFactor: number;
  46658. /**
  46659. * Defines a screen offset for the camera position.
  46660. */
  46661. targetScreenOffset: Vector2;
  46662. /**
  46663. * Allows the camera to be completely reversed.
  46664. * If false the camera can not arrive upside down.
  46665. */
  46666. allowUpsideDown: boolean;
  46667. /**
  46668. * Define if double tap/click is used to restore the previously saved state of the camera.
  46669. */
  46670. useInputToRestoreState: boolean;
  46671. /** @hidden */
  46672. _viewMatrix: Matrix;
  46673. /** @hidden */
  46674. _useCtrlForPanning: boolean;
  46675. /** @hidden */
  46676. _panningMouseButton: number;
  46677. /**
  46678. * Defines the input associated to the camera.
  46679. */
  46680. inputs: ArcRotateCameraInputsManager;
  46681. /** @hidden */
  46682. _reset: () => void;
  46683. /**
  46684. * Defines the allowed panning axis.
  46685. */
  46686. panningAxis: Vector3;
  46687. protected _localDirection: Vector3;
  46688. protected _transformedDirection: Vector3;
  46689. private _bouncingBehavior;
  46690. /**
  46691. * Gets the bouncing behavior of the camera if it has been enabled.
  46692. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  46693. */
  46694. get bouncingBehavior(): Nullable<BouncingBehavior>;
  46695. /**
  46696. * Defines if the bouncing behavior of the camera is enabled on the camera.
  46697. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  46698. */
  46699. get useBouncingBehavior(): boolean;
  46700. set useBouncingBehavior(value: boolean);
  46701. private _framingBehavior;
  46702. /**
  46703. * Gets the framing behavior of the camera if it has been enabled.
  46704. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  46705. */
  46706. get framingBehavior(): Nullable<FramingBehavior>;
  46707. /**
  46708. * Defines if the framing behavior of the camera is enabled on the camera.
  46709. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  46710. */
  46711. get useFramingBehavior(): boolean;
  46712. set useFramingBehavior(value: boolean);
  46713. private _autoRotationBehavior;
  46714. /**
  46715. * Gets the auto rotation behavior of the camera if it has been enabled.
  46716. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  46717. */
  46718. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  46719. /**
  46720. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  46721. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  46722. */
  46723. get useAutoRotationBehavior(): boolean;
  46724. set useAutoRotationBehavior(value: boolean);
  46725. /**
  46726. * Observable triggered when the mesh target has been changed on the camera.
  46727. */
  46728. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  46729. /**
  46730. * Event raised when the camera is colliding with a mesh.
  46731. */
  46732. onCollide: (collidedMesh: AbstractMesh) => void;
  46733. /**
  46734. * Defines whether the camera should check collision with the objects oh the scene.
  46735. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  46736. */
  46737. checkCollisions: boolean;
  46738. /**
  46739. * Defines the collision radius of the camera.
  46740. * This simulates a sphere around the camera.
  46741. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  46742. */
  46743. collisionRadius: Vector3;
  46744. protected _collider: Collider;
  46745. protected _previousPosition: Vector3;
  46746. protected _collisionVelocity: Vector3;
  46747. protected _newPosition: Vector3;
  46748. protected _previousAlpha: number;
  46749. protected _previousBeta: number;
  46750. protected _previousRadius: number;
  46751. protected _collisionTriggered: boolean;
  46752. protected _targetBoundingCenter: Nullable<Vector3>;
  46753. private _computationVector;
  46754. /**
  46755. * Instantiates a new ArcRotateCamera in a given scene
  46756. * @param name Defines the name of the camera
  46757. * @param alpha Defines the camera rotation along the logitudinal axis
  46758. * @param beta Defines the camera rotation along the latitudinal axis
  46759. * @param radius Defines the camera distance from its target
  46760. * @param target Defines the camera target
  46761. * @param scene Defines the scene the camera belongs to
  46762. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  46763. */
  46764. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  46765. /** @hidden */
  46766. _initCache(): void;
  46767. /** @hidden */
  46768. _updateCache(ignoreParentClass?: boolean): void;
  46769. protected _getTargetPosition(): Vector3;
  46770. private _storedAlpha;
  46771. private _storedBeta;
  46772. private _storedRadius;
  46773. private _storedTarget;
  46774. private _storedTargetScreenOffset;
  46775. /**
  46776. * Stores the current state of the camera (alpha, beta, radius and target)
  46777. * @returns the camera itself
  46778. */
  46779. storeState(): Camera;
  46780. /**
  46781. * @hidden
  46782. * Restored camera state. You must call storeState() first
  46783. */
  46784. _restoreStateValues(): boolean;
  46785. /** @hidden */
  46786. _isSynchronizedViewMatrix(): boolean;
  46787. /**
  46788. * Attach the input controls to a specific dom element to get the input from.
  46789. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46790. */
  46791. attachControl(noPreventDefault?: boolean): void;
  46792. /**
  46793. * Attach the input controls to a specific dom element to get the input from.
  46794. * @param ignored defines an ignored parameter kept for backward compatibility. If you want to define the source input element, you can set engine.inputElement before calling camera.attachControl
  46795. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46796. */
  46797. attachControl(ignored: any, noPreventDefault?: boolean): void;
  46798. /**
  46799. * Attached controls to the current camera.
  46800. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46801. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  46802. */
  46803. attachControl(noPreventDefault: boolean, useCtrlForPanning: boolean): void;
  46804. /**
  46805. * Attached controls to the current camera.
  46806. * @param ignored defines an ignored parameter kept for backward compatibility. If you want to define the source input element, you can set engine.inputElement before calling camera.attachControl
  46807. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46808. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  46809. */
  46810. attachControl(ignored: any, noPreventDefault: boolean, useCtrlForPanning: boolean): void;
  46811. /**
  46812. * Attached controls to the current camera.
  46813. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46814. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  46815. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  46816. */
  46817. attachControl(noPreventDefault: boolean, useCtrlForPanning: boolean, panningMouseButton: number): void;
  46818. /**
  46819. * Detach the current controls from the specified dom element.
  46820. */
  46821. detachControl(): void;
  46822. /**
  46823. * Detach the current controls from the specified dom element.
  46824. * @param ignored defines an ignored parameter kept for backward compatibility. If you want to define the source input element, you can set engine.inputElement before calling camera.attachControl
  46825. */
  46826. detachControl(ignored: any): void;
  46827. /** @hidden */
  46828. _checkInputs(): void;
  46829. protected _checkLimits(): void;
  46830. /**
  46831. * Rebuilds angles (alpha, beta) and radius from the give position and target
  46832. */
  46833. rebuildAnglesAndRadius(): void;
  46834. /**
  46835. * Use a position to define the current camera related information like alpha, beta and radius
  46836. * @param position Defines the position to set the camera at
  46837. */
  46838. setPosition(position: Vector3): void;
  46839. /**
  46840. * Defines the target the camera should look at.
  46841. * This will automatically adapt alpha beta and radius to fit within the new target.
  46842. * @param target Defines the new target as a Vector or a mesh
  46843. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  46844. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  46845. */
  46846. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  46847. /** @hidden */
  46848. _getViewMatrix(): Matrix;
  46849. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  46850. /**
  46851. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  46852. * @param meshes Defines the mesh to zoom on
  46853. * @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)
  46854. */
  46855. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  46856. /**
  46857. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  46858. * The target will be changed but the radius
  46859. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  46860. * @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)
  46861. */
  46862. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  46863. min: Vector3;
  46864. max: Vector3;
  46865. distance: number;
  46866. }, doNotUpdateMaxZ?: boolean): void;
  46867. /**
  46868. * @override
  46869. * Override Camera.createRigCamera
  46870. */
  46871. createRigCamera(name: string, cameraIndex: number): Camera;
  46872. /**
  46873. * @hidden
  46874. * @override
  46875. * Override Camera._updateRigCameras
  46876. */
  46877. _updateRigCameras(): void;
  46878. /**
  46879. * Destroy the camera and release the current resources hold by it.
  46880. */
  46881. dispose(): void;
  46882. /**
  46883. * Gets the current object class name.
  46884. * @return the class name
  46885. */
  46886. getClassName(): string;
  46887. }
  46888. }
  46889. declare module BABYLON {
  46890. /**
  46891. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  46892. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  46893. */
  46894. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  46895. /**
  46896. * Gets the name of the behavior.
  46897. */
  46898. get name(): string;
  46899. private _zoomStopsAnimation;
  46900. private _idleRotationSpeed;
  46901. private _idleRotationWaitTime;
  46902. private _idleRotationSpinupTime;
  46903. /**
  46904. * Sets the flag that indicates if user zooming should stop animation.
  46905. */
  46906. set zoomStopsAnimation(flag: boolean);
  46907. /**
  46908. * Gets the flag that indicates if user zooming should stop animation.
  46909. */
  46910. get zoomStopsAnimation(): boolean;
  46911. /**
  46912. * Sets the default speed at which the camera rotates around the model.
  46913. */
  46914. set idleRotationSpeed(speed: number);
  46915. /**
  46916. * Gets the default speed at which the camera rotates around the model.
  46917. */
  46918. get idleRotationSpeed(): number;
  46919. /**
  46920. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  46921. */
  46922. set idleRotationWaitTime(time: number);
  46923. /**
  46924. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  46925. */
  46926. get idleRotationWaitTime(): number;
  46927. /**
  46928. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  46929. */
  46930. set idleRotationSpinupTime(time: number);
  46931. /**
  46932. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  46933. */
  46934. get idleRotationSpinupTime(): number;
  46935. /**
  46936. * Gets a value indicating if the camera is currently rotating because of this behavior
  46937. */
  46938. get rotationInProgress(): boolean;
  46939. private _onPrePointerObservableObserver;
  46940. private _onAfterCheckInputsObserver;
  46941. private _attachedCamera;
  46942. private _isPointerDown;
  46943. private _lastFrameTime;
  46944. private _lastInteractionTime;
  46945. private _cameraRotationSpeed;
  46946. /**
  46947. * Initializes the behavior.
  46948. */
  46949. init(): void;
  46950. /**
  46951. * Attaches the behavior to its arc rotate camera.
  46952. * @param camera Defines the camera to attach the behavior to
  46953. */
  46954. attach(camera: ArcRotateCamera): void;
  46955. /**
  46956. * Detaches the behavior from its current arc rotate camera.
  46957. */
  46958. detach(): void;
  46959. /**
  46960. * Returns true if user is scrolling.
  46961. * @return true if user is scrolling.
  46962. */
  46963. private _userIsZooming;
  46964. private _lastFrameRadius;
  46965. private _shouldAnimationStopForInteraction;
  46966. /**
  46967. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  46968. */
  46969. private _applyUserInteraction;
  46970. private _userIsMoving;
  46971. }
  46972. }
  46973. declare module BABYLON {
  46974. /**
  46975. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  46976. */
  46977. export class AttachToBoxBehavior implements Behavior<Mesh> {
  46978. private ui;
  46979. /**
  46980. * The name of the behavior
  46981. */
  46982. name: string;
  46983. /**
  46984. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  46985. */
  46986. distanceAwayFromFace: number;
  46987. /**
  46988. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  46989. */
  46990. distanceAwayFromBottomOfFace: number;
  46991. private _faceVectors;
  46992. private _target;
  46993. private _scene;
  46994. private _onRenderObserver;
  46995. private _tmpMatrix;
  46996. private _tmpVector;
  46997. /**
  46998. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  46999. * @param ui The transform node that should be attched to the mesh
  47000. */
  47001. constructor(ui: TransformNode);
  47002. /**
  47003. * Initializes the behavior
  47004. */
  47005. init(): void;
  47006. private _closestFace;
  47007. private _zeroVector;
  47008. private _lookAtTmpMatrix;
  47009. private _lookAtToRef;
  47010. /**
  47011. * Attaches the AttachToBoxBehavior to the passed in mesh
  47012. * @param target The mesh that the specified node will be attached to
  47013. */
  47014. attach(target: Mesh): void;
  47015. /**
  47016. * Detaches the behavior from the mesh
  47017. */
  47018. detach(): void;
  47019. }
  47020. }
  47021. declare module BABYLON {
  47022. /**
  47023. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  47024. */
  47025. export class FadeInOutBehavior implements Behavior<Mesh> {
  47026. /**
  47027. * Time in milliseconds to delay before fading in (Default: 0)
  47028. */
  47029. delay: number;
  47030. /**
  47031. * Time in milliseconds for the mesh to fade in (Default: 300)
  47032. */
  47033. fadeInTime: number;
  47034. private _millisecondsPerFrame;
  47035. private _hovered;
  47036. private _hoverValue;
  47037. private _ownerNode;
  47038. /**
  47039. * Instatiates the FadeInOutBehavior
  47040. */
  47041. constructor();
  47042. /**
  47043. * The name of the behavior
  47044. */
  47045. get name(): string;
  47046. /**
  47047. * Initializes the behavior
  47048. */
  47049. init(): void;
  47050. /**
  47051. * Attaches the fade behavior on the passed in mesh
  47052. * @param ownerNode The mesh that will be faded in/out once attached
  47053. */
  47054. attach(ownerNode: Mesh): void;
  47055. /**
  47056. * Detaches the behavior from the mesh
  47057. */
  47058. detach(): void;
  47059. /**
  47060. * Triggers the mesh to begin fading in or out
  47061. * @param value if the object should fade in or out (true to fade in)
  47062. */
  47063. fadeIn(value: boolean): void;
  47064. private _update;
  47065. private _setAllVisibility;
  47066. }
  47067. }
  47068. declare module BABYLON {
  47069. /**
  47070. * Class containing a set of static utilities functions for managing Pivots
  47071. * @hidden
  47072. */
  47073. export class PivotTools {
  47074. private static _PivotCached;
  47075. private static _OldPivotPoint;
  47076. private static _PivotTranslation;
  47077. private static _PivotTmpVector;
  47078. private static _PivotPostMultiplyPivotMatrix;
  47079. /** @hidden */
  47080. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  47081. /** @hidden */
  47082. static _RestorePivotPoint(mesh: AbstractMesh): void;
  47083. }
  47084. }
  47085. declare module BABYLON {
  47086. /**
  47087. * Class containing static functions to help procedurally build meshes
  47088. */
  47089. export class PlaneBuilder {
  47090. /**
  47091. * Creates a plane mesh
  47092. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  47093. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  47094. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  47095. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  47096. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  47097. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  47098. * @param name defines the name of the mesh
  47099. * @param options defines the options used to create the mesh
  47100. * @param scene defines the hosting scene
  47101. * @returns the plane mesh
  47102. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  47103. */
  47104. static CreatePlane(name: string, options: {
  47105. size?: number;
  47106. width?: number;
  47107. height?: number;
  47108. sideOrientation?: number;
  47109. frontUVs?: Vector4;
  47110. backUVs?: Vector4;
  47111. updatable?: boolean;
  47112. sourcePlane?: Plane;
  47113. }, scene?: Nullable<Scene>): Mesh;
  47114. }
  47115. }
  47116. declare module BABYLON {
  47117. /**
  47118. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  47119. */
  47120. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  47121. private static _AnyMouseID;
  47122. /**
  47123. * Abstract mesh the behavior is set on
  47124. */
  47125. attachedNode: AbstractMesh;
  47126. private _dragPlane;
  47127. private _scene;
  47128. private _pointerObserver;
  47129. private _beforeRenderObserver;
  47130. private static _planeScene;
  47131. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  47132. /**
  47133. * 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)
  47134. */
  47135. maxDragAngle: number;
  47136. /**
  47137. * @hidden
  47138. */
  47139. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  47140. /**
  47141. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  47142. */
  47143. currentDraggingPointerID: number;
  47144. /**
  47145. * The last position where the pointer hit the drag plane in world space
  47146. */
  47147. lastDragPosition: Vector3;
  47148. /**
  47149. * If the behavior is currently in a dragging state
  47150. */
  47151. dragging: boolean;
  47152. /**
  47153. * 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)
  47154. */
  47155. dragDeltaRatio: number;
  47156. /**
  47157. * If the drag plane orientation should be updated during the dragging (Default: true)
  47158. */
  47159. updateDragPlane: boolean;
  47160. private _debugMode;
  47161. private _moving;
  47162. /**
  47163. * Fires each time the attached mesh is dragged with the pointer
  47164. * * delta between last drag position and current drag position in world space
  47165. * * dragDistance along the drag axis
  47166. * * dragPlaneNormal normal of the current drag plane used during the drag
  47167. * * dragPlanePoint in world space where the drag intersects the drag plane
  47168. */
  47169. onDragObservable: Observable<{
  47170. delta: Vector3;
  47171. dragPlanePoint: Vector3;
  47172. dragPlaneNormal: Vector3;
  47173. dragDistance: number;
  47174. pointerId: number;
  47175. }>;
  47176. /**
  47177. * Fires each time a drag begins (eg. mouse down on mesh)
  47178. */
  47179. onDragStartObservable: Observable<{
  47180. dragPlanePoint: Vector3;
  47181. pointerId: number;
  47182. }>;
  47183. /**
  47184. * Fires each time a drag ends (eg. mouse release after drag)
  47185. */
  47186. onDragEndObservable: Observable<{
  47187. dragPlanePoint: Vector3;
  47188. pointerId: number;
  47189. }>;
  47190. /**
  47191. * If the attached mesh should be moved when dragged
  47192. */
  47193. moveAttached: boolean;
  47194. /**
  47195. * If the drag behavior will react to drag events (Default: true)
  47196. */
  47197. enabled: boolean;
  47198. /**
  47199. * If pointer events should start and release the drag (Default: true)
  47200. */
  47201. startAndReleaseDragOnPointerEvents: boolean;
  47202. /**
  47203. * If camera controls should be detached during the drag
  47204. */
  47205. detachCameraControls: boolean;
  47206. /**
  47207. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  47208. */
  47209. useObjectOrientationForDragging: boolean;
  47210. private _options;
  47211. /**
  47212. * Gets the options used by the behavior
  47213. */
  47214. get options(): {
  47215. dragAxis?: Vector3;
  47216. dragPlaneNormal?: Vector3;
  47217. };
  47218. /**
  47219. * Sets the options used by the behavior
  47220. */
  47221. set options(options: {
  47222. dragAxis?: Vector3;
  47223. dragPlaneNormal?: Vector3;
  47224. });
  47225. /**
  47226. * Creates a pointer drag behavior that can be attached to a mesh
  47227. * @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)
  47228. */
  47229. constructor(options?: {
  47230. dragAxis?: Vector3;
  47231. dragPlaneNormal?: Vector3;
  47232. });
  47233. /**
  47234. * Predicate to determine if it is valid to move the object to a new position when it is moved
  47235. */
  47236. validateDrag: (targetPosition: Vector3) => boolean;
  47237. /**
  47238. * The name of the behavior
  47239. */
  47240. get name(): string;
  47241. /**
  47242. * Initializes the behavior
  47243. */
  47244. init(): void;
  47245. private _tmpVector;
  47246. private _alternatePickedPoint;
  47247. private _worldDragAxis;
  47248. private _targetPosition;
  47249. private _attachedToElement;
  47250. /**
  47251. * Attaches the drag behavior the passed in mesh
  47252. * @param ownerNode The mesh that will be dragged around once attached
  47253. * @param predicate Predicate to use for pick filtering
  47254. */
  47255. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  47256. /**
  47257. * Force relase the drag action by code.
  47258. */
  47259. releaseDrag(): void;
  47260. private _startDragRay;
  47261. private _lastPointerRay;
  47262. /**
  47263. * Simulates the start of a pointer drag event on the behavior
  47264. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  47265. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  47266. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  47267. */
  47268. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  47269. protected _startDrag(pointerId: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  47270. private _dragDelta;
  47271. protected _moveDrag(ray: Ray): void;
  47272. private _pickWithRayOnDragPlane;
  47273. private _pointA;
  47274. private _pointC;
  47275. private _localAxis;
  47276. private _lookAt;
  47277. private _updateDragPlanePosition;
  47278. /**
  47279. * Detaches the behavior from the mesh
  47280. */
  47281. detach(): void;
  47282. }
  47283. }
  47284. declare module BABYLON {
  47285. /**
  47286. * A behavior that when attached to a mesh will allow the mesh to be scaled
  47287. */
  47288. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  47289. private _dragBehaviorA;
  47290. private _dragBehaviorB;
  47291. private _startDistance;
  47292. private _initialScale;
  47293. private _targetScale;
  47294. private _ownerNode;
  47295. private _sceneRenderObserver;
  47296. /**
  47297. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  47298. */
  47299. constructor();
  47300. /**
  47301. * The name of the behavior
  47302. */
  47303. get name(): string;
  47304. /**
  47305. * Initializes the behavior
  47306. */
  47307. init(): void;
  47308. private _getCurrentDistance;
  47309. /**
  47310. * Attaches the scale behavior the passed in mesh
  47311. * @param ownerNode The mesh that will be scaled around once attached
  47312. */
  47313. attach(ownerNode: Mesh): void;
  47314. /**
  47315. * Detaches the behavior from the mesh
  47316. */
  47317. detach(): void;
  47318. }
  47319. }
  47320. declare module BABYLON {
  47321. /**
  47322. * 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
  47323. */
  47324. export class SixDofDragBehavior implements Behavior<Mesh> {
  47325. private static _virtualScene;
  47326. private _ownerNode;
  47327. private _sceneRenderObserver;
  47328. private _scene;
  47329. private _targetPosition;
  47330. private _virtualOriginMesh;
  47331. private _virtualDragMesh;
  47332. private _pointerObserver;
  47333. private _moving;
  47334. private _startingOrientation;
  47335. private _attachedToElement;
  47336. /**
  47337. * 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)
  47338. */
  47339. private zDragFactor;
  47340. /**
  47341. * If the object should rotate to face the drag origin
  47342. */
  47343. rotateDraggedObject: boolean;
  47344. /**
  47345. * If the behavior is currently in a dragging state
  47346. */
  47347. dragging: boolean;
  47348. /**
  47349. * 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)
  47350. */
  47351. dragDeltaRatio: number;
  47352. /**
  47353. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  47354. */
  47355. currentDraggingPointerID: number;
  47356. /**
  47357. * If camera controls should be detached during the drag
  47358. */
  47359. detachCameraControls: boolean;
  47360. /**
  47361. * Fires each time a drag starts
  47362. */
  47363. onDragStartObservable: Observable<{}>;
  47364. /**
  47365. * Fires each time a drag happens
  47366. */
  47367. onDragObservable: Observable<void>;
  47368. /**
  47369. * Fires each time a drag ends (eg. mouse release after drag)
  47370. */
  47371. onDragEndObservable: Observable<{}>;
  47372. /**
  47373. * 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
  47374. */
  47375. constructor();
  47376. /**
  47377. * The name of the behavior
  47378. */
  47379. get name(): string;
  47380. /**
  47381. * Initializes the behavior
  47382. */
  47383. init(): void;
  47384. /**
  47385. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  47386. */
  47387. private get _pointerCamera();
  47388. /**
  47389. * Attaches the scale behavior the passed in mesh
  47390. * @param ownerNode The mesh that will be scaled around once attached
  47391. */
  47392. attach(ownerNode: Mesh): void;
  47393. /**
  47394. * Detaches the behavior from the mesh
  47395. */
  47396. detach(): void;
  47397. }
  47398. }
  47399. declare module BABYLON {
  47400. /**
  47401. * Class used to apply inverse kinematics to bones
  47402. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  47403. */
  47404. export class BoneIKController {
  47405. private static _tmpVecs;
  47406. private static _tmpQuat;
  47407. private static _tmpMats;
  47408. /**
  47409. * Gets or sets the target mesh
  47410. */
  47411. targetMesh: AbstractMesh;
  47412. /** Gets or sets the mesh used as pole */
  47413. poleTargetMesh: AbstractMesh;
  47414. /**
  47415. * Gets or sets the bone used as pole
  47416. */
  47417. poleTargetBone: Nullable<Bone>;
  47418. /**
  47419. * Gets or sets the target position
  47420. */
  47421. targetPosition: Vector3;
  47422. /**
  47423. * Gets or sets the pole target position
  47424. */
  47425. poleTargetPosition: Vector3;
  47426. /**
  47427. * Gets or sets the pole target local offset
  47428. */
  47429. poleTargetLocalOffset: Vector3;
  47430. /**
  47431. * Gets or sets the pole angle
  47432. */
  47433. poleAngle: number;
  47434. /**
  47435. * Gets or sets the mesh associated with the controller
  47436. */
  47437. mesh: AbstractMesh;
  47438. /**
  47439. * 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)
  47440. */
  47441. slerpAmount: number;
  47442. private _bone1Quat;
  47443. private _bone1Mat;
  47444. private _bone2Ang;
  47445. private _bone1;
  47446. private _bone2;
  47447. private _bone1Length;
  47448. private _bone2Length;
  47449. private _maxAngle;
  47450. private _maxReach;
  47451. private _rightHandedSystem;
  47452. private _bendAxis;
  47453. private _slerping;
  47454. private _adjustRoll;
  47455. /**
  47456. * Gets or sets maximum allowed angle
  47457. */
  47458. get maxAngle(): number;
  47459. set maxAngle(value: number);
  47460. /**
  47461. * Creates a new BoneIKController
  47462. * @param mesh defines the mesh to control
  47463. * @param bone defines the bone to control
  47464. * @param options defines options to set up the controller
  47465. */
  47466. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  47467. targetMesh?: AbstractMesh;
  47468. poleTargetMesh?: AbstractMesh;
  47469. poleTargetBone?: Bone;
  47470. poleTargetLocalOffset?: Vector3;
  47471. poleAngle?: number;
  47472. bendAxis?: Vector3;
  47473. maxAngle?: number;
  47474. slerpAmount?: number;
  47475. });
  47476. private _setMaxAngle;
  47477. /**
  47478. * Force the controller to update the bones
  47479. */
  47480. update(): void;
  47481. }
  47482. }
  47483. declare module BABYLON {
  47484. /**
  47485. * Class used to make a bone look toward a point in space
  47486. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  47487. */
  47488. export class BoneLookController {
  47489. private static _tmpVecs;
  47490. private static _tmpQuat;
  47491. private static _tmpMats;
  47492. /**
  47493. * The target Vector3 that the bone will look at
  47494. */
  47495. target: Vector3;
  47496. /**
  47497. * The mesh that the bone is attached to
  47498. */
  47499. mesh: AbstractMesh;
  47500. /**
  47501. * The bone that will be looking to the target
  47502. */
  47503. bone: Bone;
  47504. /**
  47505. * The up axis of the coordinate system that is used when the bone is rotated
  47506. */
  47507. upAxis: Vector3;
  47508. /**
  47509. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  47510. */
  47511. upAxisSpace: Space;
  47512. /**
  47513. * Used to make an adjustment to the yaw of the bone
  47514. */
  47515. adjustYaw: number;
  47516. /**
  47517. * Used to make an adjustment to the pitch of the bone
  47518. */
  47519. adjustPitch: number;
  47520. /**
  47521. * Used to make an adjustment to the roll of the bone
  47522. */
  47523. adjustRoll: number;
  47524. /**
  47525. * 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)
  47526. */
  47527. slerpAmount: number;
  47528. private _minYaw;
  47529. private _maxYaw;
  47530. private _minPitch;
  47531. private _maxPitch;
  47532. private _minYawSin;
  47533. private _minYawCos;
  47534. private _maxYawSin;
  47535. private _maxYawCos;
  47536. private _midYawConstraint;
  47537. private _minPitchTan;
  47538. private _maxPitchTan;
  47539. private _boneQuat;
  47540. private _slerping;
  47541. private _transformYawPitch;
  47542. private _transformYawPitchInv;
  47543. private _firstFrameSkipped;
  47544. private _yawRange;
  47545. private _fowardAxis;
  47546. /**
  47547. * Gets or sets the minimum yaw angle that the bone can look to
  47548. */
  47549. get minYaw(): number;
  47550. set minYaw(value: number);
  47551. /**
  47552. * Gets or sets the maximum yaw angle that the bone can look to
  47553. */
  47554. get maxYaw(): number;
  47555. set maxYaw(value: number);
  47556. /**
  47557. * Gets or sets the minimum pitch angle that the bone can look to
  47558. */
  47559. get minPitch(): number;
  47560. set minPitch(value: number);
  47561. /**
  47562. * Gets or sets the maximum pitch angle that the bone can look to
  47563. */
  47564. get maxPitch(): number;
  47565. set maxPitch(value: number);
  47566. /**
  47567. * Create a BoneLookController
  47568. * @param mesh the mesh that the bone belongs to
  47569. * @param bone the bone that will be looking to the target
  47570. * @param target the target Vector3 to look at
  47571. * @param options optional settings:
  47572. * * maxYaw: the maximum angle the bone will yaw to
  47573. * * minYaw: the minimum angle the bone will yaw to
  47574. * * maxPitch: the maximum angle the bone will pitch to
  47575. * * minPitch: the minimum angle the bone will yaw to
  47576. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  47577. * * upAxis: the up axis of the coordinate system
  47578. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  47579. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  47580. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  47581. * * adjustYaw: used to make an adjustment to the yaw of the bone
  47582. * * adjustPitch: used to make an adjustment to the pitch of the bone
  47583. * * adjustRoll: used to make an adjustment to the roll of the bone
  47584. **/
  47585. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  47586. maxYaw?: number;
  47587. minYaw?: number;
  47588. maxPitch?: number;
  47589. minPitch?: number;
  47590. slerpAmount?: number;
  47591. upAxis?: Vector3;
  47592. upAxisSpace?: Space;
  47593. yawAxis?: Vector3;
  47594. pitchAxis?: Vector3;
  47595. adjustYaw?: number;
  47596. adjustPitch?: number;
  47597. adjustRoll?: number;
  47598. });
  47599. /**
  47600. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  47601. */
  47602. update(): void;
  47603. private _getAngleDiff;
  47604. private _getAngleBetween;
  47605. private _isAngleBetween;
  47606. }
  47607. }
  47608. declare module BABYLON {
  47609. /**
  47610. * Manage the gamepad inputs to control an arc rotate camera.
  47611. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  47612. */
  47613. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  47614. /**
  47615. * Defines the camera the input is attached to.
  47616. */
  47617. camera: ArcRotateCamera;
  47618. /**
  47619. * Defines the gamepad the input is gathering event from.
  47620. */
  47621. gamepad: Nullable<Gamepad>;
  47622. /**
  47623. * Defines the gamepad rotation sensiblity.
  47624. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  47625. */
  47626. gamepadRotationSensibility: number;
  47627. /**
  47628. * Defines the gamepad move sensiblity.
  47629. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  47630. */
  47631. gamepadMoveSensibility: number;
  47632. private _yAxisScale;
  47633. /**
  47634. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  47635. */
  47636. get invertYAxis(): boolean;
  47637. set invertYAxis(value: boolean);
  47638. private _onGamepadConnectedObserver;
  47639. private _onGamepadDisconnectedObserver;
  47640. /**
  47641. * Attach the input controls to a specific dom element to get the input from.
  47642. */
  47643. attachControl(): void;
  47644. /**
  47645. * Detach the current controls from the specified dom element.
  47646. */
  47647. detachControl(): void;
  47648. /**
  47649. * Update the current camera state depending on the inputs that have been used this frame.
  47650. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  47651. */
  47652. checkInputs(): void;
  47653. /**
  47654. * Gets the class name of the current intput.
  47655. * @returns the class name
  47656. */
  47657. getClassName(): string;
  47658. /**
  47659. * Get the friendly name associated with the input class.
  47660. * @returns the input friendly name
  47661. */
  47662. getSimpleName(): string;
  47663. }
  47664. }
  47665. declare module BABYLON {
  47666. interface ArcRotateCameraInputsManager {
  47667. /**
  47668. * Add orientation input support to the input manager.
  47669. * @returns the current input manager
  47670. */
  47671. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  47672. }
  47673. /**
  47674. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  47675. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  47676. */
  47677. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  47678. /**
  47679. * Defines the camera the input is attached to.
  47680. */
  47681. camera: ArcRotateCamera;
  47682. /**
  47683. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  47684. */
  47685. alphaCorrection: number;
  47686. /**
  47687. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  47688. */
  47689. gammaCorrection: number;
  47690. private _alpha;
  47691. private _gamma;
  47692. private _dirty;
  47693. private _deviceOrientationHandler;
  47694. /**
  47695. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  47696. */
  47697. constructor();
  47698. /**
  47699. * Attach the input controls to a specific dom element to get the input from.
  47700. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  47701. */
  47702. attachControl(noPreventDefault?: boolean): void;
  47703. /** @hidden */
  47704. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  47705. /**
  47706. * Update the current camera state depending on the inputs that have been used this frame.
  47707. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  47708. */
  47709. checkInputs(): void;
  47710. /**
  47711. * Detach the current controls from the specified dom element.
  47712. */
  47713. detachControl(): void;
  47714. /**
  47715. * Gets the class name of the current intput.
  47716. * @returns the class name
  47717. */
  47718. getClassName(): string;
  47719. /**
  47720. * Get the friendly name associated with the input class.
  47721. * @returns the input friendly name
  47722. */
  47723. getSimpleName(): string;
  47724. }
  47725. }
  47726. declare module BABYLON {
  47727. /**
  47728. * Listen to mouse events to control the camera.
  47729. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  47730. */
  47731. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  47732. /**
  47733. * Defines the camera the input is attached to.
  47734. */
  47735. camera: FlyCamera;
  47736. /**
  47737. * Defines if touch is enabled. (Default is true.)
  47738. */
  47739. touchEnabled: boolean;
  47740. /**
  47741. * Defines the buttons associated with the input to handle camera rotation.
  47742. */
  47743. buttons: number[];
  47744. /**
  47745. * Assign buttons for Yaw control.
  47746. */
  47747. buttonsYaw: number[];
  47748. /**
  47749. * Assign buttons for Pitch control.
  47750. */
  47751. buttonsPitch: number[];
  47752. /**
  47753. * Assign buttons for Roll control.
  47754. */
  47755. buttonsRoll: number[];
  47756. /**
  47757. * Detect if any button is being pressed while mouse is moved.
  47758. * -1 = Mouse locked.
  47759. * 0 = Left button.
  47760. * 1 = Middle Button.
  47761. * 2 = Right Button.
  47762. */
  47763. activeButton: number;
  47764. /**
  47765. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  47766. * Higher values reduce its sensitivity.
  47767. */
  47768. angularSensibility: number;
  47769. private _observer;
  47770. private _rollObserver;
  47771. private previousPosition;
  47772. private noPreventDefault;
  47773. private element;
  47774. /**
  47775. * Listen to mouse events to control the camera.
  47776. * @param touchEnabled Define if touch is enabled. (Default is true.)
  47777. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  47778. */
  47779. constructor(touchEnabled?: boolean);
  47780. /**
  47781. * Attach the mouse control to the HTML DOM element.
  47782. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  47783. */
  47784. attachControl(noPreventDefault?: boolean): void;
  47785. /**
  47786. * Detach the current controls from the specified dom element.
  47787. */
  47788. detachControl(): void;
  47789. /**
  47790. * Gets the class name of the current input.
  47791. * @returns the class name.
  47792. */
  47793. getClassName(): string;
  47794. /**
  47795. * Get the friendly name associated with the input class.
  47796. * @returns the input's friendly name.
  47797. */
  47798. getSimpleName(): string;
  47799. private _pointerInput;
  47800. private _onMouseMove;
  47801. /**
  47802. * Rotate camera by mouse offset.
  47803. */
  47804. private rotateCamera;
  47805. }
  47806. }
  47807. declare module BABYLON {
  47808. /**
  47809. * Default Inputs manager for the FlyCamera.
  47810. * It groups all the default supported inputs for ease of use.
  47811. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  47812. */
  47813. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  47814. /**
  47815. * Instantiates a new FlyCameraInputsManager.
  47816. * @param camera Defines the camera the inputs belong to.
  47817. */
  47818. constructor(camera: FlyCamera);
  47819. /**
  47820. * Add keyboard input support to the input manager.
  47821. * @returns the new FlyCameraKeyboardMoveInput().
  47822. */
  47823. addKeyboard(): FlyCameraInputsManager;
  47824. /**
  47825. * Add mouse input support to the input manager.
  47826. * @param touchEnabled Enable touch screen support.
  47827. * @returns the new FlyCameraMouseInput().
  47828. */
  47829. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  47830. }
  47831. }
  47832. declare module BABYLON {
  47833. /**
  47834. * This is a flying camera, designed for 3D movement and rotation in all directions,
  47835. * such as in a 3D Space Shooter or a Flight Simulator.
  47836. */
  47837. export class FlyCamera extends TargetCamera {
  47838. /**
  47839. * Define the collision ellipsoid of the camera.
  47840. * This is helpful for simulating a camera body, like a player's body.
  47841. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  47842. */
  47843. ellipsoid: Vector3;
  47844. /**
  47845. * Define an offset for the position of the ellipsoid around the camera.
  47846. * This can be helpful if the camera is attached away from the player's body center,
  47847. * such as at its head.
  47848. */
  47849. ellipsoidOffset: Vector3;
  47850. /**
  47851. * Enable or disable collisions of the camera with the rest of the scene objects.
  47852. */
  47853. checkCollisions: boolean;
  47854. /**
  47855. * Enable or disable gravity on the camera.
  47856. */
  47857. applyGravity: boolean;
  47858. /**
  47859. * Define the current direction the camera is moving to.
  47860. */
  47861. cameraDirection: Vector3;
  47862. /**
  47863. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  47864. * This overrides and empties cameraRotation.
  47865. */
  47866. rotationQuaternion: Quaternion;
  47867. /**
  47868. * Track Roll to maintain the wanted Rolling when looking around.
  47869. */
  47870. _trackRoll: number;
  47871. /**
  47872. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  47873. */
  47874. rollCorrect: number;
  47875. /**
  47876. * Mimic a banked turn, Rolling the camera when Yawing.
  47877. * It's recommended to use rollCorrect = 10 for faster banking correction.
  47878. */
  47879. bankedTurn: boolean;
  47880. /**
  47881. * Limit in radians for how much Roll banking will add. (Default: 90°)
  47882. */
  47883. bankedTurnLimit: number;
  47884. /**
  47885. * Value of 0 disables the banked Roll.
  47886. * Value of 1 is equal to the Yaw angle in radians.
  47887. */
  47888. bankedTurnMultiplier: number;
  47889. /**
  47890. * The inputs manager loads all the input sources, such as keyboard and mouse.
  47891. */
  47892. inputs: FlyCameraInputsManager;
  47893. /**
  47894. * Gets the input sensibility for mouse input.
  47895. * Higher values reduce sensitivity.
  47896. */
  47897. get angularSensibility(): number;
  47898. /**
  47899. * Sets the input sensibility for a mouse input.
  47900. * Higher values reduce sensitivity.
  47901. */
  47902. set angularSensibility(value: number);
  47903. /**
  47904. * Get the keys for camera movement forward.
  47905. */
  47906. get keysForward(): number[];
  47907. /**
  47908. * Set the keys for camera movement forward.
  47909. */
  47910. set keysForward(value: number[]);
  47911. /**
  47912. * Get the keys for camera movement backward.
  47913. */
  47914. get keysBackward(): number[];
  47915. set keysBackward(value: number[]);
  47916. /**
  47917. * Get the keys for camera movement up.
  47918. */
  47919. get keysUp(): number[];
  47920. /**
  47921. * Set the keys for camera movement up.
  47922. */
  47923. set keysUp(value: number[]);
  47924. /**
  47925. * Get the keys for camera movement down.
  47926. */
  47927. get keysDown(): number[];
  47928. /**
  47929. * Set the keys for camera movement down.
  47930. */
  47931. set keysDown(value: number[]);
  47932. /**
  47933. * Get the keys for camera movement left.
  47934. */
  47935. get keysLeft(): number[];
  47936. /**
  47937. * Set the keys for camera movement left.
  47938. */
  47939. set keysLeft(value: number[]);
  47940. /**
  47941. * Set the keys for camera movement right.
  47942. */
  47943. get keysRight(): number[];
  47944. /**
  47945. * Set the keys for camera movement right.
  47946. */
  47947. set keysRight(value: number[]);
  47948. /**
  47949. * Event raised when the camera collides with a mesh in the scene.
  47950. */
  47951. onCollide: (collidedMesh: AbstractMesh) => void;
  47952. private _collider;
  47953. private _needMoveForGravity;
  47954. private _oldPosition;
  47955. private _diffPosition;
  47956. private _newPosition;
  47957. /** @hidden */
  47958. _localDirection: Vector3;
  47959. /** @hidden */
  47960. _transformedDirection: Vector3;
  47961. /**
  47962. * Instantiates a FlyCamera.
  47963. * This is a flying camera, designed for 3D movement and rotation in all directions,
  47964. * such as in a 3D Space Shooter or a Flight Simulator.
  47965. * @param name Define the name of the camera in the scene.
  47966. * @param position Define the starting position of the camera in the scene.
  47967. * @param scene Define the scene the camera belongs to.
  47968. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  47969. */
  47970. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  47971. /**
  47972. * Attach the input controls to a specific dom element to get the input from.
  47973. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  47974. */
  47975. attachControl(noPreventDefault?: boolean): void;
  47976. /**
  47977. * Detach a control from the HTML DOM element.
  47978. * The camera will stop reacting to that input.
  47979. */
  47980. detachControl(): void;
  47981. private _collisionMask;
  47982. /**
  47983. * Get the mask that the camera ignores in collision events.
  47984. */
  47985. get collisionMask(): number;
  47986. /**
  47987. * Set the mask that the camera ignores in collision events.
  47988. */
  47989. set collisionMask(mask: number);
  47990. /** @hidden */
  47991. _collideWithWorld(displacement: Vector3): void;
  47992. /** @hidden */
  47993. private _onCollisionPositionChange;
  47994. /** @hidden */
  47995. _checkInputs(): void;
  47996. /** @hidden */
  47997. _decideIfNeedsToMove(): boolean;
  47998. /** @hidden */
  47999. _updatePosition(): void;
  48000. /**
  48001. * Restore the Roll to its target value at the rate specified.
  48002. * @param rate - Higher means slower restoring.
  48003. * @hidden
  48004. */
  48005. restoreRoll(rate: number): void;
  48006. /**
  48007. * Destroy the camera and release the current resources held by it.
  48008. */
  48009. dispose(): void;
  48010. /**
  48011. * Get the current object class name.
  48012. * @returns the class name.
  48013. */
  48014. getClassName(): string;
  48015. }
  48016. }
  48017. declare module BABYLON {
  48018. /**
  48019. * Listen to keyboard events to control the camera.
  48020. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  48021. */
  48022. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  48023. /**
  48024. * Defines the camera the input is attached to.
  48025. */
  48026. camera: FlyCamera;
  48027. /**
  48028. * The list of keyboard keys used to control the forward move of the camera.
  48029. */
  48030. keysForward: number[];
  48031. /**
  48032. * The list of keyboard keys used to control the backward move of the camera.
  48033. */
  48034. keysBackward: number[];
  48035. /**
  48036. * The list of keyboard keys used to control the forward move of the camera.
  48037. */
  48038. keysUp: number[];
  48039. /**
  48040. * The list of keyboard keys used to control the backward move of the camera.
  48041. */
  48042. keysDown: number[];
  48043. /**
  48044. * The list of keyboard keys used to control the right strafe move of the camera.
  48045. */
  48046. keysRight: number[];
  48047. /**
  48048. * The list of keyboard keys used to control the left strafe move of the camera.
  48049. */
  48050. keysLeft: number[];
  48051. private _keys;
  48052. private _onCanvasBlurObserver;
  48053. private _onKeyboardObserver;
  48054. private _engine;
  48055. private _scene;
  48056. /**
  48057. * Attach the input controls to a specific dom element to get the input from.
  48058. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  48059. */
  48060. attachControl(noPreventDefault?: boolean): void;
  48061. /**
  48062. * Detach the current controls from the specified dom element.
  48063. */
  48064. detachControl(): void;
  48065. /**
  48066. * Gets the class name of the current intput.
  48067. * @returns the class name
  48068. */
  48069. getClassName(): string;
  48070. /** @hidden */
  48071. _onLostFocus(e: FocusEvent): void;
  48072. /**
  48073. * Get the friendly name associated with the input class.
  48074. * @returns the input friendly name
  48075. */
  48076. getSimpleName(): string;
  48077. /**
  48078. * Update the current camera state depending on the inputs that have been used this frame.
  48079. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  48080. */
  48081. checkInputs(): void;
  48082. }
  48083. }
  48084. declare module BABYLON {
  48085. /**
  48086. * Manage the mouse wheel inputs to control a follow camera.
  48087. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  48088. */
  48089. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  48090. /**
  48091. * Defines the camera the input is attached to.
  48092. */
  48093. camera: FollowCamera;
  48094. /**
  48095. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  48096. */
  48097. axisControlRadius: boolean;
  48098. /**
  48099. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  48100. */
  48101. axisControlHeight: boolean;
  48102. /**
  48103. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  48104. */
  48105. axisControlRotation: boolean;
  48106. /**
  48107. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  48108. * relation to mouseWheel events.
  48109. */
  48110. wheelPrecision: number;
  48111. /**
  48112. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  48113. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  48114. */
  48115. wheelDeltaPercentage: number;
  48116. private _wheel;
  48117. private _observer;
  48118. /**
  48119. * Attach the input controls to a specific dom element to get the input from.
  48120. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  48121. */
  48122. attachControl(noPreventDefault?: boolean): void;
  48123. /**
  48124. * Detach the current controls from the specified dom element.
  48125. */
  48126. detachControl(): void;
  48127. /**
  48128. * Gets the class name of the current intput.
  48129. * @returns the class name
  48130. */
  48131. getClassName(): string;
  48132. /**
  48133. * Get the friendly name associated with the input class.
  48134. * @returns the input friendly name
  48135. */
  48136. getSimpleName(): string;
  48137. }
  48138. }
  48139. declare module BABYLON {
  48140. /**
  48141. * Manage the pointers inputs to control an follow camera.
  48142. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  48143. */
  48144. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  48145. /**
  48146. * Defines the camera the input is attached to.
  48147. */
  48148. camera: FollowCamera;
  48149. /**
  48150. * Gets the class name of the current input.
  48151. * @returns the class name
  48152. */
  48153. getClassName(): string;
  48154. /**
  48155. * Defines the pointer angular sensibility along the X axis or how fast is
  48156. * the camera rotating.
  48157. * A negative number will reverse the axis direction.
  48158. */
  48159. angularSensibilityX: number;
  48160. /**
  48161. * Defines the pointer angular sensibility along the Y axis or how fast is
  48162. * the camera rotating.
  48163. * A negative number will reverse the axis direction.
  48164. */
  48165. angularSensibilityY: number;
  48166. /**
  48167. * Defines the pointer pinch precision or how fast is the camera zooming.
  48168. * A negative number will reverse the axis direction.
  48169. */
  48170. pinchPrecision: number;
  48171. /**
  48172. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  48173. * from 0.
  48174. * It defines the percentage of current camera.radius to use as delta when
  48175. * pinch zoom is used.
  48176. */
  48177. pinchDeltaPercentage: number;
  48178. /**
  48179. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  48180. */
  48181. axisXControlRadius: boolean;
  48182. /**
  48183. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  48184. */
  48185. axisXControlHeight: boolean;
  48186. /**
  48187. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  48188. */
  48189. axisXControlRotation: boolean;
  48190. /**
  48191. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  48192. */
  48193. axisYControlRadius: boolean;
  48194. /**
  48195. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  48196. */
  48197. axisYControlHeight: boolean;
  48198. /**
  48199. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  48200. */
  48201. axisYControlRotation: boolean;
  48202. /**
  48203. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  48204. */
  48205. axisPinchControlRadius: boolean;
  48206. /**
  48207. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  48208. */
  48209. axisPinchControlHeight: boolean;
  48210. /**
  48211. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  48212. */
  48213. axisPinchControlRotation: boolean;
  48214. /**
  48215. * Log error messages if basic misconfiguration has occurred.
  48216. */
  48217. warningEnable: boolean;
  48218. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  48219. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  48220. private _warningCounter;
  48221. private _warning;
  48222. }
  48223. }
  48224. declare module BABYLON {
  48225. /**
  48226. * Default Inputs manager for the FollowCamera.
  48227. * It groups all the default supported inputs for ease of use.
  48228. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  48229. */
  48230. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  48231. /**
  48232. * Instantiates a new FollowCameraInputsManager.
  48233. * @param camera Defines the camera the inputs belong to
  48234. */
  48235. constructor(camera: FollowCamera);
  48236. /**
  48237. * Add keyboard input support to the input manager.
  48238. * @returns the current input manager
  48239. */
  48240. addKeyboard(): FollowCameraInputsManager;
  48241. /**
  48242. * Add mouse wheel input support to the input manager.
  48243. * @returns the current input manager
  48244. */
  48245. addMouseWheel(): FollowCameraInputsManager;
  48246. /**
  48247. * Add pointers input support to the input manager.
  48248. * @returns the current input manager
  48249. */
  48250. addPointers(): FollowCameraInputsManager;
  48251. /**
  48252. * Add orientation input support to the input manager.
  48253. * @returns the current input manager
  48254. */
  48255. addVRDeviceOrientation(): FollowCameraInputsManager;
  48256. }
  48257. }
  48258. declare module BABYLON {
  48259. /**
  48260. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  48261. * an arc rotate version arcFollowCamera are available.
  48262. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  48263. */
  48264. export class FollowCamera extends TargetCamera {
  48265. /**
  48266. * Distance the follow camera should follow an object at
  48267. */
  48268. radius: number;
  48269. /**
  48270. * Minimum allowed distance of the camera to the axis of rotation
  48271. * (The camera can not get closer).
  48272. * This can help limiting how the Camera is able to move in the scene.
  48273. */
  48274. lowerRadiusLimit: Nullable<number>;
  48275. /**
  48276. * Maximum allowed distance of the camera to the axis of rotation
  48277. * (The camera can not get further).
  48278. * This can help limiting how the Camera is able to move in the scene.
  48279. */
  48280. upperRadiusLimit: Nullable<number>;
  48281. /**
  48282. * Define a rotation offset between the camera and the object it follows
  48283. */
  48284. rotationOffset: number;
  48285. /**
  48286. * Minimum allowed angle to camera position relative to target object.
  48287. * This can help limiting how the Camera is able to move in the scene.
  48288. */
  48289. lowerRotationOffsetLimit: Nullable<number>;
  48290. /**
  48291. * Maximum allowed angle to camera position relative to target object.
  48292. * This can help limiting how the Camera is able to move in the scene.
  48293. */
  48294. upperRotationOffsetLimit: Nullable<number>;
  48295. /**
  48296. * Define a height offset between the camera and the object it follows.
  48297. * It can help following an object from the top (like a car chaing a plane)
  48298. */
  48299. heightOffset: number;
  48300. /**
  48301. * Minimum allowed height of camera position relative to target object.
  48302. * This can help limiting how the Camera is able to move in the scene.
  48303. */
  48304. lowerHeightOffsetLimit: Nullable<number>;
  48305. /**
  48306. * Maximum allowed height of camera position relative to target object.
  48307. * This can help limiting how the Camera is able to move in the scene.
  48308. */
  48309. upperHeightOffsetLimit: Nullable<number>;
  48310. /**
  48311. * Define how fast the camera can accelerate to follow it s target.
  48312. */
  48313. cameraAcceleration: number;
  48314. /**
  48315. * Define the speed limit of the camera following an object.
  48316. */
  48317. maxCameraSpeed: number;
  48318. /**
  48319. * Define the target of the camera.
  48320. */
  48321. lockedTarget: Nullable<AbstractMesh>;
  48322. /**
  48323. * Defines the input associated with the camera.
  48324. */
  48325. inputs: FollowCameraInputsManager;
  48326. /**
  48327. * Instantiates the follow camera.
  48328. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  48329. * @param name Define the name of the camera in the scene
  48330. * @param position Define the position of the camera
  48331. * @param scene Define the scene the camera belong to
  48332. * @param lockedTarget Define the target of the camera
  48333. */
  48334. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  48335. private _follow;
  48336. /**
  48337. * Attach the input controls to a specific dom element to get the input from.
  48338. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  48339. */
  48340. attachControl(noPreventDefault?: boolean): void;
  48341. /**
  48342. * Detach the current controls from the specified dom element.
  48343. */
  48344. detachControl(): void;
  48345. /** @hidden */
  48346. _checkInputs(): void;
  48347. private _checkLimits;
  48348. /**
  48349. * Gets the camera class name.
  48350. * @returns the class name
  48351. */
  48352. getClassName(): string;
  48353. }
  48354. /**
  48355. * Arc Rotate version of the follow camera.
  48356. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  48357. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  48358. */
  48359. export class ArcFollowCamera extends TargetCamera {
  48360. /** The longitudinal angle of the camera */
  48361. alpha: number;
  48362. /** The latitudinal angle of the camera */
  48363. beta: number;
  48364. /** The radius of the camera from its target */
  48365. radius: number;
  48366. private _cartesianCoordinates;
  48367. /** Define the camera target (the mesh it should follow) */
  48368. private _meshTarget;
  48369. /**
  48370. * Instantiates a new ArcFollowCamera
  48371. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  48372. * @param name Define the name of the camera
  48373. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  48374. * @param beta Define the rotation angle of the camera around the elevation axis
  48375. * @param radius Define the radius of the camera from its target point
  48376. * @param target Define the target of the camera
  48377. * @param scene Define the scene the camera belongs to
  48378. */
  48379. constructor(name: string,
  48380. /** The longitudinal angle of the camera */
  48381. alpha: number,
  48382. /** The latitudinal angle of the camera */
  48383. beta: number,
  48384. /** The radius of the camera from its target */
  48385. radius: number,
  48386. /** Define the camera target (the mesh it should follow) */
  48387. target: Nullable<AbstractMesh>, scene: Scene);
  48388. private _follow;
  48389. /** @hidden */
  48390. _checkInputs(): void;
  48391. /**
  48392. * Returns the class name of the object.
  48393. * It is mostly used internally for serialization purposes.
  48394. */
  48395. getClassName(): string;
  48396. }
  48397. }
  48398. declare module BABYLON {
  48399. /**
  48400. * Manage the keyboard inputs to control the movement of a follow camera.
  48401. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  48402. */
  48403. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  48404. /**
  48405. * Defines the camera the input is attached to.
  48406. */
  48407. camera: FollowCamera;
  48408. /**
  48409. * Defines the list of key codes associated with the up action (increase heightOffset)
  48410. */
  48411. keysHeightOffsetIncr: number[];
  48412. /**
  48413. * Defines the list of key codes associated with the down action (decrease heightOffset)
  48414. */
  48415. keysHeightOffsetDecr: number[];
  48416. /**
  48417. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  48418. */
  48419. keysHeightOffsetModifierAlt: boolean;
  48420. /**
  48421. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  48422. */
  48423. keysHeightOffsetModifierCtrl: boolean;
  48424. /**
  48425. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  48426. */
  48427. keysHeightOffsetModifierShift: boolean;
  48428. /**
  48429. * Defines the list of key codes associated with the left action (increase rotationOffset)
  48430. */
  48431. keysRotationOffsetIncr: number[];
  48432. /**
  48433. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  48434. */
  48435. keysRotationOffsetDecr: number[];
  48436. /**
  48437. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  48438. */
  48439. keysRotationOffsetModifierAlt: boolean;
  48440. /**
  48441. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  48442. */
  48443. keysRotationOffsetModifierCtrl: boolean;
  48444. /**
  48445. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  48446. */
  48447. keysRotationOffsetModifierShift: boolean;
  48448. /**
  48449. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  48450. */
  48451. keysRadiusIncr: number[];
  48452. /**
  48453. * Defines the list of key codes associated with the zoom-out action (increase radius)
  48454. */
  48455. keysRadiusDecr: number[];
  48456. /**
  48457. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  48458. */
  48459. keysRadiusModifierAlt: boolean;
  48460. /**
  48461. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  48462. */
  48463. keysRadiusModifierCtrl: boolean;
  48464. /**
  48465. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  48466. */
  48467. keysRadiusModifierShift: boolean;
  48468. /**
  48469. * Defines the rate of change of heightOffset.
  48470. */
  48471. heightSensibility: number;
  48472. /**
  48473. * Defines the rate of change of rotationOffset.
  48474. */
  48475. rotationSensibility: number;
  48476. /**
  48477. * Defines the rate of change of radius.
  48478. */
  48479. radiusSensibility: number;
  48480. private _keys;
  48481. private _ctrlPressed;
  48482. private _altPressed;
  48483. private _shiftPressed;
  48484. private _onCanvasBlurObserver;
  48485. private _onKeyboardObserver;
  48486. private _engine;
  48487. private _scene;
  48488. /**
  48489. * Attach the input controls to a specific dom element to get the input from.
  48490. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  48491. */
  48492. attachControl(noPreventDefault?: boolean): void;
  48493. /**
  48494. * Detach the current controls from the specified dom element.
  48495. */
  48496. detachControl(): void;
  48497. /**
  48498. * Update the current camera state depending on the inputs that have been used this frame.
  48499. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  48500. */
  48501. checkInputs(): void;
  48502. /**
  48503. * Gets the class name of the current input.
  48504. * @returns the class name
  48505. */
  48506. getClassName(): string;
  48507. /**
  48508. * Get the friendly name associated with the input class.
  48509. * @returns the input friendly name
  48510. */
  48511. getSimpleName(): string;
  48512. /**
  48513. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  48514. * allow modification of the heightOffset value.
  48515. */
  48516. private _modifierHeightOffset;
  48517. /**
  48518. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  48519. * allow modification of the rotationOffset value.
  48520. */
  48521. private _modifierRotationOffset;
  48522. /**
  48523. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  48524. * allow modification of the radius value.
  48525. */
  48526. private _modifierRadius;
  48527. }
  48528. }
  48529. declare module BABYLON {
  48530. interface FreeCameraInputsManager {
  48531. /**
  48532. * @hidden
  48533. */
  48534. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  48535. /**
  48536. * Add orientation input support to the input manager.
  48537. * @returns the current input manager
  48538. */
  48539. addDeviceOrientation(): FreeCameraInputsManager;
  48540. }
  48541. /**
  48542. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  48543. * Screen rotation is taken into account.
  48544. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  48545. */
  48546. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  48547. private _camera;
  48548. private _screenOrientationAngle;
  48549. private _constantTranform;
  48550. private _screenQuaternion;
  48551. private _alpha;
  48552. private _beta;
  48553. private _gamma;
  48554. /**
  48555. * Can be used to detect if a device orientation sensor is available on a device
  48556. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  48557. * @returns a promise that will resolve on orientation change
  48558. */
  48559. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  48560. /**
  48561. * @hidden
  48562. */
  48563. _onDeviceOrientationChangedObservable: Observable<void>;
  48564. /**
  48565. * Instantiates a new input
  48566. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  48567. */
  48568. constructor();
  48569. /**
  48570. * Define the camera controlled by the input.
  48571. */
  48572. get camera(): FreeCamera;
  48573. set camera(camera: FreeCamera);
  48574. /**
  48575. * Attach the input controls to a specific dom element to get the input from.
  48576. */
  48577. attachControl(): void;
  48578. private _orientationChanged;
  48579. private _deviceOrientation;
  48580. /**
  48581. * Detach the current controls from the specified dom element.
  48582. */
  48583. detachControl(): void;
  48584. /**
  48585. * Update the current camera state depending on the inputs that have been used this frame.
  48586. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  48587. */
  48588. checkInputs(): void;
  48589. /**
  48590. * Gets the class name of the current intput.
  48591. * @returns the class name
  48592. */
  48593. getClassName(): string;
  48594. /**
  48595. * Get the friendly name associated with the input class.
  48596. * @returns the input friendly name
  48597. */
  48598. getSimpleName(): string;
  48599. }
  48600. }
  48601. declare module BABYLON {
  48602. /**
  48603. * Manage the gamepad inputs to control a free camera.
  48604. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  48605. */
  48606. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  48607. /**
  48608. * Define the camera the input is attached to.
  48609. */
  48610. camera: FreeCamera;
  48611. /**
  48612. * Define the Gamepad controlling the input
  48613. */
  48614. gamepad: Nullable<Gamepad>;
  48615. /**
  48616. * Defines the gamepad rotation sensiblity.
  48617. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  48618. */
  48619. gamepadAngularSensibility: number;
  48620. /**
  48621. * Defines the gamepad move sensiblity.
  48622. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  48623. */
  48624. gamepadMoveSensibility: number;
  48625. private _yAxisScale;
  48626. /**
  48627. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  48628. */
  48629. get invertYAxis(): boolean;
  48630. set invertYAxis(value: boolean);
  48631. private _onGamepadConnectedObserver;
  48632. private _onGamepadDisconnectedObserver;
  48633. private _cameraTransform;
  48634. private _deltaTransform;
  48635. private _vector3;
  48636. private _vector2;
  48637. /**
  48638. * Attach the input controls to a specific dom element to get the input from.
  48639. */
  48640. attachControl(): void;
  48641. /**
  48642. * Detach the current controls from the specified dom element.
  48643. */
  48644. detachControl(): void;
  48645. /**
  48646. * Update the current camera state depending on the inputs that have been used this frame.
  48647. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  48648. */
  48649. checkInputs(): void;
  48650. /**
  48651. * Gets the class name of the current intput.
  48652. * @returns the class name
  48653. */
  48654. getClassName(): string;
  48655. /**
  48656. * Get the friendly name associated with the input class.
  48657. * @returns the input friendly name
  48658. */
  48659. getSimpleName(): string;
  48660. }
  48661. }
  48662. declare module BABYLON {
  48663. /**
  48664. * Defines the potential axis of a Joystick
  48665. */
  48666. export enum JoystickAxis {
  48667. /** X axis */
  48668. X = 0,
  48669. /** Y axis */
  48670. Y = 1,
  48671. /** Z axis */
  48672. Z = 2
  48673. }
  48674. /**
  48675. * Represents the different customization options available
  48676. * for VirtualJoystick
  48677. */
  48678. interface VirtualJoystickCustomizations {
  48679. /**
  48680. * Size of the joystick's puck
  48681. */
  48682. puckSize: number;
  48683. /**
  48684. * Size of the joystick's container
  48685. */
  48686. containerSize: number;
  48687. /**
  48688. * Color of the joystick && puck
  48689. */
  48690. color: string;
  48691. /**
  48692. * Image URL for the joystick's puck
  48693. */
  48694. puckImage?: string;
  48695. /**
  48696. * Image URL for the joystick's container
  48697. */
  48698. containerImage?: string;
  48699. /**
  48700. * Defines the unmoving position of the joystick container
  48701. */
  48702. position?: {
  48703. x: number;
  48704. y: number;
  48705. };
  48706. /**
  48707. * Defines whether or not the joystick container is always visible
  48708. */
  48709. alwaysVisible: boolean;
  48710. /**
  48711. * Defines whether or not to limit the movement of the puck to the joystick's container
  48712. */
  48713. limitToContainer: boolean;
  48714. }
  48715. /**
  48716. * Class used to define virtual joystick (used in touch mode)
  48717. */
  48718. export class VirtualJoystick {
  48719. /**
  48720. * Gets or sets a boolean indicating that left and right values must be inverted
  48721. */
  48722. reverseLeftRight: boolean;
  48723. /**
  48724. * Gets or sets a boolean indicating that up and down values must be inverted
  48725. */
  48726. reverseUpDown: boolean;
  48727. /**
  48728. * Gets the offset value for the position (ie. the change of the position value)
  48729. */
  48730. deltaPosition: Vector3;
  48731. /**
  48732. * Gets a boolean indicating if the virtual joystick was pressed
  48733. */
  48734. pressed: boolean;
  48735. /**
  48736. * Canvas the virtual joystick will render onto, default z-index of this is 5
  48737. */
  48738. static Canvas: Nullable<HTMLCanvasElement>;
  48739. /**
  48740. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  48741. */
  48742. limitToContainer: boolean;
  48743. private static _globalJoystickIndex;
  48744. private static _alwaysVisibleSticks;
  48745. private static vjCanvasContext;
  48746. private static vjCanvasWidth;
  48747. private static vjCanvasHeight;
  48748. private static halfWidth;
  48749. private static _GetDefaultOptions;
  48750. private _action;
  48751. private _axisTargetedByLeftAndRight;
  48752. private _axisTargetedByUpAndDown;
  48753. private _joystickSensibility;
  48754. private _inversedSensibility;
  48755. private _joystickPointerID;
  48756. private _joystickColor;
  48757. private _joystickPointerPos;
  48758. private _joystickPreviousPointerPos;
  48759. private _joystickPointerStartPos;
  48760. private _deltaJoystickVector;
  48761. private _leftJoystick;
  48762. private _touches;
  48763. private _joystickPosition;
  48764. private _alwaysVisible;
  48765. private _puckImage;
  48766. private _containerImage;
  48767. private _joystickPuckSize;
  48768. private _joystickContainerSize;
  48769. private _clearPuckSize;
  48770. private _clearContainerSize;
  48771. private _clearPuckSizeOffset;
  48772. private _clearContainerSizeOffset;
  48773. private _onPointerDownHandlerRef;
  48774. private _onPointerMoveHandlerRef;
  48775. private _onPointerUpHandlerRef;
  48776. private _onResize;
  48777. /**
  48778. * Creates a new virtual joystick
  48779. * @param leftJoystick defines that the joystick is for left hand (false by default)
  48780. * @param customizations Defines the options we want to customize the VirtualJoystick
  48781. */
  48782. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  48783. /**
  48784. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  48785. * @param newJoystickSensibility defines the new sensibility
  48786. */
  48787. setJoystickSensibility(newJoystickSensibility: number): void;
  48788. private _onPointerDown;
  48789. private _onPointerMove;
  48790. private _onPointerUp;
  48791. /**
  48792. * Change the color of the virtual joystick
  48793. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  48794. */
  48795. setJoystickColor(newColor: string): void;
  48796. /**
  48797. * Size of the joystick's container
  48798. */
  48799. set containerSize(newSize: number);
  48800. get containerSize(): number;
  48801. /**
  48802. * Size of the joystick's puck
  48803. */
  48804. set puckSize(newSize: number);
  48805. get puckSize(): number;
  48806. /**
  48807. * Clears the set position of the joystick
  48808. */
  48809. clearPosition(): void;
  48810. /**
  48811. * Defines whether or not the joystick container is always visible
  48812. */
  48813. set alwaysVisible(value: boolean);
  48814. get alwaysVisible(): boolean;
  48815. /**
  48816. * Sets the constant position of the Joystick container
  48817. * @param x X axis coordinate
  48818. * @param y Y axis coordinate
  48819. */
  48820. setPosition(x: number, y: number): void;
  48821. /**
  48822. * Defines a callback to call when the joystick is touched
  48823. * @param action defines the callback
  48824. */
  48825. setActionOnTouch(action: () => any): void;
  48826. /**
  48827. * Defines which axis you'd like to control for left & right
  48828. * @param axis defines the axis to use
  48829. */
  48830. setAxisForLeftRight(axis: JoystickAxis): void;
  48831. /**
  48832. * Defines which axis you'd like to control for up & down
  48833. * @param axis defines the axis to use
  48834. */
  48835. setAxisForUpDown(axis: JoystickAxis): void;
  48836. /**
  48837. * Clears the canvas from the previous puck / container draw
  48838. */
  48839. private _clearPreviousDraw;
  48840. /**
  48841. * Loads `urlPath` to be used for the container's image
  48842. * @param urlPath defines the urlPath of an image to use
  48843. */
  48844. setContainerImage(urlPath: string): void;
  48845. /**
  48846. * Loads `urlPath` to be used for the puck's image
  48847. * @param urlPath defines the urlPath of an image to use
  48848. */
  48849. setPuckImage(urlPath: string): void;
  48850. /**
  48851. * Draws the Virtual Joystick's container
  48852. */
  48853. private _drawContainer;
  48854. /**
  48855. * Draws the Virtual Joystick's puck
  48856. */
  48857. private _drawPuck;
  48858. private _drawVirtualJoystick;
  48859. /**
  48860. * Release internal HTML canvas
  48861. */
  48862. releaseCanvas(): void;
  48863. }
  48864. }
  48865. declare module BABYLON {
  48866. interface FreeCameraInputsManager {
  48867. /**
  48868. * Add virtual joystick input support to the input manager.
  48869. * @returns the current input manager
  48870. */
  48871. addVirtualJoystick(): FreeCameraInputsManager;
  48872. }
  48873. /**
  48874. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  48875. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  48876. */
  48877. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  48878. /**
  48879. * Defines the camera the input is attached to.
  48880. */
  48881. camera: FreeCamera;
  48882. private _leftjoystick;
  48883. private _rightjoystick;
  48884. /**
  48885. * Gets the left stick of the virtual joystick.
  48886. * @returns The virtual Joystick
  48887. */
  48888. getLeftJoystick(): VirtualJoystick;
  48889. /**
  48890. * Gets the right stick of the virtual joystick.
  48891. * @returns The virtual Joystick
  48892. */
  48893. getRightJoystick(): VirtualJoystick;
  48894. /**
  48895. * Update the current camera state depending on the inputs that have been used this frame.
  48896. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  48897. */
  48898. checkInputs(): void;
  48899. /**
  48900. * Attach the input controls to a specific dom element to get the input from.
  48901. */
  48902. attachControl(): void;
  48903. /**
  48904. * Detach the current controls from the specified dom element.
  48905. */
  48906. detachControl(): void;
  48907. /**
  48908. * Gets the class name of the current intput.
  48909. * @returns the class name
  48910. */
  48911. getClassName(): string;
  48912. /**
  48913. * Get the friendly name associated with the input class.
  48914. * @returns the input friendly name
  48915. */
  48916. getSimpleName(): string;
  48917. }
  48918. }
  48919. declare module BABYLON {
  48920. /**
  48921. * This represents a FPS type of camera controlled by touch.
  48922. * This is like a universal camera minus the Gamepad controls.
  48923. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  48924. */
  48925. export class TouchCamera extends FreeCamera {
  48926. /**
  48927. * Defines the touch sensibility for rotation.
  48928. * The higher the faster.
  48929. */
  48930. get touchAngularSensibility(): number;
  48931. set touchAngularSensibility(value: number);
  48932. /**
  48933. * Defines the touch sensibility for move.
  48934. * The higher the faster.
  48935. */
  48936. get touchMoveSensibility(): number;
  48937. set touchMoveSensibility(value: number);
  48938. /**
  48939. * Instantiates a new touch camera.
  48940. * This represents a FPS type of camera controlled by touch.
  48941. * This is like a universal camera minus the Gamepad controls.
  48942. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  48943. * @param name Define the name of the camera in the scene
  48944. * @param position Define the start position of the camera in the scene
  48945. * @param scene Define the scene the camera belongs to
  48946. */
  48947. constructor(name: string, position: Vector3, scene: Scene);
  48948. /**
  48949. * Gets the current object class name.
  48950. * @return the class name
  48951. */
  48952. getClassName(): string;
  48953. /** @hidden */
  48954. _setupInputs(): void;
  48955. }
  48956. }
  48957. declare module BABYLON {
  48958. /**
  48959. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  48960. * being tilted forward or back and left or right.
  48961. */
  48962. export class DeviceOrientationCamera extends FreeCamera {
  48963. private _initialQuaternion;
  48964. private _quaternionCache;
  48965. private _tmpDragQuaternion;
  48966. private _disablePointerInputWhenUsingDeviceOrientation;
  48967. /**
  48968. * Creates a new device orientation camera
  48969. * @param name The name of the camera
  48970. * @param position The start position camera
  48971. * @param scene The scene the camera belongs to
  48972. */
  48973. constructor(name: string, position: Vector3, scene: Scene);
  48974. /**
  48975. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  48976. */
  48977. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  48978. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  48979. private _dragFactor;
  48980. /**
  48981. * Enabled turning on the y axis when the orientation sensor is active
  48982. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  48983. */
  48984. enableHorizontalDragging(dragFactor?: number): void;
  48985. /**
  48986. * Gets the current instance class name ("DeviceOrientationCamera").
  48987. * This helps avoiding instanceof at run time.
  48988. * @returns the class name
  48989. */
  48990. getClassName(): string;
  48991. /**
  48992. * @hidden
  48993. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  48994. */
  48995. _checkInputs(): void;
  48996. /**
  48997. * Reset the camera to its default orientation on the specified axis only.
  48998. * @param axis The axis to reset
  48999. */
  49000. resetToCurrentRotation(axis?: Axis): void;
  49001. }
  49002. }
  49003. declare module BABYLON {
  49004. /**
  49005. * Defines supported buttons for XBox360 compatible gamepads
  49006. */
  49007. export enum Xbox360Button {
  49008. /** A */
  49009. A = 0,
  49010. /** B */
  49011. B = 1,
  49012. /** X */
  49013. X = 2,
  49014. /** Y */
  49015. Y = 3,
  49016. /** Left button */
  49017. LB = 4,
  49018. /** Right button */
  49019. RB = 5,
  49020. /** Back */
  49021. Back = 8,
  49022. /** Start */
  49023. Start = 9,
  49024. /** Left stick */
  49025. LeftStick = 10,
  49026. /** Right stick */
  49027. RightStick = 11
  49028. }
  49029. /** Defines values for XBox360 DPad */
  49030. export enum Xbox360Dpad {
  49031. /** Up */
  49032. Up = 12,
  49033. /** Down */
  49034. Down = 13,
  49035. /** Left */
  49036. Left = 14,
  49037. /** Right */
  49038. Right = 15
  49039. }
  49040. /**
  49041. * Defines a XBox360 gamepad
  49042. */
  49043. export class Xbox360Pad extends Gamepad {
  49044. private _leftTrigger;
  49045. private _rightTrigger;
  49046. private _onlefttriggerchanged;
  49047. private _onrighttriggerchanged;
  49048. private _onbuttondown;
  49049. private _onbuttonup;
  49050. private _ondpaddown;
  49051. private _ondpadup;
  49052. /** Observable raised when a button is pressed */
  49053. onButtonDownObservable: Observable<Xbox360Button>;
  49054. /** Observable raised when a button is released */
  49055. onButtonUpObservable: Observable<Xbox360Button>;
  49056. /** Observable raised when a pad is pressed */
  49057. onPadDownObservable: Observable<Xbox360Dpad>;
  49058. /** Observable raised when a pad is released */
  49059. onPadUpObservable: Observable<Xbox360Dpad>;
  49060. private _buttonA;
  49061. private _buttonB;
  49062. private _buttonX;
  49063. private _buttonY;
  49064. private _buttonBack;
  49065. private _buttonStart;
  49066. private _buttonLB;
  49067. private _buttonRB;
  49068. private _buttonLeftStick;
  49069. private _buttonRightStick;
  49070. private _dPadUp;
  49071. private _dPadDown;
  49072. private _dPadLeft;
  49073. private _dPadRight;
  49074. private _isXboxOnePad;
  49075. /**
  49076. * Creates a new XBox360 gamepad object
  49077. * @param id defines the id of this gamepad
  49078. * @param index defines its index
  49079. * @param gamepad defines the internal HTML gamepad object
  49080. * @param xboxOne defines if it is a XBox One gamepad
  49081. */
  49082. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  49083. /**
  49084. * Defines the callback to call when left trigger is pressed
  49085. * @param callback defines the callback to use
  49086. */
  49087. onlefttriggerchanged(callback: (value: number) => void): void;
  49088. /**
  49089. * Defines the callback to call when right trigger is pressed
  49090. * @param callback defines the callback to use
  49091. */
  49092. onrighttriggerchanged(callback: (value: number) => void): void;
  49093. /**
  49094. * Gets the left trigger value
  49095. */
  49096. get leftTrigger(): number;
  49097. /**
  49098. * Sets the left trigger value
  49099. */
  49100. set leftTrigger(newValue: number);
  49101. /**
  49102. * Gets the right trigger value
  49103. */
  49104. get rightTrigger(): number;
  49105. /**
  49106. * Sets the right trigger value
  49107. */
  49108. set rightTrigger(newValue: number);
  49109. /**
  49110. * Defines the callback to call when a button is pressed
  49111. * @param callback defines the callback to use
  49112. */
  49113. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  49114. /**
  49115. * Defines the callback to call when a button is released
  49116. * @param callback defines the callback to use
  49117. */
  49118. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  49119. /**
  49120. * Defines the callback to call when a pad is pressed
  49121. * @param callback defines the callback to use
  49122. */
  49123. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  49124. /**
  49125. * Defines the callback to call when a pad is released
  49126. * @param callback defines the callback to use
  49127. */
  49128. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  49129. private _setButtonValue;
  49130. private _setDPadValue;
  49131. /**
  49132. * Gets the value of the `A` button
  49133. */
  49134. get buttonA(): number;
  49135. /**
  49136. * Sets the value of the `A` button
  49137. */
  49138. set buttonA(value: number);
  49139. /**
  49140. * Gets the value of the `B` button
  49141. */
  49142. get buttonB(): number;
  49143. /**
  49144. * Sets the value of the `B` button
  49145. */
  49146. set buttonB(value: number);
  49147. /**
  49148. * Gets the value of the `X` button
  49149. */
  49150. get buttonX(): number;
  49151. /**
  49152. * Sets the value of the `X` button
  49153. */
  49154. set buttonX(value: number);
  49155. /**
  49156. * Gets the value of the `Y` button
  49157. */
  49158. get buttonY(): number;
  49159. /**
  49160. * Sets the value of the `Y` button
  49161. */
  49162. set buttonY(value: number);
  49163. /**
  49164. * Gets the value of the `Start` button
  49165. */
  49166. get buttonStart(): number;
  49167. /**
  49168. * Sets the value of the `Start` button
  49169. */
  49170. set buttonStart(value: number);
  49171. /**
  49172. * Gets the value of the `Back` button
  49173. */
  49174. get buttonBack(): number;
  49175. /**
  49176. * Sets the value of the `Back` button
  49177. */
  49178. set buttonBack(value: number);
  49179. /**
  49180. * Gets the value of the `Left` button
  49181. */
  49182. get buttonLB(): number;
  49183. /**
  49184. * Sets the value of the `Left` button
  49185. */
  49186. set buttonLB(value: number);
  49187. /**
  49188. * Gets the value of the `Right` button
  49189. */
  49190. get buttonRB(): number;
  49191. /**
  49192. * Sets the value of the `Right` button
  49193. */
  49194. set buttonRB(value: number);
  49195. /**
  49196. * Gets the value of the Left joystick
  49197. */
  49198. get buttonLeftStick(): number;
  49199. /**
  49200. * Sets the value of the Left joystick
  49201. */
  49202. set buttonLeftStick(value: number);
  49203. /**
  49204. * Gets the value of the Right joystick
  49205. */
  49206. get buttonRightStick(): number;
  49207. /**
  49208. * Sets the value of the Right joystick
  49209. */
  49210. set buttonRightStick(value: number);
  49211. /**
  49212. * Gets the value of D-pad up
  49213. */
  49214. get dPadUp(): number;
  49215. /**
  49216. * Sets the value of D-pad up
  49217. */
  49218. set dPadUp(value: number);
  49219. /**
  49220. * Gets the value of D-pad down
  49221. */
  49222. get dPadDown(): number;
  49223. /**
  49224. * Sets the value of D-pad down
  49225. */
  49226. set dPadDown(value: number);
  49227. /**
  49228. * Gets the value of D-pad left
  49229. */
  49230. get dPadLeft(): number;
  49231. /**
  49232. * Sets the value of D-pad left
  49233. */
  49234. set dPadLeft(value: number);
  49235. /**
  49236. * Gets the value of D-pad right
  49237. */
  49238. get dPadRight(): number;
  49239. /**
  49240. * Sets the value of D-pad right
  49241. */
  49242. set dPadRight(value: number);
  49243. /**
  49244. * Force the gamepad to synchronize with device values
  49245. */
  49246. update(): void;
  49247. /**
  49248. * Disposes the gamepad
  49249. */
  49250. dispose(): void;
  49251. }
  49252. }
  49253. declare module BABYLON {
  49254. /**
  49255. * Defines supported buttons for DualShock compatible gamepads
  49256. */
  49257. export enum DualShockButton {
  49258. /** Cross */
  49259. Cross = 0,
  49260. /** Circle */
  49261. Circle = 1,
  49262. /** Square */
  49263. Square = 2,
  49264. /** Triangle */
  49265. Triangle = 3,
  49266. /** L1 */
  49267. L1 = 4,
  49268. /** R1 */
  49269. R1 = 5,
  49270. /** Share */
  49271. Share = 8,
  49272. /** Options */
  49273. Options = 9,
  49274. /** Left stick */
  49275. LeftStick = 10,
  49276. /** Right stick */
  49277. RightStick = 11
  49278. }
  49279. /** Defines values for DualShock DPad */
  49280. export enum DualShockDpad {
  49281. /** Up */
  49282. Up = 12,
  49283. /** Down */
  49284. Down = 13,
  49285. /** Left */
  49286. Left = 14,
  49287. /** Right */
  49288. Right = 15
  49289. }
  49290. /**
  49291. * Defines a DualShock gamepad
  49292. */
  49293. export class DualShockPad extends Gamepad {
  49294. private _leftTrigger;
  49295. private _rightTrigger;
  49296. private _onlefttriggerchanged;
  49297. private _onrighttriggerchanged;
  49298. private _onbuttondown;
  49299. private _onbuttonup;
  49300. private _ondpaddown;
  49301. private _ondpadup;
  49302. /** Observable raised when a button is pressed */
  49303. onButtonDownObservable: Observable<DualShockButton>;
  49304. /** Observable raised when a button is released */
  49305. onButtonUpObservable: Observable<DualShockButton>;
  49306. /** Observable raised when a pad is pressed */
  49307. onPadDownObservable: Observable<DualShockDpad>;
  49308. /** Observable raised when a pad is released */
  49309. onPadUpObservable: Observable<DualShockDpad>;
  49310. private _buttonCross;
  49311. private _buttonCircle;
  49312. private _buttonSquare;
  49313. private _buttonTriangle;
  49314. private _buttonShare;
  49315. private _buttonOptions;
  49316. private _buttonL1;
  49317. private _buttonR1;
  49318. private _buttonLeftStick;
  49319. private _buttonRightStick;
  49320. private _dPadUp;
  49321. private _dPadDown;
  49322. private _dPadLeft;
  49323. private _dPadRight;
  49324. /**
  49325. * Creates a new DualShock gamepad object
  49326. * @param id defines the id of this gamepad
  49327. * @param index defines its index
  49328. * @param gamepad defines the internal HTML gamepad object
  49329. */
  49330. constructor(id: string, index: number, gamepad: any);
  49331. /**
  49332. * Defines the callback to call when left trigger is pressed
  49333. * @param callback defines the callback to use
  49334. */
  49335. onlefttriggerchanged(callback: (value: number) => void): void;
  49336. /**
  49337. * Defines the callback to call when right trigger is pressed
  49338. * @param callback defines the callback to use
  49339. */
  49340. onrighttriggerchanged(callback: (value: number) => void): void;
  49341. /**
  49342. * Gets the left trigger value
  49343. */
  49344. get leftTrigger(): number;
  49345. /**
  49346. * Sets the left trigger value
  49347. */
  49348. set leftTrigger(newValue: number);
  49349. /**
  49350. * Gets the right trigger value
  49351. */
  49352. get rightTrigger(): number;
  49353. /**
  49354. * Sets the right trigger value
  49355. */
  49356. set rightTrigger(newValue: number);
  49357. /**
  49358. * Defines the callback to call when a button is pressed
  49359. * @param callback defines the callback to use
  49360. */
  49361. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  49362. /**
  49363. * Defines the callback to call when a button is released
  49364. * @param callback defines the callback to use
  49365. */
  49366. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  49367. /**
  49368. * Defines the callback to call when a pad is pressed
  49369. * @param callback defines the callback to use
  49370. */
  49371. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  49372. /**
  49373. * Defines the callback to call when a pad is released
  49374. * @param callback defines the callback to use
  49375. */
  49376. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  49377. private _setButtonValue;
  49378. private _setDPadValue;
  49379. /**
  49380. * Gets the value of the `Cross` button
  49381. */
  49382. get buttonCross(): number;
  49383. /**
  49384. * Sets the value of the `Cross` button
  49385. */
  49386. set buttonCross(value: number);
  49387. /**
  49388. * Gets the value of the `Circle` button
  49389. */
  49390. get buttonCircle(): number;
  49391. /**
  49392. * Sets the value of the `Circle` button
  49393. */
  49394. set buttonCircle(value: number);
  49395. /**
  49396. * Gets the value of the `Square` button
  49397. */
  49398. get buttonSquare(): number;
  49399. /**
  49400. * Sets the value of the `Square` button
  49401. */
  49402. set buttonSquare(value: number);
  49403. /**
  49404. * Gets the value of the `Triangle` button
  49405. */
  49406. get buttonTriangle(): number;
  49407. /**
  49408. * Sets the value of the `Triangle` button
  49409. */
  49410. set buttonTriangle(value: number);
  49411. /**
  49412. * Gets the value of the `Options` button
  49413. */
  49414. get buttonOptions(): number;
  49415. /**
  49416. * Sets the value of the `Options` button
  49417. */
  49418. set buttonOptions(value: number);
  49419. /**
  49420. * Gets the value of the `Share` button
  49421. */
  49422. get buttonShare(): number;
  49423. /**
  49424. * Sets the value of the `Share` button
  49425. */
  49426. set buttonShare(value: number);
  49427. /**
  49428. * Gets the value of the `L1` button
  49429. */
  49430. get buttonL1(): number;
  49431. /**
  49432. * Sets the value of the `L1` button
  49433. */
  49434. set buttonL1(value: number);
  49435. /**
  49436. * Gets the value of the `R1` button
  49437. */
  49438. get buttonR1(): number;
  49439. /**
  49440. * Sets the value of the `R1` button
  49441. */
  49442. set buttonR1(value: number);
  49443. /**
  49444. * Gets the value of the Left joystick
  49445. */
  49446. get buttonLeftStick(): number;
  49447. /**
  49448. * Sets the value of the Left joystick
  49449. */
  49450. set buttonLeftStick(value: number);
  49451. /**
  49452. * Gets the value of the Right joystick
  49453. */
  49454. get buttonRightStick(): number;
  49455. /**
  49456. * Sets the value of the Right joystick
  49457. */
  49458. set buttonRightStick(value: number);
  49459. /**
  49460. * Gets the value of D-pad up
  49461. */
  49462. get dPadUp(): number;
  49463. /**
  49464. * Sets the value of D-pad up
  49465. */
  49466. set dPadUp(value: number);
  49467. /**
  49468. * Gets the value of D-pad down
  49469. */
  49470. get dPadDown(): number;
  49471. /**
  49472. * Sets the value of D-pad down
  49473. */
  49474. set dPadDown(value: number);
  49475. /**
  49476. * Gets the value of D-pad left
  49477. */
  49478. get dPadLeft(): number;
  49479. /**
  49480. * Sets the value of D-pad left
  49481. */
  49482. set dPadLeft(value: number);
  49483. /**
  49484. * Gets the value of D-pad right
  49485. */
  49486. get dPadRight(): number;
  49487. /**
  49488. * Sets the value of D-pad right
  49489. */
  49490. set dPadRight(value: number);
  49491. /**
  49492. * Force the gamepad to synchronize with device values
  49493. */
  49494. update(): void;
  49495. /**
  49496. * Disposes the gamepad
  49497. */
  49498. dispose(): void;
  49499. }
  49500. }
  49501. declare module BABYLON {
  49502. /**
  49503. * Manager for handling gamepads
  49504. */
  49505. export class GamepadManager {
  49506. private _scene?;
  49507. private _babylonGamepads;
  49508. private _oneGamepadConnected;
  49509. /** @hidden */
  49510. _isMonitoring: boolean;
  49511. private _gamepadEventSupported;
  49512. private _gamepadSupport?;
  49513. /**
  49514. * observable to be triggered when the gamepad controller has been connected
  49515. */
  49516. onGamepadConnectedObservable: Observable<Gamepad>;
  49517. /**
  49518. * observable to be triggered when the gamepad controller has been disconnected
  49519. */
  49520. onGamepadDisconnectedObservable: Observable<Gamepad>;
  49521. private _onGamepadConnectedEvent;
  49522. private _onGamepadDisconnectedEvent;
  49523. /**
  49524. * Initializes the gamepad manager
  49525. * @param _scene BabylonJS scene
  49526. */
  49527. constructor(_scene?: Scene | undefined);
  49528. /**
  49529. * The gamepads in the game pad manager
  49530. */
  49531. get gamepads(): Gamepad[];
  49532. /**
  49533. * Get the gamepad controllers based on type
  49534. * @param type The type of gamepad controller
  49535. * @returns Nullable gamepad
  49536. */
  49537. getGamepadByType(type?: number): Nullable<Gamepad>;
  49538. /**
  49539. * Disposes the gamepad manager
  49540. */
  49541. dispose(): void;
  49542. private _addNewGamepad;
  49543. private _startMonitoringGamepads;
  49544. private _stopMonitoringGamepads;
  49545. /** @hidden */
  49546. _checkGamepadsStatus(): void;
  49547. private _updateGamepadObjects;
  49548. }
  49549. }
  49550. declare module BABYLON {
  49551. interface Scene {
  49552. /** @hidden */
  49553. _gamepadManager: Nullable<GamepadManager>;
  49554. /**
  49555. * Gets the gamepad manager associated with the scene
  49556. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  49557. */
  49558. gamepadManager: GamepadManager;
  49559. }
  49560. /**
  49561. * Interface representing a free camera inputs manager
  49562. */
  49563. interface FreeCameraInputsManager {
  49564. /**
  49565. * Adds gamepad input support to the FreeCameraInputsManager.
  49566. * @returns the FreeCameraInputsManager
  49567. */
  49568. addGamepad(): FreeCameraInputsManager;
  49569. }
  49570. /**
  49571. * Interface representing an arc rotate camera inputs manager
  49572. */
  49573. interface ArcRotateCameraInputsManager {
  49574. /**
  49575. * Adds gamepad input support to the ArcRotateCamera InputManager.
  49576. * @returns the camera inputs manager
  49577. */
  49578. addGamepad(): ArcRotateCameraInputsManager;
  49579. }
  49580. /**
  49581. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  49582. */
  49583. export class GamepadSystemSceneComponent implements ISceneComponent {
  49584. /**
  49585. * The component name helpfull to identify the component in the list of scene components.
  49586. */
  49587. readonly name: string;
  49588. /**
  49589. * The scene the component belongs to.
  49590. */
  49591. scene: Scene;
  49592. /**
  49593. * Creates a new instance of the component for the given scene
  49594. * @param scene Defines the scene to register the component in
  49595. */
  49596. constructor(scene: Scene);
  49597. /**
  49598. * Registers the component in a given scene
  49599. */
  49600. register(): void;
  49601. /**
  49602. * Rebuilds the elements related to this component in case of
  49603. * context lost for instance.
  49604. */
  49605. rebuild(): void;
  49606. /**
  49607. * Disposes the component and the associated ressources
  49608. */
  49609. dispose(): void;
  49610. private _beforeCameraUpdate;
  49611. }
  49612. }
  49613. declare module BABYLON {
  49614. /**
  49615. * 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,
  49616. * which still works and will still be found in many Playgrounds.
  49617. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  49618. */
  49619. export class UniversalCamera extends TouchCamera {
  49620. /**
  49621. * Defines the gamepad rotation sensiblity.
  49622. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  49623. */
  49624. get gamepadAngularSensibility(): number;
  49625. set gamepadAngularSensibility(value: number);
  49626. /**
  49627. * Defines the gamepad move sensiblity.
  49628. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  49629. */
  49630. get gamepadMoveSensibility(): number;
  49631. set gamepadMoveSensibility(value: number);
  49632. /**
  49633. * 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,
  49634. * which still works and will still be found in many Playgrounds.
  49635. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  49636. * @param name Define the name of the camera in the scene
  49637. * @param position Define the start position of the camera in the scene
  49638. * @param scene Define the scene the camera belongs to
  49639. */
  49640. constructor(name: string, position: Vector3, scene: Scene);
  49641. /**
  49642. * Gets the current object class name.
  49643. * @return the class name
  49644. */
  49645. getClassName(): string;
  49646. }
  49647. }
  49648. declare module BABYLON {
  49649. /**
  49650. * This represents a FPS type of camera. This is only here for back compat purpose.
  49651. * Please use the UniversalCamera instead as both are identical.
  49652. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  49653. */
  49654. export class GamepadCamera extends UniversalCamera {
  49655. /**
  49656. * Instantiates a new Gamepad Camera
  49657. * This represents a FPS type of camera. This is only here for back compat purpose.
  49658. * Please use the UniversalCamera instead as both are identical.
  49659. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  49660. * @param name Define the name of the camera in the scene
  49661. * @param position Define the start position of the camera in the scene
  49662. * @param scene Define the scene the camera belongs to
  49663. */
  49664. constructor(name: string, position: Vector3, scene: Scene);
  49665. /**
  49666. * Gets the current object class name.
  49667. * @return the class name
  49668. */
  49669. getClassName(): string;
  49670. }
  49671. }
  49672. declare module BABYLON {
  49673. /** @hidden */
  49674. export var passPixelShader: {
  49675. name: string;
  49676. shader: string;
  49677. };
  49678. }
  49679. declare module BABYLON {
  49680. /** @hidden */
  49681. export var passCubePixelShader: {
  49682. name: string;
  49683. shader: string;
  49684. };
  49685. }
  49686. declare module BABYLON {
  49687. /**
  49688. * PassPostProcess which produces an output the same as it's input
  49689. */
  49690. export class PassPostProcess extends PostProcess {
  49691. /**
  49692. * Gets a string identifying the name of the class
  49693. * @returns "PassPostProcess" string
  49694. */
  49695. getClassName(): string;
  49696. /**
  49697. * Creates the PassPostProcess
  49698. * @param name The name of the effect.
  49699. * @param options The required width/height ratio to downsize to before computing the render pass.
  49700. * @param camera The camera to apply the render pass to.
  49701. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  49702. * @param engine The engine which the post process will be applied. (default: current engine)
  49703. * @param reusable If the post process can be reused on the same frame. (default: false)
  49704. * @param textureType The type of texture to be used when performing the post processing.
  49705. * @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)
  49706. */
  49707. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  49708. /** @hidden */
  49709. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  49710. }
  49711. /**
  49712. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  49713. */
  49714. export class PassCubePostProcess extends PostProcess {
  49715. private _face;
  49716. /**
  49717. * Gets or sets the cube face to display.
  49718. * * 0 is +X
  49719. * * 1 is -X
  49720. * * 2 is +Y
  49721. * * 3 is -Y
  49722. * * 4 is +Z
  49723. * * 5 is -Z
  49724. */
  49725. get face(): number;
  49726. set face(value: number);
  49727. /**
  49728. * Gets a string identifying the name of the class
  49729. * @returns "PassCubePostProcess" string
  49730. */
  49731. getClassName(): string;
  49732. /**
  49733. * Creates the PassCubePostProcess
  49734. * @param name The name of the effect.
  49735. * @param options The required width/height ratio to downsize to before computing the render pass.
  49736. * @param camera The camera to apply the render pass to.
  49737. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  49738. * @param engine The engine which the post process will be applied. (default: current engine)
  49739. * @param reusable If the post process can be reused on the same frame. (default: false)
  49740. * @param textureType The type of texture to be used when performing the post processing.
  49741. * @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)
  49742. */
  49743. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  49744. /** @hidden */
  49745. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  49746. }
  49747. }
  49748. declare module BABYLON {
  49749. /** @hidden */
  49750. export var anaglyphPixelShader: {
  49751. name: string;
  49752. shader: string;
  49753. };
  49754. }
  49755. declare module BABYLON {
  49756. /**
  49757. * Postprocess used to generate anaglyphic rendering
  49758. */
  49759. export class AnaglyphPostProcess extends PostProcess {
  49760. private _passedProcess;
  49761. /**
  49762. * Gets a string identifying the name of the class
  49763. * @returns "AnaglyphPostProcess" string
  49764. */
  49765. getClassName(): string;
  49766. /**
  49767. * Creates a new AnaglyphPostProcess
  49768. * @param name defines postprocess name
  49769. * @param options defines creation options or target ratio scale
  49770. * @param rigCameras defines cameras using this postprocess
  49771. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  49772. * @param engine defines hosting engine
  49773. * @param reusable defines if the postprocess will be reused multiple times per frame
  49774. */
  49775. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  49776. }
  49777. }
  49778. declare module BABYLON {
  49779. /**
  49780. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  49781. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  49782. */
  49783. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  49784. /**
  49785. * Creates a new AnaglyphArcRotateCamera
  49786. * @param name defines camera name
  49787. * @param alpha defines alpha angle (in radians)
  49788. * @param beta defines beta angle (in radians)
  49789. * @param radius defines radius
  49790. * @param target defines camera target
  49791. * @param interaxialDistance defines distance between each color axis
  49792. * @param scene defines the hosting scene
  49793. */
  49794. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  49795. /**
  49796. * Gets camera class name
  49797. * @returns AnaglyphArcRotateCamera
  49798. */
  49799. getClassName(): string;
  49800. }
  49801. }
  49802. declare module BABYLON {
  49803. /**
  49804. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  49805. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  49806. */
  49807. export class AnaglyphFreeCamera extends FreeCamera {
  49808. /**
  49809. * Creates a new AnaglyphFreeCamera
  49810. * @param name defines camera name
  49811. * @param position defines initial position
  49812. * @param interaxialDistance defines distance between each color axis
  49813. * @param scene defines the hosting scene
  49814. */
  49815. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  49816. /**
  49817. * Gets camera class name
  49818. * @returns AnaglyphFreeCamera
  49819. */
  49820. getClassName(): string;
  49821. }
  49822. }
  49823. declare module BABYLON {
  49824. /**
  49825. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  49826. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  49827. */
  49828. export class AnaglyphGamepadCamera extends GamepadCamera {
  49829. /**
  49830. * Creates a new AnaglyphGamepadCamera
  49831. * @param name defines camera name
  49832. * @param position defines initial position
  49833. * @param interaxialDistance defines distance between each color axis
  49834. * @param scene defines the hosting scene
  49835. */
  49836. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  49837. /**
  49838. * Gets camera class name
  49839. * @returns AnaglyphGamepadCamera
  49840. */
  49841. getClassName(): string;
  49842. }
  49843. }
  49844. declare module BABYLON {
  49845. /**
  49846. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  49847. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  49848. */
  49849. export class AnaglyphUniversalCamera extends UniversalCamera {
  49850. /**
  49851. * Creates a new AnaglyphUniversalCamera
  49852. * @param name defines camera name
  49853. * @param position defines initial position
  49854. * @param interaxialDistance defines distance between each color axis
  49855. * @param scene defines the hosting scene
  49856. */
  49857. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  49858. /**
  49859. * Gets camera class name
  49860. * @returns AnaglyphUniversalCamera
  49861. */
  49862. getClassName(): string;
  49863. }
  49864. }
  49865. declare module BABYLON {
  49866. /**
  49867. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  49868. * @see https://doc.babylonjs.com/features/cameras
  49869. */
  49870. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  49871. /**
  49872. * Creates a new StereoscopicArcRotateCamera
  49873. * @param name defines camera name
  49874. * @param alpha defines alpha angle (in radians)
  49875. * @param beta defines beta angle (in radians)
  49876. * @param radius defines radius
  49877. * @param target defines camera target
  49878. * @param interaxialDistance defines distance between each color axis
  49879. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  49880. * @param scene defines the hosting scene
  49881. */
  49882. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  49883. /**
  49884. * Gets camera class name
  49885. * @returns StereoscopicArcRotateCamera
  49886. */
  49887. getClassName(): string;
  49888. }
  49889. }
  49890. declare module BABYLON {
  49891. /**
  49892. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  49893. * @see https://doc.babylonjs.com/features/cameras
  49894. */
  49895. export class StereoscopicFreeCamera extends FreeCamera {
  49896. /**
  49897. * Creates a new StereoscopicFreeCamera
  49898. * @param name defines camera name
  49899. * @param position defines initial position
  49900. * @param interaxialDistance defines distance between each color axis
  49901. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  49902. * @param scene defines the hosting scene
  49903. */
  49904. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  49905. /**
  49906. * Gets camera class name
  49907. * @returns StereoscopicFreeCamera
  49908. */
  49909. getClassName(): string;
  49910. }
  49911. }
  49912. declare module BABYLON {
  49913. /**
  49914. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  49915. * @see https://doc.babylonjs.com/features/cameras
  49916. */
  49917. export class StereoscopicGamepadCamera extends GamepadCamera {
  49918. /**
  49919. * Creates a new StereoscopicGamepadCamera
  49920. * @param name defines camera name
  49921. * @param position defines initial position
  49922. * @param interaxialDistance defines distance between each color axis
  49923. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  49924. * @param scene defines the hosting scene
  49925. */
  49926. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  49927. /**
  49928. * Gets camera class name
  49929. * @returns StereoscopicGamepadCamera
  49930. */
  49931. getClassName(): string;
  49932. }
  49933. }
  49934. declare module BABYLON {
  49935. /**
  49936. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  49937. * @see https://doc.babylonjs.com/features/cameras
  49938. */
  49939. export class StereoscopicUniversalCamera extends UniversalCamera {
  49940. /**
  49941. * Creates a new StereoscopicUniversalCamera
  49942. * @param name defines camera name
  49943. * @param position defines initial position
  49944. * @param interaxialDistance defines distance between each color axis
  49945. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  49946. * @param scene defines the hosting scene
  49947. */
  49948. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  49949. /**
  49950. * Gets camera class name
  49951. * @returns StereoscopicUniversalCamera
  49952. */
  49953. getClassName(): string;
  49954. }
  49955. }
  49956. declare module BABYLON {
  49957. /**
  49958. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  49959. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  49960. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  49961. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  49962. */
  49963. export class VirtualJoysticksCamera extends FreeCamera {
  49964. /**
  49965. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  49966. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  49967. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  49968. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  49969. * @param name Define the name of the camera in the scene
  49970. * @param position Define the start position of the camera in the scene
  49971. * @param scene Define the scene the camera belongs to
  49972. */
  49973. constructor(name: string, position: Vector3, scene: Scene);
  49974. /**
  49975. * Gets the current object class name.
  49976. * @return the class name
  49977. */
  49978. getClassName(): string;
  49979. }
  49980. }
  49981. declare module BABYLON {
  49982. /**
  49983. * This represents all the required metrics to create a VR camera.
  49984. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  49985. */
  49986. export class VRCameraMetrics {
  49987. /**
  49988. * Define the horizontal resolution off the screen.
  49989. */
  49990. hResolution: number;
  49991. /**
  49992. * Define the vertical resolution off the screen.
  49993. */
  49994. vResolution: number;
  49995. /**
  49996. * Define the horizontal screen size.
  49997. */
  49998. hScreenSize: number;
  49999. /**
  50000. * Define the vertical screen size.
  50001. */
  50002. vScreenSize: number;
  50003. /**
  50004. * Define the vertical screen center position.
  50005. */
  50006. vScreenCenter: number;
  50007. /**
  50008. * Define the distance of the eyes to the screen.
  50009. */
  50010. eyeToScreenDistance: number;
  50011. /**
  50012. * Define the distance between both lenses
  50013. */
  50014. lensSeparationDistance: number;
  50015. /**
  50016. * Define the distance between both viewer's eyes.
  50017. */
  50018. interpupillaryDistance: number;
  50019. /**
  50020. * Define the distortion factor of the VR postprocess.
  50021. * Please, touch with care.
  50022. */
  50023. distortionK: number[];
  50024. /**
  50025. * Define the chromatic aberration correction factors for the VR post process.
  50026. */
  50027. chromaAbCorrection: number[];
  50028. /**
  50029. * Define the scale factor of the post process.
  50030. * The smaller the better but the slower.
  50031. */
  50032. postProcessScaleFactor: number;
  50033. /**
  50034. * Define an offset for the lens center.
  50035. */
  50036. lensCenterOffset: number;
  50037. /**
  50038. * Define if the current vr camera should compensate the distortion of the lense or not.
  50039. */
  50040. compensateDistortion: boolean;
  50041. /**
  50042. * Defines if multiview should be enabled when rendering (Default: false)
  50043. */
  50044. multiviewEnabled: boolean;
  50045. /**
  50046. * Gets the rendering aspect ratio based on the provided resolutions.
  50047. */
  50048. get aspectRatio(): number;
  50049. /**
  50050. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  50051. */
  50052. get aspectRatioFov(): number;
  50053. /**
  50054. * @hidden
  50055. */
  50056. get leftHMatrix(): Matrix;
  50057. /**
  50058. * @hidden
  50059. */
  50060. get rightHMatrix(): Matrix;
  50061. /**
  50062. * @hidden
  50063. */
  50064. get leftPreViewMatrix(): Matrix;
  50065. /**
  50066. * @hidden
  50067. */
  50068. get rightPreViewMatrix(): Matrix;
  50069. /**
  50070. * Get the default VRMetrics based on the most generic setup.
  50071. * @returns the default vr metrics
  50072. */
  50073. static GetDefault(): VRCameraMetrics;
  50074. }
  50075. }
  50076. declare module BABYLON {
  50077. /** @hidden */
  50078. export var vrDistortionCorrectionPixelShader: {
  50079. name: string;
  50080. shader: string;
  50081. };
  50082. }
  50083. declare module BABYLON {
  50084. /**
  50085. * VRDistortionCorrectionPostProcess used for mobile VR
  50086. */
  50087. export class VRDistortionCorrectionPostProcess extends PostProcess {
  50088. private _isRightEye;
  50089. private _distortionFactors;
  50090. private _postProcessScaleFactor;
  50091. private _lensCenterOffset;
  50092. private _scaleIn;
  50093. private _scaleFactor;
  50094. private _lensCenter;
  50095. /**
  50096. * Gets a string identifying the name of the class
  50097. * @returns "VRDistortionCorrectionPostProcess" string
  50098. */
  50099. getClassName(): string;
  50100. /**
  50101. * Initializes the VRDistortionCorrectionPostProcess
  50102. * @param name The name of the effect.
  50103. * @param camera The camera to apply the render pass to.
  50104. * @param isRightEye If this is for the right eye distortion
  50105. * @param vrMetrics All the required metrics for the VR camera
  50106. */
  50107. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  50108. }
  50109. }
  50110. declare module BABYLON {
  50111. /**
  50112. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  50113. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  50114. */
  50115. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  50116. /**
  50117. * Creates a new VRDeviceOrientationArcRotateCamera
  50118. * @param name defines camera name
  50119. * @param alpha defines the camera rotation along the logitudinal axis
  50120. * @param beta defines the camera rotation along the latitudinal axis
  50121. * @param radius defines the camera distance from its target
  50122. * @param target defines the camera target
  50123. * @param scene defines the scene the camera belongs to
  50124. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  50125. * @param vrCameraMetrics defines the vr metrics associated to the camera
  50126. */
  50127. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  50128. /**
  50129. * Gets camera class name
  50130. * @returns VRDeviceOrientationArcRotateCamera
  50131. */
  50132. getClassName(): string;
  50133. }
  50134. }
  50135. declare module BABYLON {
  50136. /**
  50137. * Camera used to simulate VR rendering (based on FreeCamera)
  50138. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  50139. */
  50140. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  50141. /**
  50142. * Creates a new VRDeviceOrientationFreeCamera
  50143. * @param name defines camera name
  50144. * @param position defines the start position of the camera
  50145. * @param scene defines the scene the camera belongs to
  50146. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  50147. * @param vrCameraMetrics defines the vr metrics associated to the camera
  50148. */
  50149. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  50150. /**
  50151. * Gets camera class name
  50152. * @returns VRDeviceOrientationFreeCamera
  50153. */
  50154. getClassName(): string;
  50155. }
  50156. }
  50157. declare module BABYLON {
  50158. /**
  50159. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  50160. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  50161. */
  50162. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  50163. /**
  50164. * Creates a new VRDeviceOrientationGamepadCamera
  50165. * @param name defines camera name
  50166. * @param position defines the start position of the camera
  50167. * @param scene defines the scene the camera belongs to
  50168. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  50169. * @param vrCameraMetrics defines the vr metrics associated to the camera
  50170. */
  50171. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  50172. /**
  50173. * Gets camera class name
  50174. * @returns VRDeviceOrientationGamepadCamera
  50175. */
  50176. getClassName(): string;
  50177. }
  50178. }
  50179. declare module BABYLON {
  50180. /**
  50181. * A class extending Texture allowing drawing on a texture
  50182. * @see https://doc.babylonjs.com/how_to/dynamictexture
  50183. */
  50184. export class DynamicTexture extends Texture {
  50185. private _generateMipMaps;
  50186. private _canvas;
  50187. private _context;
  50188. /**
  50189. * Creates a DynamicTexture
  50190. * @param name defines the name of the texture
  50191. * @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
  50192. * @param scene defines the scene where you want the texture
  50193. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  50194. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  50195. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  50196. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  50197. */
  50198. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number, invertY?: boolean);
  50199. /**
  50200. * Get the current class name of the texture useful for serialization or dynamic coding.
  50201. * @returns "DynamicTexture"
  50202. */
  50203. getClassName(): string;
  50204. /**
  50205. * Gets the current state of canRescale
  50206. */
  50207. get canRescale(): boolean;
  50208. private _recreate;
  50209. /**
  50210. * Scales the texture
  50211. * @param ratio the scale factor to apply to both width and height
  50212. */
  50213. scale(ratio: number): void;
  50214. /**
  50215. * Resizes the texture
  50216. * @param width the new width
  50217. * @param height the new height
  50218. */
  50219. scaleTo(width: number, height: number): void;
  50220. /**
  50221. * Gets the context of the canvas used by the texture
  50222. * @returns the canvas context of the dynamic texture
  50223. */
  50224. getContext(): CanvasRenderingContext2D;
  50225. /**
  50226. * Clears the texture
  50227. */
  50228. clear(): void;
  50229. /**
  50230. * Updates the texture
  50231. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  50232. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  50233. */
  50234. update(invertY?: boolean, premulAlpha?: boolean): void;
  50235. /**
  50236. * Draws text onto the texture
  50237. * @param text defines the text to be drawn
  50238. * @param x defines the placement of the text from the left
  50239. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  50240. * @param font defines the font to be used with font-style, font-size, font-name
  50241. * @param color defines the color used for the text
  50242. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  50243. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  50244. * @param update defines whether texture is immediately update (default is true)
  50245. */
  50246. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  50247. /**
  50248. * Clones the texture
  50249. * @returns the clone of the texture.
  50250. */
  50251. clone(): DynamicTexture;
  50252. /**
  50253. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  50254. * @returns a serialized dynamic texture object
  50255. */
  50256. serialize(): any;
  50257. private _IsCanvasElement;
  50258. /** @hidden */
  50259. _rebuild(): void;
  50260. }
  50261. }
  50262. declare module BABYLON {
  50263. /**
  50264. * Class containing static functions to help procedurally build meshes
  50265. */
  50266. export class GroundBuilder {
  50267. /**
  50268. * Creates a ground mesh
  50269. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  50270. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  50271. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50272. * @param name defines the name of the mesh
  50273. * @param options defines the options used to create the mesh
  50274. * @param scene defines the hosting scene
  50275. * @returns the ground mesh
  50276. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  50277. */
  50278. static CreateGround(name: string, options: {
  50279. width?: number;
  50280. height?: number;
  50281. subdivisions?: number;
  50282. subdivisionsX?: number;
  50283. subdivisionsY?: number;
  50284. updatable?: boolean;
  50285. }, scene: any): Mesh;
  50286. /**
  50287. * Creates a tiled ground mesh
  50288. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  50289. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  50290. * * 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
  50291. * * 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
  50292. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  50293. * @param name defines the name of the mesh
  50294. * @param options defines the options used to create the mesh
  50295. * @param scene defines the hosting scene
  50296. * @returns the tiled ground mesh
  50297. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  50298. */
  50299. static CreateTiledGround(name: string, options: {
  50300. xmin: number;
  50301. zmin: number;
  50302. xmax: number;
  50303. zmax: number;
  50304. subdivisions?: {
  50305. w: number;
  50306. h: number;
  50307. };
  50308. precision?: {
  50309. w: number;
  50310. h: number;
  50311. };
  50312. updatable?: boolean;
  50313. }, scene?: Nullable<Scene>): Mesh;
  50314. /**
  50315. * Creates a ground mesh from a height map
  50316. * * The parameter `url` sets the URL of the height map image resource.
  50317. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  50318. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  50319. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  50320. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  50321. * * 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.
  50322. * * 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).
  50323. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  50324. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  50325. * @param name defines the name of the mesh
  50326. * @param url defines the url to the height map
  50327. * @param options defines the options used to create the mesh
  50328. * @param scene defines the hosting scene
  50329. * @returns the ground mesh
  50330. * @see https://doc.babylonjs.com/babylon101/height_map
  50331. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  50332. */
  50333. static CreateGroundFromHeightMap(name: string, url: string, options: {
  50334. width?: number;
  50335. height?: number;
  50336. subdivisions?: number;
  50337. minHeight?: number;
  50338. maxHeight?: number;
  50339. colorFilter?: Color3;
  50340. alphaFilter?: number;
  50341. updatable?: boolean;
  50342. onReady?: (mesh: GroundMesh) => void;
  50343. }, scene?: Nullable<Scene>): GroundMesh;
  50344. }
  50345. }
  50346. declare module BABYLON {
  50347. /**
  50348. * Class containing static functions to help procedurally build meshes
  50349. */
  50350. export class TorusBuilder {
  50351. /**
  50352. * Creates a torus mesh
  50353. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  50354. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  50355. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  50356. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  50357. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  50358. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  50359. * @param name defines the name of the mesh
  50360. * @param options defines the options used to create the mesh
  50361. * @param scene defines the hosting scene
  50362. * @returns the torus mesh
  50363. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  50364. */
  50365. static CreateTorus(name: string, options: {
  50366. diameter?: number;
  50367. thickness?: number;
  50368. tessellation?: number;
  50369. updatable?: boolean;
  50370. sideOrientation?: number;
  50371. frontUVs?: Vector4;
  50372. backUVs?: Vector4;
  50373. }, scene: any): Mesh;
  50374. }
  50375. }
  50376. declare module BABYLON {
  50377. /**
  50378. * Class containing static functions to help procedurally build meshes
  50379. */
  50380. export class CylinderBuilder {
  50381. /**
  50382. * Creates a cylinder or a cone mesh
  50383. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  50384. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  50385. * * 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.
  50386. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  50387. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  50388. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  50389. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  50390. * * 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).
  50391. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  50392. * * 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).
  50393. * * 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
  50394. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  50395. * * 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
  50396. * * 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.
  50397. * * If `enclose` is false, a ring surface is one element.
  50398. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  50399. * * 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
  50400. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  50401. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  50402. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  50403. * @param name defines the name of the mesh
  50404. * @param options defines the options used to create the mesh
  50405. * @param scene defines the hosting scene
  50406. * @returns the cylinder mesh
  50407. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  50408. */
  50409. static CreateCylinder(name: string, options: {
  50410. height?: number;
  50411. diameterTop?: number;
  50412. diameterBottom?: number;
  50413. diameter?: number;
  50414. tessellation?: number;
  50415. subdivisions?: number;
  50416. arc?: number;
  50417. faceColors?: Color4[];
  50418. faceUV?: Vector4[];
  50419. updatable?: boolean;
  50420. hasRings?: boolean;
  50421. enclose?: boolean;
  50422. cap?: number;
  50423. sideOrientation?: number;
  50424. frontUVs?: Vector4;
  50425. backUVs?: Vector4;
  50426. }, scene: any): Mesh;
  50427. }
  50428. }
  50429. declare module BABYLON {
  50430. /**
  50431. * States of the webXR experience
  50432. */
  50433. export enum WebXRState {
  50434. /**
  50435. * Transitioning to being in XR mode
  50436. */
  50437. ENTERING_XR = 0,
  50438. /**
  50439. * Transitioning to non XR mode
  50440. */
  50441. EXITING_XR = 1,
  50442. /**
  50443. * In XR mode and presenting
  50444. */
  50445. IN_XR = 2,
  50446. /**
  50447. * Not entered XR mode
  50448. */
  50449. NOT_IN_XR = 3
  50450. }
  50451. /**
  50452. * The state of the XR camera's tracking
  50453. */
  50454. export enum WebXRTrackingState {
  50455. /**
  50456. * No transformation received, device is not being tracked
  50457. */
  50458. NOT_TRACKING = 0,
  50459. /**
  50460. * Tracking lost - using emulated position
  50461. */
  50462. TRACKING_LOST = 1,
  50463. /**
  50464. * Transformation tracking works normally
  50465. */
  50466. TRACKING = 2
  50467. }
  50468. /**
  50469. * Abstraction of the XR render target
  50470. */
  50471. export interface WebXRRenderTarget extends IDisposable {
  50472. /**
  50473. * xrpresent context of the canvas which can be used to display/mirror xr content
  50474. */
  50475. canvasContext: WebGLRenderingContext;
  50476. /**
  50477. * xr layer for the canvas
  50478. */
  50479. xrLayer: Nullable<XRWebGLLayer>;
  50480. /**
  50481. * Initializes the xr layer for the session
  50482. * @param xrSession xr session
  50483. * @returns a promise that will resolve once the XR Layer has been created
  50484. */
  50485. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  50486. }
  50487. }
  50488. declare module BABYLON {
  50489. /**
  50490. * COnfiguration object for WebXR output canvas
  50491. */
  50492. export class WebXRManagedOutputCanvasOptions {
  50493. /**
  50494. * An optional canvas in case you wish to create it yourself and provide it here.
  50495. * If not provided, a new canvas will be created
  50496. */
  50497. canvasElement?: HTMLCanvasElement;
  50498. /**
  50499. * Options for this XR Layer output
  50500. */
  50501. canvasOptions?: XRWebGLLayerInit;
  50502. /**
  50503. * CSS styling for a newly created canvas (if not provided)
  50504. */
  50505. newCanvasCssStyle?: string;
  50506. /**
  50507. * Get the default values of the configuration object
  50508. * @param engine defines the engine to use (can be null)
  50509. * @returns default values of this configuration object
  50510. */
  50511. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  50512. }
  50513. /**
  50514. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  50515. */
  50516. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  50517. private _options;
  50518. private _canvas;
  50519. private _engine;
  50520. private _originalCanvasSize;
  50521. /**
  50522. * Rendering context of the canvas which can be used to display/mirror xr content
  50523. */
  50524. canvasContext: WebGLRenderingContext;
  50525. /**
  50526. * xr layer for the canvas
  50527. */
  50528. xrLayer: Nullable<XRWebGLLayer>;
  50529. /**
  50530. * Obseervers registered here will be triggered when the xr layer was initialized
  50531. */
  50532. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  50533. /**
  50534. * Initializes the canvas to be added/removed upon entering/exiting xr
  50535. * @param _xrSessionManager The XR Session manager
  50536. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  50537. */
  50538. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  50539. /**
  50540. * Disposes of the object
  50541. */
  50542. dispose(): void;
  50543. /**
  50544. * Initializes the xr layer for the session
  50545. * @param xrSession xr session
  50546. * @returns a promise that will resolve once the XR Layer has been created
  50547. */
  50548. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  50549. private _addCanvas;
  50550. private _removeCanvas;
  50551. private _setCanvasSize;
  50552. private _setManagedOutputCanvas;
  50553. }
  50554. }
  50555. declare module BABYLON {
  50556. /**
  50557. * Manages an XRSession to work with Babylon's engine
  50558. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  50559. */
  50560. export class WebXRSessionManager implements IDisposable {
  50561. /** The scene which the session should be created for */
  50562. scene: Scene;
  50563. private _referenceSpace;
  50564. private _rttProvider;
  50565. private _sessionEnded;
  50566. private _xrNavigator;
  50567. private baseLayer;
  50568. /**
  50569. * The base reference space from which the session started. good if you want to reset your
  50570. * reference space
  50571. */
  50572. baseReferenceSpace: XRReferenceSpace;
  50573. /**
  50574. * Current XR frame
  50575. */
  50576. currentFrame: Nullable<XRFrame>;
  50577. /** WebXR timestamp updated every frame */
  50578. currentTimestamp: number;
  50579. /**
  50580. * Used just in case of a failure to initialize an immersive session.
  50581. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  50582. */
  50583. defaultHeightCompensation: number;
  50584. /**
  50585. * Fires every time a new xrFrame arrives which can be used to update the camera
  50586. */
  50587. onXRFrameObservable: Observable<XRFrame>;
  50588. /**
  50589. * Fires when the reference space changed
  50590. */
  50591. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  50592. /**
  50593. * Fires when the xr session is ended either by the device or manually done
  50594. */
  50595. onXRSessionEnded: Observable<any>;
  50596. /**
  50597. * Fires when the xr session is ended either by the device or manually done
  50598. */
  50599. onXRSessionInit: Observable<XRSession>;
  50600. /**
  50601. * Underlying xr session
  50602. */
  50603. session: XRSession;
  50604. /**
  50605. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  50606. * or get the offset the player is currently at.
  50607. */
  50608. viewerReferenceSpace: XRReferenceSpace;
  50609. /**
  50610. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  50611. * @param scene The scene which the session should be created for
  50612. */
  50613. constructor(
  50614. /** The scene which the session should be created for */
  50615. scene: Scene);
  50616. /**
  50617. * The current reference space used in this session. This reference space can constantly change!
  50618. * It is mainly used to offset the camera's position.
  50619. */
  50620. get referenceSpace(): XRReferenceSpace;
  50621. /**
  50622. * Set a new reference space and triggers the observable
  50623. */
  50624. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  50625. /**
  50626. * Disposes of the session manager
  50627. */
  50628. dispose(): void;
  50629. /**
  50630. * Stops the xrSession and restores the render loop
  50631. * @returns Promise which resolves after it exits XR
  50632. */
  50633. exitXRAsync(): Promise<void>;
  50634. /**
  50635. * Gets the correct render target texture to be rendered this frame for this eye
  50636. * @param eye the eye for which to get the render target
  50637. * @returns the render target for the specified eye
  50638. */
  50639. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  50640. /**
  50641. * Creates a WebXRRenderTarget object for the XR session
  50642. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  50643. * @param options optional options to provide when creating a new render target
  50644. * @returns a WebXR render target to which the session can render
  50645. */
  50646. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  50647. /**
  50648. * Initializes the manager
  50649. * After initialization enterXR can be called to start an XR session
  50650. * @returns Promise which resolves after it is initialized
  50651. */
  50652. initializeAsync(): Promise<void>;
  50653. /**
  50654. * Initializes an xr session
  50655. * @param xrSessionMode mode to initialize
  50656. * @param xrSessionInit defines optional and required values to pass to the session builder
  50657. * @returns a promise which will resolve once the session has been initialized
  50658. */
  50659. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  50660. /**
  50661. * Checks if a session would be supported for the creation options specified
  50662. * @param sessionMode session mode to check if supported eg. immersive-vr
  50663. * @returns A Promise that resolves to true if supported and false if not
  50664. */
  50665. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  50666. /**
  50667. * Resets the reference space to the one started the session
  50668. */
  50669. resetReferenceSpace(): void;
  50670. /**
  50671. * Starts rendering to the xr layer
  50672. */
  50673. runXRRenderLoop(): void;
  50674. /**
  50675. * Sets the reference space on the xr session
  50676. * @param referenceSpaceType space to set
  50677. * @returns a promise that will resolve once the reference space has been set
  50678. */
  50679. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  50680. /**
  50681. * Updates the render state of the session
  50682. * @param state state to set
  50683. * @returns a promise that resolves once the render state has been updated
  50684. */
  50685. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  50686. /**
  50687. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  50688. * @param sessionMode defines the session to test
  50689. * @returns a promise with boolean as final value
  50690. */
  50691. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  50692. private _createRenderTargetTexture;
  50693. }
  50694. }
  50695. declare module BABYLON {
  50696. /**
  50697. * WebXR Camera which holds the views for the xrSession
  50698. * @see https://doc.babylonjs.com/how_to/webxr_camera
  50699. */
  50700. export class WebXRCamera extends FreeCamera {
  50701. private _xrSessionManager;
  50702. private _firstFrame;
  50703. private _referenceQuaternion;
  50704. private _referencedPosition;
  50705. private _xrInvPositionCache;
  50706. private _xrInvQuaternionCache;
  50707. private _trackingState;
  50708. /**
  50709. * Observable raised before camera teleportation
  50710. */
  50711. onBeforeCameraTeleport: Observable<Vector3>;
  50712. /**
  50713. * Observable raised after camera teleportation
  50714. */
  50715. onAfterCameraTeleport: Observable<Vector3>;
  50716. /**
  50717. * Notifies when the camera's tracking state has changed.
  50718. * Notice - will also be triggered when tracking has started (at the beginning of the session)
  50719. */
  50720. onTrackingStateChanged: Observable<WebXRTrackingState>;
  50721. /**
  50722. * Should position compensation execute on first frame.
  50723. * This is used when copying the position from a native (non XR) camera
  50724. */
  50725. compensateOnFirstFrame: boolean;
  50726. /**
  50727. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  50728. * @param name the name of the camera
  50729. * @param scene the scene to add the camera to
  50730. * @param _xrSessionManager a constructed xr session manager
  50731. */
  50732. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  50733. /**
  50734. * Get the current XR tracking state of the camera
  50735. */
  50736. get trackingState(): WebXRTrackingState;
  50737. private _setTrackingState;
  50738. /**
  50739. * Return the user's height, unrelated to the current ground.
  50740. * This will be the y position of this camera, when ground level is 0.
  50741. */
  50742. get realWorldHeight(): number;
  50743. /** @hidden */
  50744. _updateForDualEyeDebugging(): void;
  50745. /**
  50746. * Sets this camera's transformation based on a non-vr camera
  50747. * @param otherCamera the non-vr camera to copy the transformation from
  50748. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  50749. */
  50750. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  50751. /**
  50752. * Gets the current instance class name ("WebXRCamera").
  50753. * @returns the class name
  50754. */
  50755. getClassName(): string;
  50756. private _rotate180;
  50757. private _updateFromXRSession;
  50758. private _updateNumberOfRigCameras;
  50759. private _updateReferenceSpace;
  50760. private _updateReferenceSpaceOffset;
  50761. }
  50762. }
  50763. declare module BABYLON {
  50764. /**
  50765. * Defining the interface required for a (webxr) feature
  50766. */
  50767. export interface IWebXRFeature extends IDisposable {
  50768. /**
  50769. * Is this feature attached
  50770. */
  50771. attached: boolean;
  50772. /**
  50773. * Should auto-attach be disabled?
  50774. */
  50775. disableAutoAttach: boolean;
  50776. /**
  50777. * Attach the feature to the session
  50778. * Will usually be called by the features manager
  50779. *
  50780. * @param force should attachment be forced (even when already attached)
  50781. * @returns true if successful.
  50782. */
  50783. attach(force?: boolean): boolean;
  50784. /**
  50785. * Detach the feature from the session
  50786. * Will usually be called by the features manager
  50787. *
  50788. * @returns true if successful.
  50789. */
  50790. detach(): boolean;
  50791. /**
  50792. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  50793. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  50794. *
  50795. * @returns whether or not the feature is compatible in this environment
  50796. */
  50797. isCompatible(): boolean;
  50798. /**
  50799. * Was this feature disposed;
  50800. */
  50801. isDisposed: boolean;
  50802. /**
  50803. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  50804. */
  50805. xrNativeFeatureName?: string;
  50806. /**
  50807. * A list of (Babylon WebXR) features this feature depends on
  50808. */
  50809. dependsOn?: string[];
  50810. }
  50811. /**
  50812. * A list of the currently available features without referencing them
  50813. */
  50814. export class WebXRFeatureName {
  50815. /**
  50816. * The name of the anchor system feature
  50817. */
  50818. static readonly ANCHOR_SYSTEM: string;
  50819. /**
  50820. * The name of the background remover feature
  50821. */
  50822. static readonly BACKGROUND_REMOVER: string;
  50823. /**
  50824. * The name of the hit test feature
  50825. */
  50826. static readonly HIT_TEST: string;
  50827. /**
  50828. * physics impostors for xr controllers feature
  50829. */
  50830. static readonly PHYSICS_CONTROLLERS: string;
  50831. /**
  50832. * The name of the plane detection feature
  50833. */
  50834. static readonly PLANE_DETECTION: string;
  50835. /**
  50836. * The name of the pointer selection feature
  50837. */
  50838. static readonly POINTER_SELECTION: string;
  50839. /**
  50840. * The name of the teleportation feature
  50841. */
  50842. static readonly TELEPORTATION: string;
  50843. /**
  50844. * The name of the feature points feature.
  50845. */
  50846. static readonly FEATURE_POINTS: string;
  50847. /**
  50848. * The name of the hand tracking feature.
  50849. */
  50850. static readonly HAND_TRACKING: string;
  50851. }
  50852. /**
  50853. * Defining the constructor of a feature. Used to register the modules.
  50854. */
  50855. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  50856. /**
  50857. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  50858. * It is mainly used in AR sessions.
  50859. *
  50860. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  50861. */
  50862. export class WebXRFeaturesManager implements IDisposable {
  50863. private _xrSessionManager;
  50864. private static readonly _AvailableFeatures;
  50865. private _features;
  50866. /**
  50867. * constructs a new features manages.
  50868. *
  50869. * @param _xrSessionManager an instance of WebXRSessionManager
  50870. */
  50871. constructor(_xrSessionManager: WebXRSessionManager);
  50872. /**
  50873. * Used to register a module. After calling this function a developer can use this feature in the scene.
  50874. * Mainly used internally.
  50875. *
  50876. * @param featureName the name of the feature to register
  50877. * @param constructorFunction the function used to construct the module
  50878. * @param version the (babylon) version of the module
  50879. * @param stable is that a stable version of this module
  50880. */
  50881. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  50882. /**
  50883. * Returns a constructor of a specific feature.
  50884. *
  50885. * @param featureName the name of the feature to construct
  50886. * @param version the version of the feature to load
  50887. * @param xrSessionManager the xrSessionManager. Used to construct the module
  50888. * @param options optional options provided to the module.
  50889. * @returns a function that, when called, will return a new instance of this feature
  50890. */
  50891. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  50892. /**
  50893. * Can be used to return the list of features currently registered
  50894. *
  50895. * @returns an Array of available features
  50896. */
  50897. static GetAvailableFeatures(): string[];
  50898. /**
  50899. * Gets the versions available for a specific feature
  50900. * @param featureName the name of the feature
  50901. * @returns an array with the available versions
  50902. */
  50903. static GetAvailableVersions(featureName: string): string[];
  50904. /**
  50905. * Return the latest unstable version of this feature
  50906. * @param featureName the name of the feature to search
  50907. * @returns the version number. if not found will return -1
  50908. */
  50909. static GetLatestVersionOfFeature(featureName: string): number;
  50910. /**
  50911. * Return the latest stable version of this feature
  50912. * @param featureName the name of the feature to search
  50913. * @returns the version number. if not found will return -1
  50914. */
  50915. static GetStableVersionOfFeature(featureName: string): number;
  50916. /**
  50917. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  50918. * Can be used during a session to start a feature
  50919. * @param featureName the name of feature to attach
  50920. */
  50921. attachFeature(featureName: string): void;
  50922. /**
  50923. * Can be used inside a session or when the session ends to detach a specific feature
  50924. * @param featureName the name of the feature to detach
  50925. */
  50926. detachFeature(featureName: string): void;
  50927. /**
  50928. * Used to disable an already-enabled feature
  50929. * The feature will be disposed and will be recreated once enabled.
  50930. * @param featureName the feature to disable
  50931. * @returns true if disable was successful
  50932. */
  50933. disableFeature(featureName: string | {
  50934. Name: string;
  50935. }): boolean;
  50936. /**
  50937. * dispose this features manager
  50938. */
  50939. dispose(): void;
  50940. /**
  50941. * Enable a feature using its name and a version. This will enable it in the scene, and will be responsible to attach it when the session starts.
  50942. * If used twice, the old version will be disposed and a new one will be constructed. This way you can re-enable with different configuration.
  50943. *
  50944. * @param featureName the name of the feature to load or the class of the feature
  50945. * @param version optional version to load. if not provided the latest version will be enabled
  50946. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  50947. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  50948. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  50949. * @returns a new constructed feature or throws an error if feature not found.
  50950. */
  50951. enableFeature(featureName: string | {
  50952. Name: string;
  50953. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  50954. /**
  50955. * get the implementation of an enabled feature.
  50956. * @param featureName the name of the feature to load
  50957. * @returns the feature class, if found
  50958. */
  50959. getEnabledFeature(featureName: string): IWebXRFeature;
  50960. /**
  50961. * Get the list of enabled features
  50962. * @returns an array of enabled features
  50963. */
  50964. getEnabledFeatures(): string[];
  50965. /**
  50966. * This function will exten the session creation configuration object with enabled features.
  50967. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  50968. * according to the defined "required" variable, provided during enableFeature call
  50969. * @param xrSessionInit the xr Session init object to extend
  50970. *
  50971. * @returns an extended XRSessionInit object
  50972. */
  50973. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  50974. }
  50975. }
  50976. declare module BABYLON {
  50977. /**
  50978. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  50979. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  50980. */
  50981. export class WebXRExperienceHelper implements IDisposable {
  50982. private scene;
  50983. private _nonVRCamera;
  50984. private _originalSceneAutoClear;
  50985. private _supported;
  50986. /**
  50987. * Camera used to render xr content
  50988. */
  50989. camera: WebXRCamera;
  50990. /** A features manager for this xr session */
  50991. featuresManager: WebXRFeaturesManager;
  50992. /**
  50993. * Observers registered here will be triggered after the camera's initial transformation is set
  50994. * This can be used to set a different ground level or an extra rotation.
  50995. *
  50996. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  50997. * to the position set after this observable is done executing.
  50998. */
  50999. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  51000. /**
  51001. * Fires when the state of the experience helper has changed
  51002. */
  51003. onStateChangedObservable: Observable<WebXRState>;
  51004. /** Session manager used to keep track of xr session */
  51005. sessionManager: WebXRSessionManager;
  51006. /**
  51007. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  51008. */
  51009. state: WebXRState;
  51010. /**
  51011. * Creates a WebXRExperienceHelper
  51012. * @param scene The scene the helper should be created in
  51013. */
  51014. private constructor();
  51015. /**
  51016. * Creates the experience helper
  51017. * @param scene the scene to attach the experience helper to
  51018. * @returns a promise for the experience helper
  51019. */
  51020. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  51021. /**
  51022. * Disposes of the experience helper
  51023. */
  51024. dispose(): void;
  51025. /**
  51026. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  51027. * @param sessionMode options for the XR session
  51028. * @param referenceSpaceType frame of reference of the XR session
  51029. * @param renderTarget the output canvas that will be used to enter XR mode
  51030. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  51031. * @returns promise that resolves after xr mode has entered
  51032. */
  51033. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  51034. /**
  51035. * Exits XR mode and returns the scene to its original state
  51036. * @returns promise that resolves after xr mode has exited
  51037. */
  51038. exitXRAsync(): Promise<void>;
  51039. private _nonXRToXRCamera;
  51040. private _setState;
  51041. }
  51042. }
  51043. declare module BABYLON {
  51044. /**
  51045. * X-Y values for axes in WebXR
  51046. */
  51047. export interface IWebXRMotionControllerAxesValue {
  51048. /**
  51049. * The value of the x axis
  51050. */
  51051. x: number;
  51052. /**
  51053. * The value of the y-axis
  51054. */
  51055. y: number;
  51056. }
  51057. /**
  51058. * changed / previous values for the values of this component
  51059. */
  51060. export interface IWebXRMotionControllerComponentChangesValues<T> {
  51061. /**
  51062. * current (this frame) value
  51063. */
  51064. current: T;
  51065. /**
  51066. * previous (last change) value
  51067. */
  51068. previous: T;
  51069. }
  51070. /**
  51071. * Represents changes in the component between current frame and last values recorded
  51072. */
  51073. export interface IWebXRMotionControllerComponentChanges {
  51074. /**
  51075. * will be populated with previous and current values if axes changed
  51076. */
  51077. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  51078. /**
  51079. * will be populated with previous and current values if pressed changed
  51080. */
  51081. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  51082. /**
  51083. * will be populated with previous and current values if touched changed
  51084. */
  51085. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  51086. /**
  51087. * will be populated with previous and current values if value changed
  51088. */
  51089. value?: IWebXRMotionControllerComponentChangesValues<number>;
  51090. }
  51091. /**
  51092. * This class represents a single component (for example button or thumbstick) of a motion controller
  51093. */
  51094. export class WebXRControllerComponent implements IDisposable {
  51095. /**
  51096. * the id of this component
  51097. */
  51098. id: string;
  51099. /**
  51100. * the type of the component
  51101. */
  51102. type: MotionControllerComponentType;
  51103. private _buttonIndex;
  51104. private _axesIndices;
  51105. private _axes;
  51106. private _changes;
  51107. private _currentValue;
  51108. private _hasChanges;
  51109. private _pressed;
  51110. private _touched;
  51111. /**
  51112. * button component type
  51113. */
  51114. static BUTTON_TYPE: MotionControllerComponentType;
  51115. /**
  51116. * squeeze component type
  51117. */
  51118. static SQUEEZE_TYPE: MotionControllerComponentType;
  51119. /**
  51120. * Thumbstick component type
  51121. */
  51122. static THUMBSTICK_TYPE: MotionControllerComponentType;
  51123. /**
  51124. * Touchpad component type
  51125. */
  51126. static TOUCHPAD_TYPE: MotionControllerComponentType;
  51127. /**
  51128. * trigger component type
  51129. */
  51130. static TRIGGER_TYPE: MotionControllerComponentType;
  51131. /**
  51132. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  51133. * the axes data changes
  51134. */
  51135. onAxisValueChangedObservable: Observable<{
  51136. x: number;
  51137. y: number;
  51138. }>;
  51139. /**
  51140. * Observers registered here will be triggered when the state of a button changes
  51141. * State change is either pressed / touched / value
  51142. */
  51143. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  51144. /**
  51145. * Creates a new component for a motion controller.
  51146. * It is created by the motion controller itself
  51147. *
  51148. * @param id the id of this component
  51149. * @param type the type of the component
  51150. * @param _buttonIndex index in the buttons array of the gamepad
  51151. * @param _axesIndices indices of the values in the axes array of the gamepad
  51152. */
  51153. constructor(
  51154. /**
  51155. * the id of this component
  51156. */
  51157. id: string,
  51158. /**
  51159. * the type of the component
  51160. */
  51161. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  51162. /**
  51163. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  51164. */
  51165. get axes(): IWebXRMotionControllerAxesValue;
  51166. /**
  51167. * Get the changes. Elements will be populated only if they changed with their previous and current value
  51168. */
  51169. get changes(): IWebXRMotionControllerComponentChanges;
  51170. /**
  51171. * Return whether or not the component changed the last frame
  51172. */
  51173. get hasChanges(): boolean;
  51174. /**
  51175. * is the button currently pressed
  51176. */
  51177. get pressed(): boolean;
  51178. /**
  51179. * is the button currently touched
  51180. */
  51181. get touched(): boolean;
  51182. /**
  51183. * Get the current value of this component
  51184. */
  51185. get value(): number;
  51186. /**
  51187. * Dispose this component
  51188. */
  51189. dispose(): void;
  51190. /**
  51191. * Are there axes correlating to this component
  51192. * @return true is axes data is available
  51193. */
  51194. isAxes(): boolean;
  51195. /**
  51196. * Is this component a button (hence - pressable)
  51197. * @returns true if can be pressed
  51198. */
  51199. isButton(): boolean;
  51200. /**
  51201. * update this component using the gamepad object it is in. Called on every frame
  51202. * @param nativeController the native gamepad controller object
  51203. */
  51204. update(nativeController: IMinimalMotionControllerObject): void;
  51205. }
  51206. }
  51207. declare module BABYLON {
  51208. /**
  51209. * Interface used to represent data loading progression
  51210. */
  51211. export interface ISceneLoaderProgressEvent {
  51212. /**
  51213. * Defines if data length to load can be evaluated
  51214. */
  51215. readonly lengthComputable: boolean;
  51216. /**
  51217. * Defines the loaded data length
  51218. */
  51219. readonly loaded: number;
  51220. /**
  51221. * Defines the data length to load
  51222. */
  51223. readonly total: number;
  51224. }
  51225. /**
  51226. * Interface used by SceneLoader plugins to define supported file extensions
  51227. */
  51228. export interface ISceneLoaderPluginExtensions {
  51229. /**
  51230. * Defines the list of supported extensions
  51231. */
  51232. [extension: string]: {
  51233. isBinary: boolean;
  51234. };
  51235. }
  51236. /**
  51237. * Interface used by SceneLoader plugin factory
  51238. */
  51239. export interface ISceneLoaderPluginFactory {
  51240. /**
  51241. * Defines the name of the factory
  51242. */
  51243. name: string;
  51244. /**
  51245. * Function called to create a new plugin
  51246. * @return the new plugin
  51247. */
  51248. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  51249. /**
  51250. * The callback that returns true if the data can be directly loaded.
  51251. * @param data string containing the file data
  51252. * @returns if the data can be loaded directly
  51253. */
  51254. canDirectLoad?(data: string): boolean;
  51255. }
  51256. /**
  51257. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  51258. */
  51259. export interface ISceneLoaderPluginBase {
  51260. /**
  51261. * The friendly name of this plugin.
  51262. */
  51263. name: string;
  51264. /**
  51265. * The file extensions supported by this plugin.
  51266. */
  51267. extensions: string | ISceneLoaderPluginExtensions;
  51268. /**
  51269. * The callback called when loading from a url.
  51270. * @param scene scene loading this url
  51271. * @param url url to load
  51272. * @param onSuccess callback called when the file successfully loads
  51273. * @param onProgress callback called while file is loading (if the server supports this mode)
  51274. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  51275. * @param onError callback called when the file fails to load
  51276. * @returns a file request object
  51277. */
  51278. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  51279. /**
  51280. * The callback called when loading from a file object.
  51281. * @param scene scene loading this file
  51282. * @param file defines the file to load
  51283. * @param onSuccess defines the callback to call when data is loaded
  51284. * @param onProgress defines the callback to call during loading process
  51285. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  51286. * @param onError defines the callback to call when an error occurs
  51287. * @returns a file request object
  51288. */
  51289. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  51290. /**
  51291. * The callback that returns true if the data can be directly loaded.
  51292. * @param data string containing the file data
  51293. * @returns if the data can be loaded directly
  51294. */
  51295. canDirectLoad?(data: string): boolean;
  51296. /**
  51297. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  51298. * @param scene scene loading this data
  51299. * @param data string containing the data
  51300. * @returns data to pass to the plugin
  51301. */
  51302. directLoad?(scene: Scene, data: string): any;
  51303. /**
  51304. * The callback that allows custom handling of the root url based on the response url.
  51305. * @param rootUrl the original root url
  51306. * @param responseURL the response url if available
  51307. * @returns the new root url
  51308. */
  51309. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  51310. }
  51311. /**
  51312. * Interface used to define a SceneLoader plugin
  51313. */
  51314. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  51315. /**
  51316. * Import meshes into a scene.
  51317. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  51318. * @param scene The scene to import into
  51319. * @param data The data to import
  51320. * @param rootUrl The root url for scene and resources
  51321. * @param meshes The meshes array to import into
  51322. * @param particleSystems The particle systems array to import into
  51323. * @param skeletons The skeletons array to import into
  51324. * @param onError The callback when import fails
  51325. * @returns True if successful or false otherwise
  51326. */
  51327. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  51328. /**
  51329. * Load into a scene.
  51330. * @param scene The scene to load into
  51331. * @param data The data to import
  51332. * @param rootUrl The root url for scene and resources
  51333. * @param onError The callback when import fails
  51334. * @returns True if successful or false otherwise
  51335. */
  51336. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  51337. /**
  51338. * Load into an asset container.
  51339. * @param scene The scene to load into
  51340. * @param data The data to import
  51341. * @param rootUrl The root url for scene and resources
  51342. * @param onError The callback when import fails
  51343. * @returns The loaded asset container
  51344. */
  51345. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  51346. }
  51347. /**
  51348. * Interface used to define an async SceneLoader plugin
  51349. */
  51350. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  51351. /**
  51352. * Import meshes into a scene.
  51353. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  51354. * @param scene The scene to import into
  51355. * @param data The data to import
  51356. * @param rootUrl The root url for scene and resources
  51357. * @param onProgress The callback when the load progresses
  51358. * @param fileName Defines the name of the file to load
  51359. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  51360. */
  51361. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  51362. meshes: AbstractMesh[];
  51363. particleSystems: IParticleSystem[];
  51364. skeletons: Skeleton[];
  51365. animationGroups: AnimationGroup[];
  51366. }>;
  51367. /**
  51368. * Load into a scene.
  51369. * @param scene The scene to load into
  51370. * @param data The data to import
  51371. * @param rootUrl The root url for scene and resources
  51372. * @param onProgress The callback when the load progresses
  51373. * @param fileName Defines the name of the file to load
  51374. * @returns Nothing
  51375. */
  51376. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  51377. /**
  51378. * Load into an asset container.
  51379. * @param scene The scene to load into
  51380. * @param data The data to import
  51381. * @param rootUrl The root url for scene and resources
  51382. * @param onProgress The callback when the load progresses
  51383. * @param fileName Defines the name of the file to load
  51384. * @returns The loaded asset container
  51385. */
  51386. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  51387. }
  51388. /**
  51389. * Mode that determines how to handle old animation groups before loading new ones.
  51390. */
  51391. export enum SceneLoaderAnimationGroupLoadingMode {
  51392. /**
  51393. * Reset all old animations to initial state then dispose them.
  51394. */
  51395. Clean = 0,
  51396. /**
  51397. * Stop all old animations.
  51398. */
  51399. Stop = 1,
  51400. /**
  51401. * Restart old animations from first frame.
  51402. */
  51403. Sync = 2,
  51404. /**
  51405. * Old animations remains untouched.
  51406. */
  51407. NoSync = 3
  51408. }
  51409. /**
  51410. * Defines a plugin registered by the SceneLoader
  51411. */
  51412. interface IRegisteredPlugin {
  51413. /**
  51414. * Defines the plugin to use
  51415. */
  51416. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  51417. /**
  51418. * Defines if the plugin supports binary data
  51419. */
  51420. isBinary: boolean;
  51421. }
  51422. /**
  51423. * Class used to load scene from various file formats using registered plugins
  51424. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  51425. */
  51426. export class SceneLoader {
  51427. /**
  51428. * No logging while loading
  51429. */
  51430. static readonly NO_LOGGING: number;
  51431. /**
  51432. * Minimal logging while loading
  51433. */
  51434. static readonly MINIMAL_LOGGING: number;
  51435. /**
  51436. * Summary logging while loading
  51437. */
  51438. static readonly SUMMARY_LOGGING: number;
  51439. /**
  51440. * Detailled logging while loading
  51441. */
  51442. static readonly DETAILED_LOGGING: number;
  51443. /**
  51444. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  51445. */
  51446. static get ForceFullSceneLoadingForIncremental(): boolean;
  51447. static set ForceFullSceneLoadingForIncremental(value: boolean);
  51448. /**
  51449. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  51450. */
  51451. static get ShowLoadingScreen(): boolean;
  51452. static set ShowLoadingScreen(value: boolean);
  51453. /**
  51454. * Defines the current logging level (while loading the scene)
  51455. * @ignorenaming
  51456. */
  51457. static get loggingLevel(): number;
  51458. static set loggingLevel(value: number);
  51459. /**
  51460. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  51461. */
  51462. static get CleanBoneMatrixWeights(): boolean;
  51463. static set CleanBoneMatrixWeights(value: boolean);
  51464. /**
  51465. * Event raised when a plugin is used to load a scene
  51466. */
  51467. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  51468. private static _registeredPlugins;
  51469. private static _showingLoadingScreen;
  51470. /**
  51471. * Gets the default plugin (used to load Babylon files)
  51472. * @returns the .babylon plugin
  51473. */
  51474. static GetDefaultPlugin(): IRegisteredPlugin;
  51475. private static _GetPluginForExtension;
  51476. private static _GetPluginForDirectLoad;
  51477. private static _GetPluginForFilename;
  51478. private static _GetDirectLoad;
  51479. private static _LoadData;
  51480. private static _GetFileInfo;
  51481. /**
  51482. * Gets a plugin that can load the given extension
  51483. * @param extension defines the extension to load
  51484. * @returns a plugin or null if none works
  51485. */
  51486. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  51487. /**
  51488. * Gets a boolean indicating that the given extension can be loaded
  51489. * @param extension defines the extension to load
  51490. * @returns true if the extension is supported
  51491. */
  51492. static IsPluginForExtensionAvailable(extension: string): boolean;
  51493. /**
  51494. * Adds a new plugin to the list of registered plugins
  51495. * @param plugin defines the plugin to add
  51496. */
  51497. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  51498. /**
  51499. * Import meshes into a scene
  51500. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  51501. * @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)
  51502. * @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)
  51503. * @param scene the instance of BABYLON.Scene to append to
  51504. * @param onSuccess a callback with a list of imported meshes, particleSystems, skeletons, and animationGroups when import succeeds
  51505. * @param onProgress a callback with a progress event for each file being loaded
  51506. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  51507. * @param pluginExtension the extension used to determine the plugin
  51508. * @returns The loaded plugin
  51509. */
  51510. static ImportMesh(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], animationGroups: AnimationGroup[]) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  51511. /**
  51512. * Import meshes into a scene
  51513. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  51514. * @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)
  51515. * @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)
  51516. * @param scene the instance of BABYLON.Scene to append to
  51517. * @param onProgress a callback with a progress event for each file being loaded
  51518. * @param pluginExtension the extension used to determine the plugin
  51519. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  51520. */
  51521. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  51522. meshes: AbstractMesh[];
  51523. particleSystems: IParticleSystem[];
  51524. skeletons: Skeleton[];
  51525. animationGroups: AnimationGroup[];
  51526. }>;
  51527. /**
  51528. * Load a scene
  51529. * @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)
  51530. * @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)
  51531. * @param engine is the instance of BABYLON.Engine to use to create the scene
  51532. * @param onSuccess a callback with the scene when import succeeds
  51533. * @param onProgress a callback with a progress event for each file being loaded
  51534. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  51535. * @param pluginExtension the extension used to determine the plugin
  51536. * @returns The loaded plugin
  51537. */
  51538. static Load(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  51539. /**
  51540. * Load a scene
  51541. * @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)
  51542. * @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)
  51543. * @param engine is the instance of BABYLON.Engine to use to create the scene
  51544. * @param onProgress a callback with a progress event for each file being loaded
  51545. * @param pluginExtension the extension used to determine the plugin
  51546. * @returns The loaded scene
  51547. */
  51548. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  51549. /**
  51550. * Append a scene
  51551. * @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)
  51552. * @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)
  51553. * @param scene is the instance of BABYLON.Scene to append to
  51554. * @param onSuccess a callback with the scene when import succeeds
  51555. * @param onProgress a callback with a progress event for each file being loaded
  51556. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  51557. * @param pluginExtension the extension used to determine the plugin
  51558. * @returns The loaded plugin
  51559. */
  51560. static Append(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  51561. /**
  51562. * Append a scene
  51563. * @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)
  51564. * @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)
  51565. * @param scene is the instance of BABYLON.Scene to append to
  51566. * @param onProgress a callback with a progress event for each file being loaded
  51567. * @param pluginExtension the extension used to determine the plugin
  51568. * @returns The given scene
  51569. */
  51570. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  51571. /**
  51572. * Load a scene into an asset container
  51573. * @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)
  51574. * @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)
  51575. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  51576. * @param onSuccess a callback with the scene when import succeeds
  51577. * @param onProgress a callback with a progress event for each file being loaded
  51578. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  51579. * @param pluginExtension the extension used to determine the plugin
  51580. * @returns The loaded plugin
  51581. */
  51582. static LoadAssetContainer(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(assets: AssetContainer) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  51583. /**
  51584. * Load a scene into an asset container
  51585. * @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)
  51586. * @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)
  51587. * @param scene is the instance of Scene to append to
  51588. * @param onProgress a callback with a progress event for each file being loaded
  51589. * @param pluginExtension the extension used to determine the plugin
  51590. * @returns The loaded asset container
  51591. */
  51592. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  51593. /**
  51594. * Import animations from a file into a scene
  51595. * @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)
  51596. * @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)
  51597. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  51598. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  51599. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  51600. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  51601. * @param onSuccess a callback with the scene when import succeeds
  51602. * @param onProgress a callback with a progress event for each file being loaded
  51603. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  51604. * @param pluginExtension the extension used to determine the plugin
  51605. */
  51606. static ImportAnimations(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, overwriteAnimations?: boolean, animationGroupLoadingMode?: SceneLoaderAnimationGroupLoadingMode, targetConverter?: Nullable<(target: any) => any>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): void;
  51607. /**
  51608. * Import animations from a file into a scene
  51609. * @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)
  51610. * @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)
  51611. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  51612. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  51613. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  51614. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  51615. * @param onSuccess a callback with the scene when import succeeds
  51616. * @param onProgress a callback with a progress event for each file being loaded
  51617. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  51618. * @param pluginExtension the extension used to determine the plugin
  51619. * @returns the updated scene with imported animations
  51620. */
  51621. static ImportAnimationsAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, overwriteAnimations?: boolean, animationGroupLoadingMode?: SceneLoaderAnimationGroupLoadingMode, targetConverter?: Nullable<(target: any) => any>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  51622. }
  51623. }
  51624. declare module BABYLON {
  51625. /**
  51626. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  51627. */
  51628. export type MotionControllerHandedness = "none" | "left" | "right";
  51629. /**
  51630. * The type of components available in motion controllers.
  51631. * This is not the name of the component.
  51632. */
  51633. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  51634. /**
  51635. * The state of a controller component
  51636. */
  51637. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  51638. /**
  51639. * The schema of motion controller layout.
  51640. * No object will be initialized using this interface
  51641. * This is used just to define the profile.
  51642. */
  51643. export interface IMotionControllerLayout {
  51644. /**
  51645. * Path to load the assets. Usually relative to the base path
  51646. */
  51647. assetPath: string;
  51648. /**
  51649. * Available components (unsorted)
  51650. */
  51651. components: {
  51652. /**
  51653. * A map of component Ids
  51654. */
  51655. [componentId: string]: {
  51656. /**
  51657. * The type of input the component outputs
  51658. */
  51659. type: MotionControllerComponentType;
  51660. /**
  51661. * The indices of this component in the gamepad object
  51662. */
  51663. gamepadIndices: {
  51664. /**
  51665. * Index of button
  51666. */
  51667. button?: number;
  51668. /**
  51669. * If available, index of x-axis
  51670. */
  51671. xAxis?: number;
  51672. /**
  51673. * If available, index of y-axis
  51674. */
  51675. yAxis?: number;
  51676. };
  51677. /**
  51678. * The mesh's root node name
  51679. */
  51680. rootNodeName: string;
  51681. /**
  51682. * Animation definitions for this model
  51683. */
  51684. visualResponses: {
  51685. [stateKey: string]: {
  51686. /**
  51687. * What property will be animated
  51688. */
  51689. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  51690. /**
  51691. * What states influence this visual response
  51692. */
  51693. states: MotionControllerComponentStateType[];
  51694. /**
  51695. * Type of animation - movement or visibility
  51696. */
  51697. valueNodeProperty: "transform" | "visibility";
  51698. /**
  51699. * Base node name to move. Its position will be calculated according to the min and max nodes
  51700. */
  51701. valueNodeName?: string;
  51702. /**
  51703. * Minimum movement node
  51704. */
  51705. minNodeName?: string;
  51706. /**
  51707. * Max movement node
  51708. */
  51709. maxNodeName?: string;
  51710. };
  51711. };
  51712. /**
  51713. * If touch enabled, what is the name of node to display user feedback
  51714. */
  51715. touchPointNodeName?: string;
  51716. };
  51717. };
  51718. /**
  51719. * Is it xr standard mapping or not
  51720. */
  51721. gamepadMapping: "" | "xr-standard";
  51722. /**
  51723. * Base root node of this entire model
  51724. */
  51725. rootNodeName: string;
  51726. /**
  51727. * Defines the main button component id
  51728. */
  51729. selectComponentId: string;
  51730. }
  51731. /**
  51732. * A definition for the layout map in the input profile
  51733. */
  51734. export interface IMotionControllerLayoutMap {
  51735. /**
  51736. * Layouts with handedness type as a key
  51737. */
  51738. [handedness: string]: IMotionControllerLayout;
  51739. }
  51740. /**
  51741. * The XR Input profile schema
  51742. * Profiles can be found here:
  51743. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  51744. */
  51745. export interface IMotionControllerProfile {
  51746. /**
  51747. * fallback profiles for this profileId
  51748. */
  51749. fallbackProfileIds: string[];
  51750. /**
  51751. * The layout map, with handedness as key
  51752. */
  51753. layouts: IMotionControllerLayoutMap;
  51754. /**
  51755. * The id of this profile
  51756. * correlates to the profile(s) in the xrInput.profiles array
  51757. */
  51758. profileId: string;
  51759. }
  51760. /**
  51761. * A helper-interface for the 3 meshes needed for controller button animation
  51762. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  51763. */
  51764. export interface IMotionControllerButtonMeshMap {
  51765. /**
  51766. * the mesh that defines the pressed value mesh position.
  51767. * This is used to find the max-position of this button
  51768. */
  51769. pressedMesh: AbstractMesh;
  51770. /**
  51771. * the mesh that defines the unpressed value mesh position.
  51772. * This is used to find the min (or initial) position of this button
  51773. */
  51774. unpressedMesh: AbstractMesh;
  51775. /**
  51776. * The mesh that will be changed when value changes
  51777. */
  51778. valueMesh: AbstractMesh;
  51779. }
  51780. /**
  51781. * A helper-interface for the 3 meshes needed for controller axis animation.
  51782. * This will be expanded when touchpad animations are fully supported
  51783. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  51784. */
  51785. export interface IMotionControllerMeshMap {
  51786. /**
  51787. * the mesh that defines the maximum value mesh position.
  51788. */
  51789. maxMesh?: AbstractMesh;
  51790. /**
  51791. * the mesh that defines the minimum value mesh position.
  51792. */
  51793. minMesh?: AbstractMesh;
  51794. /**
  51795. * The mesh that will be changed when axis value changes
  51796. */
  51797. valueMesh?: AbstractMesh;
  51798. }
  51799. /**
  51800. * The elements needed for change-detection of the gamepad objects in motion controllers
  51801. */
  51802. export interface IMinimalMotionControllerObject {
  51803. /**
  51804. * Available axes of this controller
  51805. */
  51806. axes: number[];
  51807. /**
  51808. * An array of available buttons
  51809. */
  51810. buttons: Array<{
  51811. /**
  51812. * Value of the button/trigger
  51813. */
  51814. value: number;
  51815. /**
  51816. * If the button/trigger is currently touched
  51817. */
  51818. touched: boolean;
  51819. /**
  51820. * If the button/trigger is currently pressed
  51821. */
  51822. pressed: boolean;
  51823. }>;
  51824. /**
  51825. * EXPERIMENTAL haptic support.
  51826. */
  51827. hapticActuators?: Array<{
  51828. pulse: (value: number, duration: number) => Promise<boolean>;
  51829. }>;
  51830. }
  51831. /**
  51832. * An Abstract Motion controller
  51833. * This class receives an xrInput and a profile layout and uses those to initialize the components
  51834. * Each component has an observable to check for changes in value and state
  51835. */
  51836. export abstract class WebXRAbstractMotionController implements IDisposable {
  51837. protected scene: Scene;
  51838. protected layout: IMotionControllerLayout;
  51839. /**
  51840. * The gamepad object correlating to this controller
  51841. */
  51842. gamepadObject: IMinimalMotionControllerObject;
  51843. /**
  51844. * handedness (left/right/none) of this controller
  51845. */
  51846. handedness: MotionControllerHandedness;
  51847. private _initComponent;
  51848. private _modelReady;
  51849. /**
  51850. * A map of components (WebXRControllerComponent) in this motion controller
  51851. * Components have a ComponentType and can also have both button and axis definitions
  51852. */
  51853. readonly components: {
  51854. [id: string]: WebXRControllerComponent;
  51855. };
  51856. /**
  51857. * Disable the model's animation. Can be set at any time.
  51858. */
  51859. disableAnimation: boolean;
  51860. /**
  51861. * Observers registered here will be triggered when the model of this controller is done loading
  51862. */
  51863. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  51864. /**
  51865. * The profile id of this motion controller
  51866. */
  51867. abstract profileId: string;
  51868. /**
  51869. * The root mesh of the model. It is null if the model was not yet initialized
  51870. */
  51871. rootMesh: Nullable<AbstractMesh>;
  51872. /**
  51873. * constructs a new abstract motion controller
  51874. * @param scene the scene to which the model of the controller will be added
  51875. * @param layout The profile layout to load
  51876. * @param gamepadObject The gamepad object correlating to this controller
  51877. * @param handedness handedness (left/right/none) of this controller
  51878. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  51879. */
  51880. constructor(scene: Scene, layout: IMotionControllerLayout,
  51881. /**
  51882. * The gamepad object correlating to this controller
  51883. */
  51884. gamepadObject: IMinimalMotionControllerObject,
  51885. /**
  51886. * handedness (left/right/none) of this controller
  51887. */
  51888. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  51889. /**
  51890. * Dispose this controller, the model mesh and all its components
  51891. */
  51892. dispose(): void;
  51893. /**
  51894. * Returns all components of specific type
  51895. * @param type the type to search for
  51896. * @return an array of components with this type
  51897. */
  51898. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  51899. /**
  51900. * get a component based an its component id as defined in layout.components
  51901. * @param id the id of the component
  51902. * @returns the component correlates to the id or undefined if not found
  51903. */
  51904. getComponent(id: string): WebXRControllerComponent;
  51905. /**
  51906. * Get the list of components available in this motion controller
  51907. * @returns an array of strings correlating to available components
  51908. */
  51909. getComponentIds(): string[];
  51910. /**
  51911. * Get the first component of specific type
  51912. * @param type type of component to find
  51913. * @return a controller component or null if not found
  51914. */
  51915. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  51916. /**
  51917. * Get the main (Select) component of this controller as defined in the layout
  51918. * @returns the main component of this controller
  51919. */
  51920. getMainComponent(): WebXRControllerComponent;
  51921. /**
  51922. * Loads the model correlating to this controller
  51923. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  51924. * @returns A promise fulfilled with the result of the model loading
  51925. */
  51926. loadModel(): Promise<boolean>;
  51927. /**
  51928. * Update this model using the current XRFrame
  51929. * @param xrFrame the current xr frame to use and update the model
  51930. */
  51931. updateFromXRFrame(xrFrame: XRFrame): void;
  51932. /**
  51933. * Backwards compatibility due to a deeply-integrated typo
  51934. */
  51935. get handness(): XREye;
  51936. /**
  51937. * Pulse (vibrate) this controller
  51938. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  51939. * Consecutive calls to this function will cancel the last pulse call
  51940. *
  51941. * @param value the strength of the pulse in 0.0...1.0 range
  51942. * @param duration Duration of the pulse in milliseconds
  51943. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  51944. * @returns a promise that will send true when the pulse has ended and false if the device doesn't support pulse or an error accrued
  51945. */
  51946. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  51947. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  51948. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  51949. /**
  51950. * Moves the axis on the controller mesh based on its current state
  51951. * @param axis the index of the axis
  51952. * @param axisValue the value of the axis which determines the meshes new position
  51953. * @hidden
  51954. */
  51955. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  51956. /**
  51957. * Update the model itself with the current frame data
  51958. * @param xrFrame the frame to use for updating the model mesh
  51959. */
  51960. protected updateModel(xrFrame: XRFrame): void;
  51961. /**
  51962. * Get the filename and path for this controller's model
  51963. * @returns a map of filename and path
  51964. */
  51965. protected abstract _getFilenameAndPath(): {
  51966. filename: string;
  51967. path: string;
  51968. };
  51969. /**
  51970. * This function is called before the mesh is loaded. It checks for loading constraints.
  51971. * For example, this function can check if the GLB loader is available
  51972. * If this function returns false, the generic controller will be loaded instead
  51973. * @returns Is the client ready to load the mesh
  51974. */
  51975. protected abstract _getModelLoadingConstraints(): boolean;
  51976. /**
  51977. * This function will be called after the model was successfully loaded and can be used
  51978. * for mesh transformations before it is available for the user
  51979. * @param meshes the loaded meshes
  51980. */
  51981. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  51982. /**
  51983. * Set the root mesh for this controller. Important for the WebXR controller class
  51984. * @param meshes the loaded meshes
  51985. */
  51986. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  51987. /**
  51988. * A function executed each frame that updates the mesh (if needed)
  51989. * @param xrFrame the current xrFrame
  51990. */
  51991. protected abstract _updateModel(xrFrame: XRFrame): void;
  51992. private _getGenericFilenameAndPath;
  51993. private _getGenericParentMesh;
  51994. }
  51995. }
  51996. declare module BABYLON {
  51997. /**
  51998. * A generic trigger-only motion controller for WebXR
  51999. */
  52000. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  52001. /**
  52002. * Static version of the profile id of this controller
  52003. */
  52004. static ProfileId: string;
  52005. profileId: string;
  52006. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  52007. protected _getFilenameAndPath(): {
  52008. filename: string;
  52009. path: string;
  52010. };
  52011. protected _getModelLoadingConstraints(): boolean;
  52012. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  52013. protected _setRootMesh(meshes: AbstractMesh[]): void;
  52014. protected _updateModel(): void;
  52015. }
  52016. }
  52017. declare module BABYLON {
  52018. /**
  52019. * Class containing static functions to help procedurally build meshes
  52020. */
  52021. export class SphereBuilder {
  52022. /**
  52023. * Creates a sphere mesh
  52024. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  52025. * * 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`)
  52026. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  52027. * * 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
  52028. * * 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)
  52029. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52030. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  52031. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52032. * @param name defines the name of the mesh
  52033. * @param options defines the options used to create the mesh
  52034. * @param scene defines the hosting scene
  52035. * @returns the sphere mesh
  52036. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  52037. */
  52038. static CreateSphere(name: string, options: {
  52039. segments?: number;
  52040. diameter?: number;
  52041. diameterX?: number;
  52042. diameterY?: number;
  52043. diameterZ?: number;
  52044. arc?: number;
  52045. slice?: number;
  52046. sideOrientation?: number;
  52047. frontUVs?: Vector4;
  52048. backUVs?: Vector4;
  52049. updatable?: boolean;
  52050. }, scene?: Nullable<Scene>): Mesh;
  52051. }
  52052. }
  52053. declare module BABYLON {
  52054. /**
  52055. * A profiled motion controller has its profile loaded from an online repository.
  52056. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  52057. */
  52058. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  52059. private _repositoryUrl;
  52060. private _buttonMeshMapping;
  52061. private _touchDots;
  52062. /**
  52063. * The profile ID of this controller. Will be populated when the controller initializes.
  52064. */
  52065. profileId: string;
  52066. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  52067. dispose(): void;
  52068. protected _getFilenameAndPath(): {
  52069. filename: string;
  52070. path: string;
  52071. };
  52072. protected _getModelLoadingConstraints(): boolean;
  52073. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  52074. protected _setRootMesh(meshes: AbstractMesh[]): void;
  52075. protected _updateModel(_xrFrame: XRFrame): void;
  52076. }
  52077. }
  52078. declare module BABYLON {
  52079. /**
  52080. * A construction function type to create a new controller based on an xrInput object
  52081. */
  52082. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  52083. /**
  52084. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  52085. *
  52086. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  52087. * it should be replaced with auto-loaded controllers.
  52088. *
  52089. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  52090. */
  52091. export class WebXRMotionControllerManager {
  52092. private static _AvailableControllers;
  52093. private static _Fallbacks;
  52094. private static _ProfileLoadingPromises;
  52095. private static _ProfilesList;
  52096. /**
  52097. * The base URL of the online controller repository. Can be changed at any time.
  52098. */
  52099. static BaseRepositoryUrl: string;
  52100. /**
  52101. * Which repository gets priority - local or online
  52102. */
  52103. static PrioritizeOnlineRepository: boolean;
  52104. /**
  52105. * Use the online repository, or use only locally-defined controllers
  52106. */
  52107. static UseOnlineRepository: boolean;
  52108. /**
  52109. * Clear the cache used for profile loading and reload when requested again
  52110. */
  52111. static ClearProfilesCache(): void;
  52112. /**
  52113. * Register the default fallbacks.
  52114. * This function is called automatically when this file is imported.
  52115. */
  52116. static DefaultFallbacks(): void;
  52117. /**
  52118. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  52119. * @param profileId the profile to which a fallback needs to be found
  52120. * @return an array with corresponding fallback profiles
  52121. */
  52122. static FindFallbackWithProfileId(profileId: string): string[];
  52123. /**
  52124. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  52125. * The order of search:
  52126. *
  52127. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  52128. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  52129. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  52130. * 4) return the generic trigger controller if none were found
  52131. *
  52132. * @param xrInput the xrInput to which a new controller is initialized
  52133. * @param scene the scene to which the model will be added
  52134. * @param forceProfile force a certain profile for this controller
  52135. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  52136. */
  52137. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  52138. /**
  52139. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  52140. *
  52141. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  52142. *
  52143. * @param type the profile type to register
  52144. * @param constructFunction the function to be called when loading this profile
  52145. */
  52146. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  52147. /**
  52148. * Register a fallback to a specific profile.
  52149. * @param profileId the profileId that will receive the fallbacks
  52150. * @param fallbacks A list of fallback profiles
  52151. */
  52152. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  52153. /**
  52154. * Will update the list of profiles available in the repository
  52155. * @return a promise that resolves to a map of profiles available online
  52156. */
  52157. static UpdateProfilesList(): Promise<{
  52158. [profile: string]: string;
  52159. }>;
  52160. private static _LoadProfileFromRepository;
  52161. private static _LoadProfilesFromAvailableControllers;
  52162. }
  52163. }
  52164. declare module BABYLON {
  52165. /**
  52166. * Configuration options for the WebXR controller creation
  52167. */
  52168. export interface IWebXRControllerOptions {
  52169. /**
  52170. * Should the controller mesh be animated when a user interacts with it
  52171. * The pressed buttons / thumbstick and touchpad animations will be disabled
  52172. */
  52173. disableMotionControllerAnimation?: boolean;
  52174. /**
  52175. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  52176. */
  52177. doNotLoadControllerMesh?: boolean;
  52178. /**
  52179. * Force a specific controller type for this controller.
  52180. * This can be used when creating your own profile or when testing different controllers
  52181. */
  52182. forceControllerProfile?: string;
  52183. /**
  52184. * Defines a rendering group ID for meshes that will be loaded.
  52185. * This is for the default controllers only.
  52186. */
  52187. renderingGroupId?: number;
  52188. }
  52189. /**
  52190. * Represents an XR controller
  52191. */
  52192. export class WebXRInputSource {
  52193. private _scene;
  52194. /** The underlying input source for the controller */
  52195. inputSource: XRInputSource;
  52196. private _options;
  52197. private _tmpVector;
  52198. private _uniqueId;
  52199. private _disposed;
  52200. /**
  52201. * 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
  52202. */
  52203. grip?: AbstractMesh;
  52204. /**
  52205. * If available, this is the gamepad object related to this controller.
  52206. * Using this object it is possible to get click events and trackpad changes of the
  52207. * webxr controller that is currently being used.
  52208. */
  52209. motionController?: WebXRAbstractMotionController;
  52210. /**
  52211. * Event that fires when the controller is removed/disposed.
  52212. * The object provided as event data is this controller, after associated assets were disposed.
  52213. * uniqueId is still available.
  52214. */
  52215. onDisposeObservable: Observable<WebXRInputSource>;
  52216. /**
  52217. * Will be triggered when the mesh associated with the motion controller is done loading.
  52218. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  52219. * A shortened version of controller -> motion controller -> on mesh loaded.
  52220. */
  52221. onMeshLoadedObservable: Observable<AbstractMesh>;
  52222. /**
  52223. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  52224. */
  52225. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  52226. /**
  52227. * Pointer which can be used to select objects or attach a visible laser to
  52228. */
  52229. pointer: AbstractMesh;
  52230. /**
  52231. * Creates the input source object
  52232. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  52233. * @param _scene the scene which the controller should be associated to
  52234. * @param inputSource the underlying input source for the controller
  52235. * @param _options options for this controller creation
  52236. */
  52237. constructor(_scene: Scene,
  52238. /** The underlying input source for the controller */
  52239. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  52240. /**
  52241. * Get this controllers unique id
  52242. */
  52243. get uniqueId(): string;
  52244. /**
  52245. * Disposes of the object
  52246. */
  52247. dispose(): void;
  52248. /**
  52249. * Gets a world space ray coming from the pointer or grip
  52250. * @param result the resulting ray
  52251. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  52252. */
  52253. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  52254. /**
  52255. * Updates the controller pose based on the given XRFrame
  52256. * @param xrFrame xr frame to update the pose with
  52257. * @param referenceSpace reference space to use
  52258. */
  52259. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  52260. }
  52261. }
  52262. declare module BABYLON {
  52263. /**
  52264. * The schema for initialization options of the XR Input class
  52265. */
  52266. export interface IWebXRInputOptions {
  52267. /**
  52268. * If set to true no model will be automatically loaded
  52269. */
  52270. doNotLoadControllerMeshes?: boolean;
  52271. /**
  52272. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  52273. * If not found, the xr input profile data will be used.
  52274. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  52275. */
  52276. forceInputProfile?: string;
  52277. /**
  52278. * Do not send a request to the controller repository to load the profile.
  52279. *
  52280. * Instead, use the controllers available in babylon itself.
  52281. */
  52282. disableOnlineControllerRepository?: boolean;
  52283. /**
  52284. * A custom URL for the controllers repository
  52285. */
  52286. customControllersRepositoryURL?: string;
  52287. /**
  52288. * Should the controller model's components not move according to the user input
  52289. */
  52290. disableControllerAnimation?: boolean;
  52291. /**
  52292. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  52293. */
  52294. controllerOptions?: IWebXRControllerOptions;
  52295. }
  52296. /**
  52297. * XR input used to track XR inputs such as controllers/rays
  52298. */
  52299. export class WebXRInput implements IDisposable {
  52300. /**
  52301. * the xr session manager for this session
  52302. */
  52303. xrSessionManager: WebXRSessionManager;
  52304. /**
  52305. * the WebXR camera for this session. Mainly used for teleportation
  52306. */
  52307. xrCamera: WebXRCamera;
  52308. private readonly options;
  52309. /**
  52310. * XR controllers being tracked
  52311. */
  52312. controllers: Array<WebXRInputSource>;
  52313. private _frameObserver;
  52314. private _sessionEndedObserver;
  52315. private _sessionInitObserver;
  52316. /**
  52317. * Event when a controller has been connected/added
  52318. */
  52319. onControllerAddedObservable: Observable<WebXRInputSource>;
  52320. /**
  52321. * Event when a controller has been removed/disconnected
  52322. */
  52323. onControllerRemovedObservable: Observable<WebXRInputSource>;
  52324. /**
  52325. * Initializes the WebXRInput
  52326. * @param xrSessionManager the xr session manager for this session
  52327. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  52328. * @param options = initialization options for this xr input
  52329. */
  52330. constructor(
  52331. /**
  52332. * the xr session manager for this session
  52333. */
  52334. xrSessionManager: WebXRSessionManager,
  52335. /**
  52336. * the WebXR camera for this session. Mainly used for teleportation
  52337. */
  52338. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  52339. private _onInputSourcesChange;
  52340. private _addAndRemoveControllers;
  52341. /**
  52342. * Disposes of the object
  52343. */
  52344. dispose(): void;
  52345. }
  52346. }
  52347. declare module BABYLON {
  52348. /**
  52349. * This is the base class for all WebXR features.
  52350. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  52351. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  52352. */
  52353. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  52354. protected _xrSessionManager: WebXRSessionManager;
  52355. private _attached;
  52356. private _removeOnDetach;
  52357. /**
  52358. * Is this feature disposed?
  52359. */
  52360. isDisposed: boolean;
  52361. /**
  52362. * Should auto-attach be disabled?
  52363. */
  52364. disableAutoAttach: boolean;
  52365. /**
  52366. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  52367. */
  52368. xrNativeFeatureName: string;
  52369. /**
  52370. * Construct a new (abstract) WebXR feature
  52371. * @param _xrSessionManager the xr session manager for this feature
  52372. */
  52373. constructor(_xrSessionManager: WebXRSessionManager);
  52374. /**
  52375. * Is this feature attached
  52376. */
  52377. get attached(): boolean;
  52378. /**
  52379. * attach this feature
  52380. *
  52381. * @param force should attachment be forced (even when already attached)
  52382. * @returns true if successful, false is failed or already attached
  52383. */
  52384. attach(force?: boolean): boolean;
  52385. /**
  52386. * detach this feature.
  52387. *
  52388. * @returns true if successful, false if failed or already detached
  52389. */
  52390. detach(): boolean;
  52391. /**
  52392. * Dispose this feature and all of the resources attached
  52393. */
  52394. dispose(): void;
  52395. /**
  52396. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  52397. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  52398. *
  52399. * @returns whether or not the feature is compatible in this environment
  52400. */
  52401. isCompatible(): boolean;
  52402. /**
  52403. * This is used to register callbacks that will automatically be removed when detach is called.
  52404. * @param observable the observable to which the observer will be attached
  52405. * @param callback the callback to register
  52406. */
  52407. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  52408. /**
  52409. * Code in this function will be executed on each xrFrame received from the browser.
  52410. * This function will not execute after the feature is detached.
  52411. * @param _xrFrame the current frame
  52412. */
  52413. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  52414. }
  52415. }
  52416. declare module BABYLON {
  52417. /**
  52418. * Renders a layer on top of an existing scene
  52419. */
  52420. export class UtilityLayerRenderer implements IDisposable {
  52421. /** the original scene that will be rendered on top of */
  52422. originalScene: Scene;
  52423. private _pointerCaptures;
  52424. private _lastPointerEvents;
  52425. private static _DefaultUtilityLayer;
  52426. private static _DefaultKeepDepthUtilityLayer;
  52427. private _sharedGizmoLight;
  52428. private _renderCamera;
  52429. /**
  52430. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  52431. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  52432. * @returns the camera that is used when rendering the utility layer
  52433. */
  52434. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  52435. /**
  52436. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  52437. * @param cam the camera that should be used when rendering the utility layer
  52438. */
  52439. setRenderCamera(cam: Nullable<Camera>): void;
  52440. /**
  52441. * @hidden
  52442. * Light which used by gizmos to get light shading
  52443. */
  52444. _getSharedGizmoLight(): HemisphericLight;
  52445. /**
  52446. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  52447. */
  52448. pickUtilitySceneFirst: boolean;
  52449. /**
  52450. * 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)
  52451. */
  52452. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  52453. /**
  52454. * 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)
  52455. */
  52456. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  52457. /**
  52458. * The scene that is rendered on top of the original scene
  52459. */
  52460. utilityLayerScene: Scene;
  52461. /**
  52462. * If the utility layer should automatically be rendered on top of existing scene
  52463. */
  52464. shouldRender: boolean;
  52465. /**
  52466. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  52467. */
  52468. onlyCheckPointerDownEvents: boolean;
  52469. /**
  52470. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  52471. */
  52472. processAllEvents: boolean;
  52473. /**
  52474. * Observable raised when the pointer move from the utility layer scene to the main scene
  52475. */
  52476. onPointerOutObservable: Observable<number>;
  52477. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  52478. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  52479. private _afterRenderObserver;
  52480. private _sceneDisposeObserver;
  52481. private _originalPointerObserver;
  52482. /**
  52483. * Instantiates a UtilityLayerRenderer
  52484. * @param originalScene the original scene that will be rendered on top of
  52485. * @param handleEvents boolean indicating if the utility layer should handle events
  52486. */
  52487. constructor(
  52488. /** the original scene that will be rendered on top of */
  52489. originalScene: Scene, handleEvents?: boolean);
  52490. private _notifyObservers;
  52491. /**
  52492. * Renders the utility layers scene on top of the original scene
  52493. */
  52494. render(): void;
  52495. /**
  52496. * Disposes of the renderer
  52497. */
  52498. dispose(): void;
  52499. private _updateCamera;
  52500. }
  52501. }
  52502. declare module BABYLON {
  52503. /**
  52504. * Options interface for the pointer selection module
  52505. */
  52506. export interface IWebXRControllerPointerSelectionOptions {
  52507. /**
  52508. * if provided, this scene will be used to render meshes.
  52509. */
  52510. customUtilityLayerScene?: Scene;
  52511. /**
  52512. * Disable the pointer up event when the xr controller in screen and gaze mode is disposed (meaning - when the user removed the finger from the screen)
  52513. * If not disabled, the last picked point will be used to execute a pointer up event
  52514. * If disabled, pointer up event will be triggered right after the pointer down event.
  52515. * Used in screen and gaze target ray mode only
  52516. */
  52517. disablePointerUpOnTouchOut: boolean;
  52518. /**
  52519. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  52520. */
  52521. forceGazeMode: boolean;
  52522. /**
  52523. * Factor to be applied to the pointer-moved function in the gaze mode. How sensitive should the gaze mode be when checking if the pointer moved
  52524. * to start a new countdown to the pointer down event.
  52525. * Defaults to 1.
  52526. */
  52527. gazeModePointerMovedFactor?: number;
  52528. /**
  52529. * Different button type to use instead of the main component
  52530. */
  52531. overrideButtonId?: string;
  52532. /**
  52533. * use this rendering group id for the meshes (optional)
  52534. */
  52535. renderingGroupId?: number;
  52536. /**
  52537. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  52538. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  52539. * 3000 means 3 seconds between pointing at something and selecting it
  52540. */
  52541. timeToSelect?: number;
  52542. /**
  52543. * Should meshes created here be added to a utility layer or the main scene
  52544. */
  52545. useUtilityLayer?: boolean;
  52546. /**
  52547. * Optional WebXR camera to be used for gaze selection
  52548. */
  52549. gazeCamera?: WebXRCamera;
  52550. /**
  52551. * the xr input to use with this pointer selection
  52552. */
  52553. xrInput: WebXRInput;
  52554. /**
  52555. * Should the scene pointerX and pointerY update be disabled
  52556. * This is required for fullscreen AR GUI, but might slow down other experiences.
  52557. * Disable in VR, if not needed.
  52558. * The first rig camera (left eye) will be used to calculate the projection
  52559. */
  52560. disableScenePointerVectorUpdate: boolean;
  52561. /**
  52562. * Enable pointer selection on all controllers instead of switching between them
  52563. */
  52564. enablePointerSelectionOnAllControllers?: boolean;
  52565. /**
  52566. * The preferred hand to give the pointer selection to. This will be prioritized when the controller initialize.
  52567. * If switch is enabled, it will still allow the user to switch between the different controllers
  52568. */
  52569. preferredHandedness?: XRHandedness;
  52570. /**
  52571. * Disable switching the pointer selection from one controller to the other.
  52572. * If the preferred hand is set it will be fixed on this hand, and if not it will be fixed on the first controller added to the scene
  52573. */
  52574. disableSwitchOnClick?: boolean;
  52575. /**
  52576. * The maximum distance of the pointer selection feature. Defaults to 100.
  52577. */
  52578. maxPointerDistance?: number;
  52579. }
  52580. /**
  52581. * A module that will enable pointer selection for motion controllers of XR Input Sources
  52582. */
  52583. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  52584. private readonly _options;
  52585. private static _idCounter;
  52586. private _attachController;
  52587. private _controllers;
  52588. private _scene;
  52589. private _tmpVectorForPickCompare;
  52590. private _attachedController;
  52591. /**
  52592. * The module's name
  52593. */
  52594. static readonly Name: string;
  52595. /**
  52596. * The (Babylon) version of this module.
  52597. * This is an integer representing the implementation version.
  52598. * This number does not correspond to the WebXR specs version
  52599. */
  52600. static readonly Version: number;
  52601. /**
  52602. * Disable lighting on the laser pointer (so it will always be visible)
  52603. */
  52604. disablePointerLighting: boolean;
  52605. /**
  52606. * Disable lighting on the selection mesh (so it will always be visible)
  52607. */
  52608. disableSelectionMeshLighting: boolean;
  52609. /**
  52610. * Should the laser pointer be displayed
  52611. */
  52612. displayLaserPointer: boolean;
  52613. /**
  52614. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  52615. */
  52616. displaySelectionMesh: boolean;
  52617. /**
  52618. * This color will be set to the laser pointer when selection is triggered
  52619. */
  52620. laserPointerPickedColor: Color3;
  52621. /**
  52622. * Default color of the laser pointer
  52623. */
  52624. laserPointerDefaultColor: Color3;
  52625. /**
  52626. * default color of the selection ring
  52627. */
  52628. selectionMeshDefaultColor: Color3;
  52629. /**
  52630. * This color will be applied to the selection ring when selection is triggered
  52631. */
  52632. selectionMeshPickedColor: Color3;
  52633. /**
  52634. * Optional filter to be used for ray selection. This predicate shares behavior with
  52635. * scene.pointerMovePredicate which takes priority if it is also assigned.
  52636. */
  52637. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  52638. /**
  52639. * constructs a new background remover module
  52640. * @param _xrSessionManager the session manager for this module
  52641. * @param _options read-only options to be used in this module
  52642. */
  52643. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  52644. /**
  52645. * attach this feature
  52646. * Will usually be called by the features manager
  52647. *
  52648. * @returns true if successful.
  52649. */
  52650. attach(): boolean;
  52651. /**
  52652. * detach this feature.
  52653. * Will usually be called by the features manager
  52654. *
  52655. * @returns true if successful.
  52656. */
  52657. detach(): boolean;
  52658. /**
  52659. * Will get the mesh under a specific pointer.
  52660. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  52661. * @param controllerId the controllerId to check
  52662. * @returns The mesh under pointer or null if no mesh is under the pointer
  52663. */
  52664. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  52665. /**
  52666. * Get the xr controller that correlates to the pointer id in the pointer event
  52667. *
  52668. * @param id the pointer id to search for
  52669. * @returns the controller that correlates to this id or null if not found
  52670. */
  52671. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  52672. private _identityMatrix;
  52673. private _screenCoordinatesRef;
  52674. private _viewportRef;
  52675. protected _onXRFrame(_xrFrame: XRFrame): void;
  52676. private _attachGazeMode;
  52677. private _attachScreenRayMode;
  52678. private _attachTrackedPointerRayMode;
  52679. private _convertNormalToDirectionOfRay;
  52680. private _detachController;
  52681. private _generateNewMeshPair;
  52682. private _pickingMoved;
  52683. private _updatePointerDistance;
  52684. /** @hidden */
  52685. get lasterPointerDefaultColor(): Color3;
  52686. }
  52687. }
  52688. declare module BABYLON {
  52689. /**
  52690. * Button which can be used to enter a different mode of XR
  52691. */
  52692. export class WebXREnterExitUIButton {
  52693. /** button element */
  52694. element: HTMLElement;
  52695. /** XR initialization options for the button */
  52696. sessionMode: XRSessionMode;
  52697. /** Reference space type */
  52698. referenceSpaceType: XRReferenceSpaceType;
  52699. /**
  52700. * Creates a WebXREnterExitUIButton
  52701. * @param element button element
  52702. * @param sessionMode XR initialization session mode
  52703. * @param referenceSpaceType the type of reference space to be used
  52704. */
  52705. constructor(
  52706. /** button element */
  52707. element: HTMLElement,
  52708. /** XR initialization options for the button */
  52709. sessionMode: XRSessionMode,
  52710. /** Reference space type */
  52711. referenceSpaceType: XRReferenceSpaceType);
  52712. /**
  52713. * Extendable function which can be used to update the button's visuals when the state changes
  52714. * @param activeButton the current active button in the UI
  52715. */
  52716. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  52717. }
  52718. /**
  52719. * Options to create the webXR UI
  52720. */
  52721. export class WebXREnterExitUIOptions {
  52722. /**
  52723. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  52724. */
  52725. customButtons?: Array<WebXREnterExitUIButton>;
  52726. /**
  52727. * A reference space type to use when creating the default button.
  52728. * Default is local-floor
  52729. */
  52730. referenceSpaceType?: XRReferenceSpaceType;
  52731. /**
  52732. * Context to enter xr with
  52733. */
  52734. renderTarget?: Nullable<WebXRRenderTarget>;
  52735. /**
  52736. * A session mode to use when creating the default button.
  52737. * Default is immersive-vr
  52738. */
  52739. sessionMode?: XRSessionMode;
  52740. /**
  52741. * A list of optional features to init the session with
  52742. */
  52743. optionalFeatures?: string[];
  52744. /**
  52745. * A list of optional features to init the session with
  52746. */
  52747. requiredFeatures?: string[];
  52748. /**
  52749. * If defined, this function will be executed if the UI encounters an error when entering XR
  52750. */
  52751. onError?: (error: any) => void;
  52752. }
  52753. /**
  52754. * UI to allow the user to enter/exit XR mode
  52755. */
  52756. export class WebXREnterExitUI implements IDisposable {
  52757. private scene;
  52758. /** version of the options passed to this UI */
  52759. options: WebXREnterExitUIOptions;
  52760. private _activeButton;
  52761. private _buttons;
  52762. /**
  52763. * The HTML Div Element to which buttons are added.
  52764. */
  52765. readonly overlay: HTMLDivElement;
  52766. /**
  52767. * Fired every time the active button is changed.
  52768. *
  52769. * When xr is entered via a button that launches xr that button will be the callback parameter
  52770. *
  52771. * When exiting xr the callback parameter will be null)
  52772. */
  52773. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  52774. /**
  52775. *
  52776. * @param scene babylon scene object to use
  52777. * @param options (read-only) version of the options passed to this UI
  52778. */
  52779. private constructor();
  52780. /**
  52781. * Creates UI to allow the user to enter/exit XR mode
  52782. * @param scene the scene to add the ui to
  52783. * @param helper the xr experience helper to enter/exit xr with
  52784. * @param options options to configure the UI
  52785. * @returns the created ui
  52786. */
  52787. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  52788. /**
  52789. * Disposes of the XR UI component
  52790. */
  52791. dispose(): void;
  52792. private _updateButtons;
  52793. }
  52794. }
  52795. declare module BABYLON {
  52796. /**
  52797. * Class containing static functions to help procedurally build meshes
  52798. */
  52799. export class LinesBuilder {
  52800. /**
  52801. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  52802. * * 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
  52803. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  52804. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  52805. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  52806. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  52807. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  52808. * * 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
  52809. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  52810. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52811. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  52812. * @param name defines the name of the new line system
  52813. * @param options defines the options used to create the line system
  52814. * @param scene defines the hosting scene
  52815. * @returns a new line system mesh
  52816. */
  52817. static CreateLineSystem(name: string, options: {
  52818. lines: Vector3[][];
  52819. updatable?: boolean;
  52820. instance?: Nullable<LinesMesh>;
  52821. colors?: Nullable<Color4[][]>;
  52822. useVertexAlpha?: boolean;
  52823. }, scene: Nullable<Scene>): LinesMesh;
  52824. /**
  52825. * Creates a line mesh
  52826. * 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
  52827. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  52828. * * The parameter `points` is an array successive Vector3
  52829. * * 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
  52830. * * The optional parameter `colors` is an array of successive Color4, one per line point
  52831. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  52832. * * When updating an instance, remember that only point positions can change, not the number of points
  52833. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52834. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  52835. * @param name defines the name of the new line system
  52836. * @param options defines the options used to create the line system
  52837. * @param scene defines the hosting scene
  52838. * @returns a new line mesh
  52839. */
  52840. static CreateLines(name: string, options: {
  52841. points: Vector3[];
  52842. updatable?: boolean;
  52843. instance?: Nullable<LinesMesh>;
  52844. colors?: Color4[];
  52845. useVertexAlpha?: boolean;
  52846. }, scene?: Nullable<Scene>): LinesMesh;
  52847. /**
  52848. * Creates a dashed line mesh
  52849. * * 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
  52850. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  52851. * * The parameter `points` is an array successive Vector3
  52852. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  52853. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  52854. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  52855. * * 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
  52856. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  52857. * * When updating an instance, remember that only point positions can change, not the number of points
  52858. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52859. * @param name defines the name of the mesh
  52860. * @param options defines the options used to create the mesh
  52861. * @param scene defines the hosting scene
  52862. * @returns the dashed line mesh
  52863. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  52864. */
  52865. static CreateDashedLines(name: string, options: {
  52866. points: Vector3[];
  52867. dashSize?: number;
  52868. gapSize?: number;
  52869. dashNb?: number;
  52870. updatable?: boolean;
  52871. instance?: LinesMesh;
  52872. useVertexAlpha?: boolean;
  52873. }, scene?: Nullable<Scene>): LinesMesh;
  52874. }
  52875. }
  52876. declare module BABYLON {
  52877. /**
  52878. * Construction options for a timer
  52879. */
  52880. export interface ITimerOptions<T> {
  52881. /**
  52882. * Time-to-end
  52883. */
  52884. timeout: number;
  52885. /**
  52886. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  52887. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  52888. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  52889. */
  52890. contextObservable: Observable<T>;
  52891. /**
  52892. * Optional parameters when adding an observer to the observable
  52893. */
  52894. observableParameters?: {
  52895. mask?: number;
  52896. insertFirst?: boolean;
  52897. scope?: any;
  52898. };
  52899. /**
  52900. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  52901. */
  52902. breakCondition?: (data?: ITimerData<T>) => boolean;
  52903. /**
  52904. * Will be triggered when the time condition has met
  52905. */
  52906. onEnded?: (data: ITimerData<any>) => void;
  52907. /**
  52908. * Will be triggered when the break condition has met (prematurely ended)
  52909. */
  52910. onAborted?: (data: ITimerData<any>) => void;
  52911. /**
  52912. * Optional function to execute on each tick (or count)
  52913. */
  52914. onTick?: (data: ITimerData<any>) => void;
  52915. }
  52916. /**
  52917. * An interface defining the data sent by the timer
  52918. */
  52919. export interface ITimerData<T> {
  52920. /**
  52921. * When did it start
  52922. */
  52923. startTime: number;
  52924. /**
  52925. * Time now
  52926. */
  52927. currentTime: number;
  52928. /**
  52929. * Time passed since started
  52930. */
  52931. deltaTime: number;
  52932. /**
  52933. * How much is completed, in [0.0...1.0].
  52934. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  52935. */
  52936. completeRate: number;
  52937. /**
  52938. * What the registered observable sent in the last count
  52939. */
  52940. payload: T;
  52941. }
  52942. /**
  52943. * The current state of the timer
  52944. */
  52945. export enum TimerState {
  52946. /**
  52947. * Timer initialized, not yet started
  52948. */
  52949. INIT = 0,
  52950. /**
  52951. * Timer started and counting
  52952. */
  52953. STARTED = 1,
  52954. /**
  52955. * Timer ended (whether aborted or time reached)
  52956. */
  52957. ENDED = 2
  52958. }
  52959. /**
  52960. * A simple version of the timer. Will take options and start the timer immediately after calling it
  52961. *
  52962. * @param options options with which to initialize this timer
  52963. */
  52964. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  52965. /**
  52966. * An advanced implementation of a timer class
  52967. */
  52968. export class AdvancedTimer<T = any> implements IDisposable {
  52969. /**
  52970. * Will notify each time the timer calculates the remaining time
  52971. */
  52972. onEachCountObservable: Observable<ITimerData<T>>;
  52973. /**
  52974. * Will trigger when the timer was aborted due to the break condition
  52975. */
  52976. onTimerAbortedObservable: Observable<ITimerData<T>>;
  52977. /**
  52978. * Will trigger when the timer ended successfully
  52979. */
  52980. onTimerEndedObservable: Observable<ITimerData<T>>;
  52981. /**
  52982. * Will trigger when the timer state has changed
  52983. */
  52984. onStateChangedObservable: Observable<TimerState>;
  52985. private _observer;
  52986. private _contextObservable;
  52987. private _observableParameters;
  52988. private _startTime;
  52989. private _timer;
  52990. private _state;
  52991. private _breakCondition;
  52992. private _timeToEnd;
  52993. private _breakOnNextTick;
  52994. /**
  52995. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  52996. * @param options construction options for this advanced timer
  52997. */
  52998. constructor(options: ITimerOptions<T>);
  52999. /**
  53000. * set a breaking condition for this timer. Default is to never break during count
  53001. * @param predicate the new break condition. Returns true to break, false otherwise
  53002. */
  53003. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  53004. /**
  53005. * Reset ALL associated observables in this advanced timer
  53006. */
  53007. clearObservables(): void;
  53008. /**
  53009. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  53010. *
  53011. * @param timeToEnd how much time to measure until timer ended
  53012. */
  53013. start(timeToEnd?: number): void;
  53014. /**
  53015. * Will force a stop on the next tick.
  53016. */
  53017. stop(): void;
  53018. /**
  53019. * Dispose this timer, clearing all resources
  53020. */
  53021. dispose(): void;
  53022. private _setState;
  53023. private _tick;
  53024. private _stop;
  53025. }
  53026. }
  53027. declare module BABYLON {
  53028. /**
  53029. * The options container for the teleportation module
  53030. */
  53031. export interface IWebXRTeleportationOptions {
  53032. /**
  53033. * if provided, this scene will be used to render meshes.
  53034. */
  53035. customUtilityLayerScene?: Scene;
  53036. /**
  53037. * Values to configure the default target mesh
  53038. */
  53039. defaultTargetMeshOptions?: {
  53040. /**
  53041. * Fill color of the teleportation area
  53042. */
  53043. teleportationFillColor?: string;
  53044. /**
  53045. * Border color for the teleportation area
  53046. */
  53047. teleportationBorderColor?: string;
  53048. /**
  53049. * Disable the mesh's animation sequence
  53050. */
  53051. disableAnimation?: boolean;
  53052. /**
  53053. * Disable lighting on the material or the ring and arrow
  53054. */
  53055. disableLighting?: boolean;
  53056. /**
  53057. * Override the default material of the torus and arrow
  53058. */
  53059. torusArrowMaterial?: Material;
  53060. };
  53061. /**
  53062. * A list of meshes to use as floor meshes.
  53063. * Meshes can be added and removed after initializing the feature using the
  53064. * addFloorMesh and removeFloorMesh functions
  53065. * If empty, rotation will still work
  53066. */
  53067. floorMeshes?: AbstractMesh[];
  53068. /**
  53069. * use this rendering group id for the meshes (optional)
  53070. */
  53071. renderingGroupId?: number;
  53072. /**
  53073. * Should teleportation move only to snap points
  53074. */
  53075. snapPointsOnly?: boolean;
  53076. /**
  53077. * An array of points to which the teleportation will snap to.
  53078. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  53079. */
  53080. snapPositions?: Vector3[];
  53081. /**
  53082. * How close should the teleportation ray be in order to snap to position.
  53083. * Default to 0.8 units (meters)
  53084. */
  53085. snapToPositionRadius?: number;
  53086. /**
  53087. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  53088. * If you want to support rotation, make sure your mesh has a direction indicator.
  53089. *
  53090. * When left untouched, the default mesh will be initialized.
  53091. */
  53092. teleportationTargetMesh?: AbstractMesh;
  53093. /**
  53094. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  53095. */
  53096. timeToTeleport?: number;
  53097. /**
  53098. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  53099. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  53100. */
  53101. useMainComponentOnly?: boolean;
  53102. /**
  53103. * Should meshes created here be added to a utility layer or the main scene
  53104. */
  53105. useUtilityLayer?: boolean;
  53106. /**
  53107. * Babylon XR Input class for controller
  53108. */
  53109. xrInput: WebXRInput;
  53110. /**
  53111. * Meshes that the teleportation ray cannot go through
  53112. */
  53113. pickBlockerMeshes?: AbstractMesh[];
  53114. /**
  53115. * Should teleport work only on a specific hand?
  53116. */
  53117. forceHandedness?: XRHandedness;
  53118. /**
  53119. * If provided, this function will be used to generate the ray mesh instead of the lines mesh being used per default
  53120. */
  53121. generateRayPathMesh?: (points: Vector3[]) => AbstractMesh;
  53122. }
  53123. /**
  53124. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  53125. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  53126. * the input of the attached controllers.
  53127. */
  53128. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  53129. private _options;
  53130. private _controllers;
  53131. private _currentTeleportationControllerId;
  53132. private _floorMeshes;
  53133. private _quadraticBezierCurve;
  53134. private _selectionFeature;
  53135. private _snapToPositions;
  53136. private _snappedToPoint;
  53137. private _teleportationRingMaterial?;
  53138. private _tmpRay;
  53139. private _tmpVector;
  53140. private _tmpQuaternion;
  53141. /**
  53142. * The module's name
  53143. */
  53144. static readonly Name: string;
  53145. /**
  53146. * The (Babylon) version of this module.
  53147. * This is an integer representing the implementation version.
  53148. * This number does not correspond to the webxr specs version
  53149. */
  53150. static readonly Version: number;
  53151. /**
  53152. * Is movement backwards enabled
  53153. */
  53154. backwardsMovementEnabled: boolean;
  53155. /**
  53156. * Distance to travel when moving backwards
  53157. */
  53158. backwardsTeleportationDistance: number;
  53159. /**
  53160. * The distance from the user to the inspection point in the direction of the controller
  53161. * A higher number will allow the user to move further
  53162. * defaults to 5 (meters, in xr units)
  53163. */
  53164. parabolicCheckRadius: number;
  53165. /**
  53166. * Should the module support parabolic ray on top of direct ray
  53167. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  53168. * Very helpful when moving between floors / different heights
  53169. */
  53170. parabolicRayEnabled: boolean;
  53171. /**
  53172. * The second type of ray - straight line.
  53173. * Should it be enabled or should the parabolic line be the only one.
  53174. */
  53175. straightRayEnabled: boolean;
  53176. /**
  53177. * How much rotation should be applied when rotating right and left
  53178. */
  53179. rotationAngle: number;
  53180. private _rotationEnabled;
  53181. /**
  53182. * Is rotation enabled when moving forward?
  53183. * Disabling this feature will prevent the user from deciding the direction when teleporting
  53184. */
  53185. get rotationEnabled(): boolean;
  53186. /**
  53187. * Sets wether rotation is enabled or not
  53188. * @param enabled is rotation enabled when teleportation is shown
  53189. */
  53190. set rotationEnabled(enabled: boolean);
  53191. /**
  53192. * Exposes the currently set teleportation target mesh.
  53193. */
  53194. get teleportationTargetMesh(): Nullable<AbstractMesh>;
  53195. /**
  53196. * constructs a new anchor system
  53197. * @param _xrSessionManager an instance of WebXRSessionManager
  53198. * @param _options configuration object for this feature
  53199. */
  53200. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  53201. /**
  53202. * Get the snapPointsOnly flag
  53203. */
  53204. get snapPointsOnly(): boolean;
  53205. /**
  53206. * Sets the snapPointsOnly flag
  53207. * @param snapToPoints should teleportation be exclusively to snap points
  53208. */
  53209. set snapPointsOnly(snapToPoints: boolean);
  53210. /**
  53211. * Add a new mesh to the floor meshes array
  53212. * @param mesh the mesh to use as floor mesh
  53213. */
  53214. addFloorMesh(mesh: AbstractMesh): void;
  53215. /**
  53216. * Add a new snap-to point to fix teleportation to this position
  53217. * @param newSnapPoint The new Snap-To point
  53218. */
  53219. addSnapPoint(newSnapPoint: Vector3): void;
  53220. attach(): boolean;
  53221. detach(): boolean;
  53222. dispose(): void;
  53223. /**
  53224. * Remove a mesh from the floor meshes array
  53225. * @param mesh the mesh to remove
  53226. */
  53227. removeFloorMesh(mesh: AbstractMesh): void;
  53228. /**
  53229. * Remove a mesh from the floor meshes array using its name
  53230. * @param name the mesh name to remove
  53231. */
  53232. removeFloorMeshByName(name: string): void;
  53233. /**
  53234. * This function will iterate through the array, searching for this point or equal to it. It will then remove it from the snap-to array
  53235. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  53236. * @returns was the point found and removed or not
  53237. */
  53238. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  53239. /**
  53240. * This function sets a selection feature that will be disabled when
  53241. * the forward ray is shown and will be reattached when hidden.
  53242. * This is used to remove the selection rays when moving.
  53243. * @param selectionFeature the feature to disable when forward movement is enabled
  53244. */
  53245. setSelectionFeature(selectionFeature: Nullable<IWebXRFeature>): void;
  53246. protected _onXRFrame(_xrFrame: XRFrame): void;
  53247. private _attachController;
  53248. private _createDefaultTargetMesh;
  53249. private _detachController;
  53250. private _findClosestSnapPointWithRadius;
  53251. private _setTargetMeshPosition;
  53252. private _setTargetMeshVisibility;
  53253. private _showParabolicPath;
  53254. private _teleportForward;
  53255. }
  53256. }
  53257. declare module BABYLON {
  53258. /**
  53259. * Options for the default xr helper
  53260. */
  53261. export class WebXRDefaultExperienceOptions {
  53262. /**
  53263. * Enable or disable default UI to enter XR
  53264. */
  53265. disableDefaultUI?: boolean;
  53266. /**
  53267. * Should teleportation not initialize. defaults to false.
  53268. */
  53269. disableTeleportation?: boolean;
  53270. /**
  53271. * Floor meshes that will be used for teleport
  53272. */
  53273. floorMeshes?: Array<AbstractMesh>;
  53274. /**
  53275. * If set to true, the first frame will not be used to reset position
  53276. * The first frame is mainly used when copying transformation from the old camera
  53277. * Mainly used in AR
  53278. */
  53279. ignoreNativeCameraTransformation?: boolean;
  53280. /**
  53281. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  53282. */
  53283. inputOptions?: IWebXRInputOptions;
  53284. /**
  53285. * optional configuration for the output canvas
  53286. */
  53287. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  53288. /**
  53289. * optional UI options. This can be used among other to change session mode and reference space type
  53290. */
  53291. uiOptions?: WebXREnterExitUIOptions;
  53292. /**
  53293. * When loading teleportation and pointer select, use stable versions instead of latest.
  53294. */
  53295. useStablePlugins?: boolean;
  53296. /**
  53297. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  53298. */
  53299. renderingGroupId?: number;
  53300. /**
  53301. * A list of optional features to init the session with
  53302. * If set to true, all features we support will be added
  53303. */
  53304. optionalFeatures?: boolean | string[];
  53305. }
  53306. /**
  53307. * Default experience which provides a similar setup to the previous webVRExperience
  53308. */
  53309. export class WebXRDefaultExperience {
  53310. /**
  53311. * Base experience
  53312. */
  53313. baseExperience: WebXRExperienceHelper;
  53314. /**
  53315. * Enables ui for entering/exiting xr
  53316. */
  53317. enterExitUI: WebXREnterExitUI;
  53318. /**
  53319. * Input experience extension
  53320. */
  53321. input: WebXRInput;
  53322. /**
  53323. * Enables laser pointer and selection
  53324. */
  53325. pointerSelection: WebXRControllerPointerSelection;
  53326. /**
  53327. * Default target xr should render to
  53328. */
  53329. renderTarget: WebXRRenderTarget;
  53330. /**
  53331. * Enables teleportation
  53332. */
  53333. teleportation: WebXRMotionControllerTeleportation;
  53334. private constructor();
  53335. /**
  53336. * Creates the default xr experience
  53337. * @param scene scene
  53338. * @param options options for basic configuration
  53339. * @returns resulting WebXRDefaultExperience
  53340. */
  53341. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  53342. /**
  53343. * DIsposes of the experience helper
  53344. */
  53345. dispose(): void;
  53346. }
  53347. }
  53348. declare module BABYLON {
  53349. /**
  53350. * Options to modify the vr teleportation behavior.
  53351. */
  53352. export interface VRTeleportationOptions {
  53353. /**
  53354. * The name of the mesh which should be used as the teleportation floor. (default: null)
  53355. */
  53356. floorMeshName?: string;
  53357. /**
  53358. * A list of meshes to be used as the teleportation floor. (default: empty)
  53359. */
  53360. floorMeshes?: Mesh[];
  53361. /**
  53362. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  53363. */
  53364. teleportationMode?: number;
  53365. /**
  53366. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  53367. */
  53368. teleportationTime?: number;
  53369. /**
  53370. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  53371. */
  53372. teleportationSpeed?: number;
  53373. /**
  53374. * The easing function used in the animation or null for Linear. (default CircleEase)
  53375. */
  53376. easingFunction?: EasingFunction;
  53377. }
  53378. /**
  53379. * Options to modify the vr experience helper's behavior.
  53380. */
  53381. export interface VRExperienceHelperOptions extends WebVROptions {
  53382. /**
  53383. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  53384. */
  53385. createDeviceOrientationCamera?: boolean;
  53386. /**
  53387. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  53388. */
  53389. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  53390. /**
  53391. * Uses the main button on the controller to toggle the laser casted. (default: true)
  53392. */
  53393. laserToggle?: boolean;
  53394. /**
  53395. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  53396. */
  53397. floorMeshes?: Mesh[];
  53398. /**
  53399. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  53400. */
  53401. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  53402. /**
  53403. * Defines if WebXR should be used instead of WebVR (if available)
  53404. */
  53405. useXR?: boolean;
  53406. }
  53407. /**
  53408. * Event containing information after VR has been entered
  53409. */
  53410. export class OnAfterEnteringVRObservableEvent {
  53411. /**
  53412. * If entering vr was successful
  53413. */
  53414. success: boolean;
  53415. }
  53416. /**
  53417. * Helps to quickly add VR support to an existing scene.
  53418. * See https://doc.babylonjs.com/how_to/webvr_helper
  53419. */
  53420. export class VRExperienceHelper {
  53421. /** Options to modify the vr experience helper's behavior. */
  53422. webVROptions: VRExperienceHelperOptions;
  53423. private _scene;
  53424. private _position;
  53425. private _btnVR;
  53426. private _btnVRDisplayed;
  53427. private _webVRsupported;
  53428. private _webVRready;
  53429. private _webVRrequesting;
  53430. private _webVRpresenting;
  53431. private _hasEnteredVR;
  53432. private _fullscreenVRpresenting;
  53433. private _inputElement;
  53434. private _webVRCamera;
  53435. private _vrDeviceOrientationCamera;
  53436. private _deviceOrientationCamera;
  53437. private _existingCamera;
  53438. private _onKeyDown;
  53439. private _onVrDisplayPresentChange;
  53440. private _onVRDisplayChanged;
  53441. private _onVRRequestPresentStart;
  53442. private _onVRRequestPresentComplete;
  53443. /**
  53444. * 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)
  53445. */
  53446. enableGazeEvenWhenNoPointerLock: boolean;
  53447. /**
  53448. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  53449. */
  53450. exitVROnDoubleTap: boolean;
  53451. /**
  53452. * Observable raised right before entering VR.
  53453. */
  53454. onEnteringVRObservable: Observable<VRExperienceHelper>;
  53455. /**
  53456. * Observable raised when entering VR has completed.
  53457. */
  53458. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  53459. /**
  53460. * Observable raised when exiting VR.
  53461. */
  53462. onExitingVRObservable: Observable<VRExperienceHelper>;
  53463. /**
  53464. * Observable raised when controller mesh is loaded.
  53465. */
  53466. onControllerMeshLoadedObservable: Observable<WebVRController>;
  53467. /** Return this.onEnteringVRObservable
  53468. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  53469. */
  53470. get onEnteringVR(): Observable<VRExperienceHelper>;
  53471. /** Return this.onExitingVRObservable
  53472. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  53473. */
  53474. get onExitingVR(): Observable<VRExperienceHelper>;
  53475. /** Return this.onControllerMeshLoadedObservable
  53476. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  53477. */
  53478. get onControllerMeshLoaded(): Observable<WebVRController>;
  53479. private _rayLength;
  53480. private _useCustomVRButton;
  53481. private _teleportationRequested;
  53482. private _teleportActive;
  53483. private _floorMeshName;
  53484. private _floorMeshesCollection;
  53485. private _teleportationMode;
  53486. private _teleportationTime;
  53487. private _teleportationSpeed;
  53488. private _teleportationEasing;
  53489. private _rotationAllowed;
  53490. private _teleportBackwardsVector;
  53491. private _teleportationTarget;
  53492. private _isDefaultTeleportationTarget;
  53493. private _postProcessMove;
  53494. private _teleportationFillColor;
  53495. private _teleportationBorderColor;
  53496. private _rotationAngle;
  53497. private _haloCenter;
  53498. private _cameraGazer;
  53499. private _padSensibilityUp;
  53500. private _padSensibilityDown;
  53501. private _leftController;
  53502. private _rightController;
  53503. private _gazeColor;
  53504. private _laserColor;
  53505. private _pickedLaserColor;
  53506. private _pickedGazeColor;
  53507. /**
  53508. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  53509. */
  53510. onNewMeshSelected: Observable<AbstractMesh>;
  53511. /**
  53512. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  53513. * This observable will provide the mesh and the controller used to select the mesh
  53514. */
  53515. onMeshSelectedWithController: Observable<{
  53516. mesh: AbstractMesh;
  53517. controller: WebVRController;
  53518. }>;
  53519. /**
  53520. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  53521. */
  53522. onNewMeshPicked: Observable<PickingInfo>;
  53523. private _circleEase;
  53524. /**
  53525. * Observable raised before camera teleportation
  53526. */
  53527. onBeforeCameraTeleport: Observable<Vector3>;
  53528. /**
  53529. * Observable raised after camera teleportation
  53530. */
  53531. onAfterCameraTeleport: Observable<Vector3>;
  53532. /**
  53533. * Observable raised when current selected mesh gets unselected
  53534. */
  53535. onSelectedMeshUnselected: Observable<AbstractMesh>;
  53536. private _raySelectionPredicate;
  53537. /**
  53538. * To be optionaly changed by user to define custom ray selection
  53539. */
  53540. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  53541. /**
  53542. * To be optionaly changed by user to define custom selection logic (after ray selection)
  53543. */
  53544. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  53545. /**
  53546. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  53547. */
  53548. teleportationEnabled: boolean;
  53549. private _defaultHeight;
  53550. private _teleportationInitialized;
  53551. private _interactionsEnabled;
  53552. private _interactionsRequested;
  53553. private _displayGaze;
  53554. private _displayLaserPointer;
  53555. /**
  53556. * The mesh used to display where the user is going to teleport.
  53557. */
  53558. get teleportationTarget(): Mesh;
  53559. /**
  53560. * Sets the mesh to be used to display where the user is going to teleport.
  53561. */
  53562. set teleportationTarget(value: Mesh);
  53563. /**
  53564. * 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
  53565. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  53566. * See https://doc.babylonjs.com/resources/baking_transformations
  53567. */
  53568. get gazeTrackerMesh(): Mesh;
  53569. set gazeTrackerMesh(value: Mesh);
  53570. /**
  53571. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  53572. */
  53573. updateGazeTrackerScale: boolean;
  53574. /**
  53575. * If the gaze trackers color should be updated when selecting meshes
  53576. */
  53577. updateGazeTrackerColor: boolean;
  53578. /**
  53579. * If the controller laser color should be updated when selecting meshes
  53580. */
  53581. updateControllerLaserColor: boolean;
  53582. /**
  53583. * The gaze tracking mesh corresponding to the left controller
  53584. */
  53585. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  53586. /**
  53587. * The gaze tracking mesh corresponding to the right controller
  53588. */
  53589. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  53590. /**
  53591. * If the ray of the gaze should be displayed.
  53592. */
  53593. get displayGaze(): boolean;
  53594. /**
  53595. * Sets if the ray of the gaze should be displayed.
  53596. */
  53597. set displayGaze(value: boolean);
  53598. /**
  53599. * If the ray of the LaserPointer should be displayed.
  53600. */
  53601. get displayLaserPointer(): boolean;
  53602. /**
  53603. * Sets if the ray of the LaserPointer should be displayed.
  53604. */
  53605. set displayLaserPointer(value: boolean);
  53606. /**
  53607. * The deviceOrientationCamera used as the camera when not in VR.
  53608. */
  53609. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  53610. /**
  53611. * Based on the current WebVR support, returns the current VR camera used.
  53612. */
  53613. get currentVRCamera(): Nullable<Camera>;
  53614. /**
  53615. * The webVRCamera which is used when in VR.
  53616. */
  53617. get webVRCamera(): WebVRFreeCamera;
  53618. /**
  53619. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  53620. */
  53621. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  53622. /**
  53623. * The html button that is used to trigger entering into VR.
  53624. */
  53625. get vrButton(): Nullable<HTMLButtonElement>;
  53626. private get _teleportationRequestInitiated();
  53627. /**
  53628. * Defines whether or not Pointer lock should be requested when switching to
  53629. * full screen.
  53630. */
  53631. requestPointerLockOnFullScreen: boolean;
  53632. /**
  53633. * If asking to force XR, this will be populated with the default xr experience
  53634. */
  53635. xr: WebXRDefaultExperience;
  53636. /**
  53637. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  53638. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  53639. */
  53640. xrTestDone: boolean;
  53641. /**
  53642. * Instantiates a VRExperienceHelper.
  53643. * Helps to quickly add VR support to an existing scene.
  53644. * @param scene The scene the VRExperienceHelper belongs to.
  53645. * @param webVROptions Options to modify the vr experience helper's behavior.
  53646. */
  53647. constructor(scene: Scene,
  53648. /** Options to modify the vr experience helper's behavior. */
  53649. webVROptions?: VRExperienceHelperOptions);
  53650. private completeVRInit;
  53651. private _onDefaultMeshLoaded;
  53652. private _onResize;
  53653. private _onFullscreenChange;
  53654. /**
  53655. * Gets a value indicating if we are currently in VR mode.
  53656. */
  53657. get isInVRMode(): boolean;
  53658. private onVrDisplayPresentChange;
  53659. private onVRDisplayChanged;
  53660. private moveButtonToBottomRight;
  53661. private displayVRButton;
  53662. private updateButtonVisibility;
  53663. private _cachedAngularSensibility;
  53664. /**
  53665. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  53666. * Otherwise, will use the fullscreen API.
  53667. */
  53668. enterVR(): void;
  53669. /**
  53670. * Attempt to exit VR, or fullscreen.
  53671. */
  53672. exitVR(): void;
  53673. /**
  53674. * The position of the vr experience helper.
  53675. */
  53676. get position(): Vector3;
  53677. /**
  53678. * Sets the position of the vr experience helper.
  53679. */
  53680. set position(value: Vector3);
  53681. /**
  53682. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  53683. */
  53684. enableInteractions(): void;
  53685. private get _noControllerIsActive();
  53686. private beforeRender;
  53687. private _isTeleportationFloor;
  53688. /**
  53689. * Adds a floor mesh to be used for teleportation.
  53690. * @param floorMesh the mesh to be used for teleportation.
  53691. */
  53692. addFloorMesh(floorMesh: Mesh): void;
  53693. /**
  53694. * Removes a floor mesh from being used for teleportation.
  53695. * @param floorMesh the mesh to be removed.
  53696. */
  53697. removeFloorMesh(floorMesh: Mesh): void;
  53698. /**
  53699. * Enables interactions and teleportation using the VR controllers and gaze.
  53700. * @param vrTeleportationOptions options to modify teleportation behavior.
  53701. */
  53702. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  53703. private _onNewGamepadConnected;
  53704. private _tryEnableInteractionOnController;
  53705. private _onNewGamepadDisconnected;
  53706. private _enableInteractionOnController;
  53707. private _checkTeleportWithRay;
  53708. private _checkRotate;
  53709. private _checkTeleportBackwards;
  53710. private _enableTeleportationOnController;
  53711. private _createTeleportationCircles;
  53712. private _displayTeleportationTarget;
  53713. private _hideTeleportationTarget;
  53714. private _rotateCamera;
  53715. private _moveTeleportationSelectorTo;
  53716. private _workingVector;
  53717. private _workingQuaternion;
  53718. private _workingMatrix;
  53719. /**
  53720. * Time Constant Teleportation Mode
  53721. */
  53722. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  53723. /**
  53724. * Speed Constant Teleportation Mode
  53725. */
  53726. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  53727. /**
  53728. * Teleports the users feet to the desired location
  53729. * @param location The location where the user's feet should be placed
  53730. */
  53731. teleportCamera(location: Vector3): void;
  53732. private _convertNormalToDirectionOfRay;
  53733. private _castRayAndSelectObject;
  53734. private _notifySelectedMeshUnselected;
  53735. /**
  53736. * Permanently set new colors for the laser pointer
  53737. * @param color the new laser color
  53738. * @param pickedColor the new laser color when picked mesh detected
  53739. */
  53740. setLaserColor(color: Color3, pickedColor?: Color3): void;
  53741. /**
  53742. * Set lighting enabled / disabled on the laser pointer of both controllers
  53743. * @param enabled should the lighting be enabled on the laser pointer
  53744. */
  53745. setLaserLightingState(enabled?: boolean): void;
  53746. /**
  53747. * Permanently set new colors for the gaze pointer
  53748. * @param color the new gaze color
  53749. * @param pickedColor the new gaze color when picked mesh detected
  53750. */
  53751. setGazeColor(color: Color3, pickedColor?: Color3): void;
  53752. /**
  53753. * Sets the color of the laser ray from the vr controllers.
  53754. * @param color new color for the ray.
  53755. */
  53756. changeLaserColor(color: Color3): void;
  53757. /**
  53758. * Sets the color of the ray from the vr headsets gaze.
  53759. * @param color new color for the ray.
  53760. */
  53761. changeGazeColor(color: Color3): void;
  53762. /**
  53763. * Exits VR and disposes of the vr experience helper
  53764. */
  53765. dispose(): void;
  53766. /**
  53767. * Gets the name of the VRExperienceHelper class
  53768. * @returns "VRExperienceHelper"
  53769. */
  53770. getClassName(): string;
  53771. }
  53772. }
  53773. declare module BABYLON {
  53774. /**
  53775. * Contains an array of blocks representing the octree
  53776. */
  53777. export interface IOctreeContainer<T> {
  53778. /**
  53779. * Blocks within the octree
  53780. */
  53781. blocks: Array<OctreeBlock<T>>;
  53782. }
  53783. /**
  53784. * Class used to store a cell in an octree
  53785. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  53786. */
  53787. export class OctreeBlock<T> {
  53788. /**
  53789. * Gets the content of the current block
  53790. */
  53791. entries: T[];
  53792. /**
  53793. * Gets the list of block children
  53794. */
  53795. blocks: Array<OctreeBlock<T>>;
  53796. private _depth;
  53797. private _maxDepth;
  53798. private _capacity;
  53799. private _minPoint;
  53800. private _maxPoint;
  53801. private _boundingVectors;
  53802. private _creationFunc;
  53803. /**
  53804. * Creates a new block
  53805. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  53806. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  53807. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  53808. * @param depth defines the current depth of this block in the octree
  53809. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  53810. * @param creationFunc defines a callback to call when an element is added to the block
  53811. */
  53812. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  53813. /**
  53814. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  53815. */
  53816. get capacity(): number;
  53817. /**
  53818. * Gets the minimum vector (in world space) of the block's bounding box
  53819. */
  53820. get minPoint(): Vector3;
  53821. /**
  53822. * Gets the maximum vector (in world space) of the block's bounding box
  53823. */
  53824. get maxPoint(): Vector3;
  53825. /**
  53826. * Add a new element to this block
  53827. * @param entry defines the element to add
  53828. */
  53829. addEntry(entry: T): void;
  53830. /**
  53831. * Remove an element from this block
  53832. * @param entry defines the element to remove
  53833. */
  53834. removeEntry(entry: T): void;
  53835. /**
  53836. * Add an array of elements to this block
  53837. * @param entries defines the array of elements to add
  53838. */
  53839. addEntries(entries: T[]): void;
  53840. /**
  53841. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  53842. * @param frustumPlanes defines the frustum planes to test
  53843. * @param selection defines the array to store current content if selection is positive
  53844. * @param allowDuplicate defines if the selection array can contains duplicated entries
  53845. */
  53846. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  53847. /**
  53848. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  53849. * @param sphereCenter defines the bounding sphere center
  53850. * @param sphereRadius defines the bounding sphere radius
  53851. * @param selection defines the array to store current content if selection is positive
  53852. * @param allowDuplicate defines if the selection array can contains duplicated entries
  53853. */
  53854. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  53855. /**
  53856. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  53857. * @param ray defines the ray to test with
  53858. * @param selection defines the array to store current content if selection is positive
  53859. */
  53860. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  53861. /**
  53862. * Subdivide the content into child blocks (this block will then be empty)
  53863. */
  53864. createInnerBlocks(): void;
  53865. /**
  53866. * @hidden
  53867. */
  53868. 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;
  53869. }
  53870. }
  53871. declare module BABYLON {
  53872. /**
  53873. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  53874. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  53875. */
  53876. export class Octree<T> {
  53877. /** 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.) */
  53878. maxDepth: number;
  53879. /**
  53880. * Blocks within the octree containing objects
  53881. */
  53882. blocks: Array<OctreeBlock<T>>;
  53883. /**
  53884. * Content stored in the octree
  53885. */
  53886. dynamicContent: T[];
  53887. private _maxBlockCapacity;
  53888. private _selectionContent;
  53889. private _creationFunc;
  53890. /**
  53891. * Creates a octree
  53892. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  53893. * @param creationFunc function to be used to instatiate the octree
  53894. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  53895. * @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.)
  53896. */
  53897. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  53898. /** 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.) */
  53899. maxDepth?: number);
  53900. /**
  53901. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  53902. * @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);
  53903. * @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);
  53904. * @param entries meshes to be added to the octree blocks
  53905. */
  53906. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  53907. /**
  53908. * Adds a mesh to the octree
  53909. * @param entry Mesh to add to the octree
  53910. */
  53911. addMesh(entry: T): void;
  53912. /**
  53913. * Remove an element from the octree
  53914. * @param entry defines the element to remove
  53915. */
  53916. removeMesh(entry: T): void;
  53917. /**
  53918. * Selects an array of meshes within the frustum
  53919. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  53920. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  53921. * @returns array of meshes within the frustum
  53922. */
  53923. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  53924. /**
  53925. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  53926. * @param sphereCenter defines the bounding sphere center
  53927. * @param sphereRadius defines the bounding sphere radius
  53928. * @param allowDuplicate defines if the selection array can contains duplicated entries
  53929. * @returns an array of objects that intersect the sphere
  53930. */
  53931. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  53932. /**
  53933. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  53934. * @param ray defines the ray to test with
  53935. * @returns array of intersected objects
  53936. */
  53937. intersectsRay(ray: Ray): SmartArray<T>;
  53938. /**
  53939. * Adds a mesh into the octree block if it intersects the block
  53940. */
  53941. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  53942. /**
  53943. * Adds a submesh into the octree block if it intersects the block
  53944. */
  53945. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  53946. }
  53947. }
  53948. declare module BABYLON {
  53949. interface Scene {
  53950. /**
  53951. * @hidden
  53952. * Backing Filed
  53953. */
  53954. _selectionOctree: Octree<AbstractMesh>;
  53955. /**
  53956. * Gets the octree used to boost mesh selection (picking)
  53957. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  53958. */
  53959. selectionOctree: Octree<AbstractMesh>;
  53960. /**
  53961. * Creates or updates the octree used to boost selection (picking)
  53962. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  53963. * @param maxCapacity defines the maximum capacity per leaf
  53964. * @param maxDepth defines the maximum depth of the octree
  53965. * @returns an octree of AbstractMesh
  53966. */
  53967. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  53968. }
  53969. interface AbstractMesh {
  53970. /**
  53971. * @hidden
  53972. * Backing Field
  53973. */
  53974. _submeshesOctree: Octree<SubMesh>;
  53975. /**
  53976. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  53977. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  53978. * @param maxCapacity defines the maximum size of each block (64 by default)
  53979. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  53980. * @returns the new octree
  53981. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  53982. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  53983. */
  53984. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  53985. }
  53986. /**
  53987. * Defines the octree scene component responsible to manage any octrees
  53988. * in a given scene.
  53989. */
  53990. export class OctreeSceneComponent {
  53991. /**
  53992. * The component name help to identify the component in the list of scene components.
  53993. */
  53994. readonly name: string;
  53995. /**
  53996. * The scene the component belongs to.
  53997. */
  53998. scene: Scene;
  53999. /**
  54000. * Indicates if the meshes have been checked to make sure they are isEnabled()
  54001. */
  54002. readonly checksIsEnabled: boolean;
  54003. /**
  54004. * Creates a new instance of the component for the given scene
  54005. * @param scene Defines the scene to register the component in
  54006. */
  54007. constructor(scene: Scene);
  54008. /**
  54009. * Registers the component in a given scene
  54010. */
  54011. register(): void;
  54012. /**
  54013. * Return the list of active meshes
  54014. * @returns the list of active meshes
  54015. */
  54016. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  54017. /**
  54018. * Return the list of active sub meshes
  54019. * @param mesh The mesh to get the candidates sub meshes from
  54020. * @returns the list of active sub meshes
  54021. */
  54022. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  54023. private _tempRay;
  54024. /**
  54025. * Return the list of sub meshes intersecting with a given local ray
  54026. * @param mesh defines the mesh to find the submesh for
  54027. * @param localRay defines the ray in local space
  54028. * @returns the list of intersecting sub meshes
  54029. */
  54030. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  54031. /**
  54032. * Return the list of sub meshes colliding with a collider
  54033. * @param mesh defines the mesh to find the submesh for
  54034. * @param collider defines the collider to evaluate the collision against
  54035. * @returns the list of colliding sub meshes
  54036. */
  54037. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  54038. /**
  54039. * Rebuilds the elements related to this component in case of
  54040. * context lost for instance.
  54041. */
  54042. rebuild(): void;
  54043. /**
  54044. * Disposes the component and the associated ressources.
  54045. */
  54046. dispose(): void;
  54047. }
  54048. }
  54049. declare module BABYLON {
  54050. /**
  54051. * Cache built by each axis. Used for managing state between all elements of gizmo for enhanced UI
  54052. */
  54053. export interface GizmoAxisCache {
  54054. /** Mesh used to runder the Gizmo */
  54055. gizmoMeshes: Mesh[];
  54056. /** Mesh used to detect user interaction with Gizmo */
  54057. colliderMeshes: Mesh[];
  54058. /** Material used to inicate color of gizmo mesh */
  54059. material: StandardMaterial;
  54060. /** Material used to inicate hover state of the Gizmo */
  54061. hoverMaterial: StandardMaterial;
  54062. /** Material used to inicate disabled state of the Gizmo */
  54063. disableMaterial: StandardMaterial;
  54064. /** Used to indicate Active state of the Gizmo */
  54065. active: boolean;
  54066. }
  54067. /**
  54068. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  54069. */
  54070. export class Gizmo implements IDisposable {
  54071. /** The utility layer the gizmo will be added to */
  54072. gizmoLayer: UtilityLayerRenderer;
  54073. /**
  54074. * The root mesh of the gizmo
  54075. */
  54076. _rootMesh: Mesh;
  54077. private _attachedMesh;
  54078. private _attachedNode;
  54079. /**
  54080. * Ratio for the scale of the gizmo (Default: 1)
  54081. */
  54082. protected _scaleRatio: number;
  54083. /**
  54084. * boolean updated by pointermove when a gizmo mesh is hovered
  54085. */
  54086. protected _isHovered: boolean;
  54087. /**
  54088. * Ratio for the scale of the gizmo (Default: 1)
  54089. */
  54090. set scaleRatio(value: number);
  54091. get scaleRatio(): number;
  54092. /**
  54093. * True when the mouse pointer is hovered a gizmo mesh
  54094. */
  54095. get isHovered(): boolean;
  54096. /**
  54097. * If a custom mesh has been set (Default: false)
  54098. */
  54099. protected _customMeshSet: boolean;
  54100. /**
  54101. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  54102. * * When set, interactions will be enabled
  54103. */
  54104. get attachedMesh(): Nullable<AbstractMesh>;
  54105. set attachedMesh(value: Nullable<AbstractMesh>);
  54106. /**
  54107. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  54108. * * When set, interactions will be enabled
  54109. */
  54110. get attachedNode(): Nullable<Node>;
  54111. set attachedNode(value: Nullable<Node>);
  54112. /**
  54113. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  54114. * @param mesh The mesh to replace the default mesh of the gizmo
  54115. */
  54116. setCustomMesh(mesh: Mesh): void;
  54117. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  54118. /**
  54119. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  54120. */
  54121. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  54122. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  54123. /**
  54124. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  54125. */
  54126. updateGizmoPositionToMatchAttachedMesh: boolean;
  54127. /**
  54128. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  54129. */
  54130. updateScale: boolean;
  54131. protected _interactionsEnabled: boolean;
  54132. protected _attachedNodeChanged(value: Nullable<Node>): void;
  54133. private _beforeRenderObserver;
  54134. private _tempQuaternion;
  54135. private _tempVector;
  54136. private _tempVector2;
  54137. private _tempMatrix1;
  54138. private _tempMatrix2;
  54139. private _rightHandtoLeftHandMatrix;
  54140. /**
  54141. * Creates a gizmo
  54142. * @param gizmoLayer The utility layer the gizmo will be added to
  54143. */
  54144. constructor(
  54145. /** The utility layer the gizmo will be added to */
  54146. gizmoLayer?: UtilityLayerRenderer);
  54147. /**
  54148. * Updates the gizmo to match the attached mesh's position/rotation
  54149. */
  54150. protected _update(): void;
  54151. /**
  54152. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  54153. * @param value Node, TransformNode or mesh
  54154. */
  54155. protected _matrixChanged(): void;
  54156. /**
  54157. * Subscribes to pointer up, down, and hover events. Used for responsive gizmos.
  54158. * @param gizmoLayer The utility layer the gizmo will be added to
  54159. * @param gizmoAxisCache Gizmo axis definition used for reactive gizmo UI
  54160. * @returns {Observer<PointerInfo>} pointerObserver
  54161. */
  54162. static GizmoAxisPointerObserver(gizmoLayer: UtilityLayerRenderer, gizmoAxisCache: Map<Mesh, GizmoAxisCache>): Observer<PointerInfo>;
  54163. /**
  54164. * Disposes of the gizmo
  54165. */
  54166. dispose(): void;
  54167. }
  54168. }
  54169. declare module BABYLON {
  54170. /**
  54171. * Single plane drag gizmo
  54172. */
  54173. export class PlaneDragGizmo extends Gizmo {
  54174. /**
  54175. * Drag behavior responsible for the gizmos dragging interactions
  54176. */
  54177. dragBehavior: PointerDragBehavior;
  54178. private _pointerObserver;
  54179. /**
  54180. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  54181. */
  54182. snapDistance: number;
  54183. /**
  54184. * Event that fires each time the gizmo snaps to a new location.
  54185. * * snapDistance is the the change in distance
  54186. */
  54187. onSnapObservable: Observable<{
  54188. snapDistance: number;
  54189. }>;
  54190. private _gizmoMesh;
  54191. private _coloredMaterial;
  54192. private _hoverMaterial;
  54193. private _disableMaterial;
  54194. private _isEnabled;
  54195. private _parent;
  54196. private _dragging;
  54197. /** @hidden */
  54198. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  54199. /**
  54200. * Creates a PlaneDragGizmo
  54201. * @param gizmoLayer The utility layer the gizmo will be added to
  54202. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  54203. * @param color The color of the gizmo
  54204. */
  54205. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  54206. protected _attachedNodeChanged(value: Nullable<Node>): void;
  54207. /**
  54208. * If the gizmo is enabled
  54209. */
  54210. set isEnabled(value: boolean);
  54211. get isEnabled(): boolean;
  54212. /**
  54213. * Disposes of the gizmo
  54214. */
  54215. dispose(): void;
  54216. }
  54217. }
  54218. declare module BABYLON {
  54219. /**
  54220. * Single plane rotation gizmo
  54221. */
  54222. export class PlaneRotationGizmo extends Gizmo {
  54223. /**
  54224. * Drag behavior responsible for the gizmos dragging interactions
  54225. */
  54226. dragBehavior: PointerDragBehavior;
  54227. private _pointerObserver;
  54228. /**
  54229. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  54230. */
  54231. snapDistance: number;
  54232. /**
  54233. * Event that fires each time the gizmo snaps to a new location.
  54234. * * snapDistance is the the change in distance
  54235. */
  54236. onSnapObservable: Observable<{
  54237. snapDistance: number;
  54238. }>;
  54239. private _isEnabled;
  54240. private _parent;
  54241. private _coloredMaterial;
  54242. private _hoverMaterial;
  54243. private _disableMaterial;
  54244. private _gizmoMesh;
  54245. private _rotationCircle;
  54246. private _dragging;
  54247. private static _CircleConstants;
  54248. /**
  54249. * Creates a PlaneRotationGizmo
  54250. * @param gizmoLayer The utility layer the gizmo will be added to
  54251. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  54252. * @param color The color of the gizmo
  54253. * @param tessellation Amount of tessellation to be used when creating rotation circles
  54254. * @param useEulerRotation Use and update Euler angle instead of quaternion
  54255. * @param thickness display gizmo axis thickness
  54256. */
  54257. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  54258. /** Create Geometry for Gizmo */
  54259. private _createGizmoMesh;
  54260. protected _attachedNodeChanged(value: Nullable<Node>): void;
  54261. private setupRotationCircle;
  54262. private updateRotationPath;
  54263. private updateRotationCircle;
  54264. /**
  54265. * If the gizmo is enabled
  54266. */
  54267. set isEnabled(value: boolean);
  54268. get isEnabled(): boolean;
  54269. /**
  54270. * Disposes of the gizmo
  54271. */
  54272. dispose(): void;
  54273. }
  54274. }
  54275. declare module BABYLON {
  54276. /**
  54277. * Gizmo that enables rotating a mesh along 3 axis
  54278. */
  54279. export class RotationGizmo extends Gizmo {
  54280. /**
  54281. * Internal gizmo used for interactions on the x axis
  54282. */
  54283. xGizmo: PlaneRotationGizmo;
  54284. /**
  54285. * Internal gizmo used for interactions on the y axis
  54286. */
  54287. yGizmo: PlaneRotationGizmo;
  54288. /**
  54289. * Internal gizmo used for interactions on the z axis
  54290. */
  54291. zGizmo: PlaneRotationGizmo;
  54292. /** Fires an event when any of it's sub gizmos are dragged */
  54293. onDragStartObservable: Observable<unknown>;
  54294. /** Fires an event when any of it's sub gizmos are released from dragging */
  54295. onDragEndObservable: Observable<unknown>;
  54296. private _meshAttached;
  54297. private _nodeAttached;
  54298. private _observables;
  54299. /** Node Caching for quick lookup */
  54300. private _gizmoAxisCache;
  54301. get attachedMesh(): Nullable<AbstractMesh>;
  54302. set attachedMesh(mesh: Nullable<AbstractMesh>);
  54303. get attachedNode(): Nullable<Node>;
  54304. set attachedNode(node: Nullable<Node>);
  54305. protected _checkBillboardTransform(): void;
  54306. /**
  54307. * True when the mouse pointer is hovering a gizmo mesh
  54308. */
  54309. get isHovered(): boolean;
  54310. /**
  54311. * Creates a RotationGizmo
  54312. * @param gizmoLayer The utility layer the gizmo will be added to
  54313. * @param tessellation Amount of tessellation to be used when creating rotation circles
  54314. * @param useEulerRotation Use and update Euler angle instead of quaternion
  54315. * @param thickness display gizmo axis thickness
  54316. */
  54317. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number, gizmoManager?: GizmoManager);
  54318. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  54319. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  54320. /**
  54321. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  54322. */
  54323. set snapDistance(value: number);
  54324. get snapDistance(): number;
  54325. /**
  54326. * Ratio for the scale of the gizmo (Default: 1)
  54327. */
  54328. set scaleRatio(value: number);
  54329. get scaleRatio(): number;
  54330. /**
  54331. * Builds Gizmo Axis Cache to enable features such as hover state preservation and graying out other axis during manipulation
  54332. * @param mesh Axis gizmo mesh
  54333. * @param cache Gizmo axis definition used for reactive gizmo UI
  54334. */
  54335. addToAxisCache(mesh: Mesh, cache: GizmoAxisCache): void;
  54336. /**
  54337. * Disposes of the gizmo
  54338. */
  54339. dispose(): void;
  54340. /**
  54341. * CustomMeshes are not supported by this gizmo
  54342. * @param mesh The mesh to replace the default mesh of the gizmo
  54343. */
  54344. setCustomMesh(mesh: Mesh): void;
  54345. }
  54346. }
  54347. declare module BABYLON {
  54348. /**
  54349. * Class containing static functions to help procedurally build meshes
  54350. */
  54351. export class PolyhedronBuilder {
  54352. /**
  54353. * Creates a polyhedron mesh
  54354. * * 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
  54355. * * The parameter `size` (positive float, default 1) sets the polygon size
  54356. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  54357. * * 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`
  54358. * * 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
  54359. * * 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)`)
  54360. * * 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
  54361. * * 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
  54362. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  54363. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  54364. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  54365. * @param name defines the name of the mesh
  54366. * @param options defines the options used to create the mesh
  54367. * @param scene defines the hosting scene
  54368. * @returns the polyhedron mesh
  54369. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  54370. */
  54371. static CreatePolyhedron(name: string, options: {
  54372. type?: number;
  54373. size?: number;
  54374. sizeX?: number;
  54375. sizeY?: number;
  54376. sizeZ?: number;
  54377. custom?: any;
  54378. faceUV?: Vector4[];
  54379. faceColors?: Color4[];
  54380. flat?: boolean;
  54381. updatable?: boolean;
  54382. sideOrientation?: number;
  54383. frontUVs?: Vector4;
  54384. backUVs?: Vector4;
  54385. }, scene?: Nullable<Scene>): Mesh;
  54386. }
  54387. }
  54388. declare module BABYLON {
  54389. /**
  54390. * Class containing static functions to help procedurally build meshes
  54391. */
  54392. export class BoxBuilder {
  54393. /**
  54394. * Creates a box mesh
  54395. * * The parameter `size` sets the size (float) of each box side (default 1)
  54396. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  54397. * * 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)
  54398. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  54399. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  54400. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  54401. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  54402. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  54403. * @param name defines the name of the mesh
  54404. * @param options defines the options used to create the mesh
  54405. * @param scene defines the hosting scene
  54406. * @returns the box mesh
  54407. */
  54408. static CreateBox(name: string, options: {
  54409. size?: number;
  54410. width?: number;
  54411. height?: number;
  54412. depth?: number;
  54413. faceUV?: Vector4[];
  54414. faceColors?: Color4[];
  54415. sideOrientation?: number;
  54416. frontUVs?: Vector4;
  54417. backUVs?: Vector4;
  54418. wrap?: boolean;
  54419. topBaseAt?: number;
  54420. bottomBaseAt?: number;
  54421. updatable?: boolean;
  54422. }, scene?: Nullable<Scene>): Mesh;
  54423. }
  54424. }
  54425. declare module BABYLON {
  54426. /**
  54427. * Single axis scale gizmo
  54428. */
  54429. export class AxisScaleGizmo extends Gizmo {
  54430. /**
  54431. * Drag behavior responsible for the gizmos dragging interactions
  54432. */
  54433. dragBehavior: PointerDragBehavior;
  54434. private _pointerObserver;
  54435. /**
  54436. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  54437. */
  54438. snapDistance: number;
  54439. /**
  54440. * Event that fires each time the gizmo snaps to a new location.
  54441. * * snapDistance is the the change in distance
  54442. */
  54443. onSnapObservable: Observable<{
  54444. snapDistance: number;
  54445. }>;
  54446. /**
  54447. * If the scaling operation should be done on all axis (default: false)
  54448. */
  54449. uniformScaling: boolean;
  54450. /**
  54451. * Custom sensitivity value for the drag strength
  54452. */
  54453. sensitivity: number;
  54454. private _isEnabled;
  54455. private _parent;
  54456. private _gizmoMesh;
  54457. private _coloredMaterial;
  54458. private _hoverMaterial;
  54459. private _disableMaterial;
  54460. private _dragging;
  54461. /**
  54462. * Creates an AxisScaleGizmo
  54463. * @param gizmoLayer The utility layer the gizmo will be added to
  54464. * @param dragAxis The axis which the gizmo will be able to scale on
  54465. * @param color The color of the gizmo
  54466. * @param thickness display gizmo axis thickness
  54467. */
  54468. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  54469. /** Create Geometry for Gizmo */
  54470. private _createGizmoMesh;
  54471. protected _attachedNodeChanged(value: Nullable<Node>): void;
  54472. /**
  54473. * If the gizmo is enabled
  54474. */
  54475. set isEnabled(value: boolean);
  54476. get isEnabled(): boolean;
  54477. /**
  54478. * Disposes of the gizmo
  54479. */
  54480. dispose(): void;
  54481. /**
  54482. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  54483. * @param mesh The mesh to replace the default mesh of the gizmo
  54484. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  54485. */
  54486. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  54487. }
  54488. }
  54489. declare module BABYLON {
  54490. /**
  54491. * Gizmo that enables scaling a mesh along 3 axis
  54492. */
  54493. export class ScaleGizmo extends Gizmo {
  54494. /**
  54495. * Internal gizmo used for interactions on the x axis
  54496. */
  54497. xGizmo: AxisScaleGizmo;
  54498. /**
  54499. * Internal gizmo used for interactions on the y axis
  54500. */
  54501. yGizmo: AxisScaleGizmo;
  54502. /**
  54503. * Internal gizmo used for interactions on the z axis
  54504. */
  54505. zGizmo: AxisScaleGizmo;
  54506. /**
  54507. * Internal gizmo used to scale all axis equally
  54508. */
  54509. uniformScaleGizmo: AxisScaleGizmo;
  54510. private _meshAttached;
  54511. private _nodeAttached;
  54512. private _snapDistance;
  54513. private _uniformScalingMesh;
  54514. private _octahedron;
  54515. private _sensitivity;
  54516. private _coloredMaterial;
  54517. private _hoverMaterial;
  54518. private _disableMaterial;
  54519. private _observables;
  54520. /** Node Caching for quick lookup */
  54521. private _gizmoAxisCache;
  54522. /** Fires an event when any of it's sub gizmos are dragged */
  54523. onDragStartObservable: Observable<unknown>;
  54524. /** Fires an event when any of it's sub gizmos are released from dragging */
  54525. onDragEndObservable: Observable<unknown>;
  54526. get attachedMesh(): Nullable<AbstractMesh>;
  54527. set attachedMesh(mesh: Nullable<AbstractMesh>);
  54528. get attachedNode(): Nullable<Node>;
  54529. set attachedNode(node: Nullable<Node>);
  54530. /**
  54531. * True when the mouse pointer is hovering a gizmo mesh
  54532. */
  54533. get isHovered(): boolean;
  54534. /**
  54535. * Creates a ScaleGizmo
  54536. * @param gizmoLayer The utility layer the gizmo will be added to
  54537. * @param thickness display gizmo axis thickness
  54538. */
  54539. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number, gizmoManager?: GizmoManager);
  54540. /** Create Geometry for Gizmo */
  54541. private _createUniformScaleMesh;
  54542. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  54543. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  54544. /**
  54545. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  54546. */
  54547. set snapDistance(value: number);
  54548. get snapDistance(): number;
  54549. /**
  54550. * Ratio for the scale of the gizmo (Default: 1)
  54551. */
  54552. set scaleRatio(value: number);
  54553. get scaleRatio(): number;
  54554. /**
  54555. * Sensitivity factor for dragging (Default: 1)
  54556. */
  54557. set sensitivity(value: number);
  54558. get sensitivity(): number;
  54559. /**
  54560. * Builds Gizmo Axis Cache to enable features such as hover state preservation and graying out other axis during manipulation
  54561. * @param mesh Axis gizmo mesh
  54562. * @param cache Gizmo axis definition used for reactive gizmo UI
  54563. */
  54564. addToAxisCache(mesh: Mesh, cache: GizmoAxisCache): void;
  54565. /**
  54566. * Disposes of the gizmo
  54567. */
  54568. dispose(): void;
  54569. }
  54570. }
  54571. declare module BABYLON {
  54572. /**
  54573. * Bounding box gizmo
  54574. */
  54575. export class BoundingBoxGizmo extends Gizmo {
  54576. private _lineBoundingBox;
  54577. private _rotateSpheresParent;
  54578. private _scaleBoxesParent;
  54579. private _boundingDimensions;
  54580. private _renderObserver;
  54581. private _pointerObserver;
  54582. private _scaleDragSpeed;
  54583. private _tmpQuaternion;
  54584. private _tmpVector;
  54585. private _tmpRotationMatrix;
  54586. /**
  54587. * 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)
  54588. */
  54589. ignoreChildren: boolean;
  54590. /**
  54591. * 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)
  54592. */
  54593. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  54594. /**
  54595. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  54596. */
  54597. rotationSphereSize: number;
  54598. /**
  54599. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  54600. */
  54601. scaleBoxSize: number;
  54602. /**
  54603. * 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)
  54604. */
  54605. fixedDragMeshScreenSize: boolean;
  54606. /**
  54607. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  54608. */
  54609. fixedDragMeshScreenSizeDistanceFactor: number;
  54610. /**
  54611. * Fired when a rotation sphere or scale box is dragged
  54612. */
  54613. onDragStartObservable: Observable<{}>;
  54614. /**
  54615. * Fired when a scale box is dragged
  54616. */
  54617. onScaleBoxDragObservable: Observable<{}>;
  54618. /**
  54619. * Fired when a scale box drag is ended
  54620. */
  54621. onScaleBoxDragEndObservable: Observable<{}>;
  54622. /**
  54623. * Fired when a rotation sphere is dragged
  54624. */
  54625. onRotationSphereDragObservable: Observable<{}>;
  54626. /**
  54627. * Fired when a rotation sphere drag is ended
  54628. */
  54629. onRotationSphereDragEndObservable: Observable<{}>;
  54630. /**
  54631. * Relative bounding box pivot used when scaling the attached node. 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)
  54632. */
  54633. scalePivot: Nullable<Vector3>;
  54634. /**
  54635. * Mesh used as a pivot to rotate the attached node
  54636. */
  54637. private _anchorMesh;
  54638. private _existingMeshScale;
  54639. private _dragMesh;
  54640. private pointerDragBehavior;
  54641. private coloredMaterial;
  54642. private hoverColoredMaterial;
  54643. /**
  54644. * Sets the color of the bounding box gizmo
  54645. * @param color the color to set
  54646. */
  54647. setColor(color: Color3): void;
  54648. /**
  54649. * Creates an BoundingBoxGizmo
  54650. * @param gizmoLayer The utility layer the gizmo will be added to
  54651. * @param color The color of the gizmo
  54652. */
  54653. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  54654. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  54655. private _selectNode;
  54656. /**
  54657. * Updates the bounding box information for the Gizmo
  54658. */
  54659. updateBoundingBox(): void;
  54660. private _updateRotationSpheres;
  54661. private _updateScaleBoxes;
  54662. /**
  54663. * Enables rotation on the specified axis and disables rotation on the others
  54664. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  54665. */
  54666. setEnabledRotationAxis(axis: string): void;
  54667. /**
  54668. * Enables/disables scaling
  54669. * @param enable if scaling should be enabled
  54670. * @param homogeneousScaling defines if scaling should only be homogeneous
  54671. */
  54672. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  54673. private _updateDummy;
  54674. /**
  54675. * Enables a pointer drag behavior on the bounding box of the gizmo
  54676. */
  54677. enableDragBehavior(): void;
  54678. /**
  54679. * Disposes of the gizmo
  54680. */
  54681. dispose(): void;
  54682. /**
  54683. * 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)
  54684. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  54685. * @returns the bounding box mesh with the passed in mesh as a child
  54686. */
  54687. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  54688. /**
  54689. * CustomMeshes are not supported by this gizmo
  54690. * @param mesh The mesh to replace the default mesh of the gizmo
  54691. */
  54692. setCustomMesh(mesh: Mesh): void;
  54693. }
  54694. }
  54695. declare module BABYLON {
  54696. /**
  54697. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  54698. */
  54699. export class GizmoManager implements IDisposable {
  54700. private scene;
  54701. /**
  54702. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  54703. */
  54704. gizmos: {
  54705. positionGizmo: Nullable<PositionGizmo>;
  54706. rotationGizmo: Nullable<RotationGizmo>;
  54707. scaleGizmo: Nullable<ScaleGizmo>;
  54708. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  54709. };
  54710. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  54711. clearGizmoOnEmptyPointerEvent: boolean;
  54712. /** Fires an event when the manager is attached to a mesh */
  54713. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  54714. /** Fires an event when the manager is attached to a node */
  54715. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  54716. private _gizmosEnabled;
  54717. private _pointerObservers;
  54718. private _attachedMesh;
  54719. private _attachedNode;
  54720. private _boundingBoxColor;
  54721. private _defaultUtilityLayer;
  54722. private _defaultKeepDepthUtilityLayer;
  54723. private _thickness;
  54724. /** Node Caching for quick lookup */
  54725. private _gizmoAxisCache;
  54726. /**
  54727. * When bounding box gizmo is enabled, this can be used to track drag/end events
  54728. */
  54729. boundingBoxDragBehavior: SixDofDragBehavior;
  54730. /**
  54731. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  54732. */
  54733. attachableMeshes: Nullable<Array<AbstractMesh>>;
  54734. /**
  54735. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  54736. */
  54737. attachableNodes: Nullable<Array<Node>>;
  54738. /**
  54739. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  54740. */
  54741. usePointerToAttachGizmos: boolean;
  54742. /**
  54743. * Utility layer that the bounding box gizmo belongs to
  54744. */
  54745. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  54746. /**
  54747. * Utility layer that all gizmos besides bounding box belong to
  54748. */
  54749. get utilityLayer(): UtilityLayerRenderer;
  54750. /**
  54751. * True when the mouse pointer is hovering a gizmo mesh
  54752. */
  54753. get isHovered(): boolean;
  54754. /**
  54755. * Instatiates a gizmo manager
  54756. * @param scene the scene to overlay the gizmos on top of
  54757. * @param thickness display gizmo axis thickness
  54758. * @param utilityLayer the layer where gizmos are rendered
  54759. * @param keepDepthUtilityLayer the layer where occluded gizmos are rendered
  54760. */
  54761. constructor(scene: Scene, thickness?: number, utilityLayer?: UtilityLayerRenderer, keepDepthUtilityLayer?: UtilityLayerRenderer);
  54762. /**
  54763. * Subscribes to pointer down events, for attaching and detaching mesh
  54764. * @param scene The sceme layer the observer will be added to
  54765. */
  54766. private _attachToMeshPointerObserver;
  54767. /**
  54768. * Attaches a set of gizmos to the specified mesh
  54769. * @param mesh The mesh the gizmo's should be attached to
  54770. */
  54771. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  54772. /**
  54773. * Attaches a set of gizmos to the specified node
  54774. * @param node The node the gizmo's should be attached to
  54775. */
  54776. attachToNode(node: Nullable<Node>): void;
  54777. /**
  54778. * If the position gizmo is enabled
  54779. */
  54780. set positionGizmoEnabled(value: boolean);
  54781. get positionGizmoEnabled(): boolean;
  54782. /**
  54783. * If the rotation gizmo is enabled
  54784. */
  54785. set rotationGizmoEnabled(value: boolean);
  54786. get rotationGizmoEnabled(): boolean;
  54787. /**
  54788. * If the scale gizmo is enabled
  54789. */
  54790. set scaleGizmoEnabled(value: boolean);
  54791. get scaleGizmoEnabled(): boolean;
  54792. /**
  54793. * If the boundingBox gizmo is enabled
  54794. */
  54795. set boundingBoxGizmoEnabled(value: boolean);
  54796. get boundingBoxGizmoEnabled(): boolean;
  54797. /**
  54798. * Builds Gizmo Axis Cache to enable features such as hover state preservation and graying out other axis during manipulation
  54799. * @param gizmoAxisCache Gizmo axis definition used for reactive gizmo UI
  54800. */
  54801. addToAxisCache(gizmoAxisCache: Map<Mesh, GizmoAxisCache>): void;
  54802. /**
  54803. * Disposes of the gizmo manager
  54804. */
  54805. dispose(): void;
  54806. }
  54807. }
  54808. declare module BABYLON {
  54809. /**
  54810. * Gizmo that enables dragging a mesh along 3 axis
  54811. */
  54812. export class PositionGizmo extends Gizmo {
  54813. /**
  54814. * Internal gizmo used for interactions on the x axis
  54815. */
  54816. xGizmo: AxisDragGizmo;
  54817. /**
  54818. * Internal gizmo used for interactions on the y axis
  54819. */
  54820. yGizmo: AxisDragGizmo;
  54821. /**
  54822. * Internal gizmo used for interactions on the z axis
  54823. */
  54824. zGizmo: AxisDragGizmo;
  54825. /**
  54826. * Internal gizmo used for interactions on the yz plane
  54827. */
  54828. xPlaneGizmo: PlaneDragGizmo;
  54829. /**
  54830. * Internal gizmo used for interactions on the xz plane
  54831. */
  54832. yPlaneGizmo: PlaneDragGizmo;
  54833. /**
  54834. * Internal gizmo used for interactions on the xy plane
  54835. */
  54836. zPlaneGizmo: PlaneDragGizmo;
  54837. /**
  54838. * private variables
  54839. */
  54840. private _meshAttached;
  54841. private _nodeAttached;
  54842. private _snapDistance;
  54843. private _observables;
  54844. /** Node Caching for quick lookup */
  54845. private _gizmoAxisCache;
  54846. /** Fires an event when any of it's sub gizmos are dragged */
  54847. onDragStartObservable: Observable<unknown>;
  54848. /** Fires an event when any of it's sub gizmos are released from dragging */
  54849. onDragEndObservable: Observable<unknown>;
  54850. /**
  54851. * If set to true, planar drag is enabled
  54852. */
  54853. private _planarGizmoEnabled;
  54854. get attachedMesh(): Nullable<AbstractMesh>;
  54855. set attachedMesh(mesh: Nullable<AbstractMesh>);
  54856. get attachedNode(): Nullable<Node>;
  54857. set attachedNode(node: Nullable<Node>);
  54858. /**
  54859. * True when the mouse pointer is hovering a gizmo mesh
  54860. */
  54861. get isHovered(): boolean;
  54862. /**
  54863. * Creates a PositionGizmo
  54864. * @param gizmoLayer The utility layer the gizmo will be added to
  54865. @param thickness display gizmo axis thickness
  54866. */
  54867. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number, gizmoManager?: GizmoManager);
  54868. /**
  54869. * If the planar drag gizmo is enabled
  54870. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  54871. */
  54872. set planarGizmoEnabled(value: boolean);
  54873. get planarGizmoEnabled(): boolean;
  54874. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  54875. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  54876. /**
  54877. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  54878. */
  54879. set snapDistance(value: number);
  54880. get snapDistance(): number;
  54881. /**
  54882. * Ratio for the scale of the gizmo (Default: 1)
  54883. */
  54884. set scaleRatio(value: number);
  54885. get scaleRatio(): number;
  54886. /**
  54887. * Builds Gizmo Axis Cache to enable features such as hover state preservation and graying out other axis during manipulation
  54888. * @param mesh Axis gizmo mesh
  54889. * @param cache Gizmo axis definition used for reactive gizmo UI
  54890. */
  54891. addToAxisCache(mesh: Mesh, cache: GizmoAxisCache): void;
  54892. /**
  54893. * Disposes of the gizmo
  54894. */
  54895. dispose(): void;
  54896. /**
  54897. * CustomMeshes are not supported by this gizmo
  54898. * @param mesh The mesh to replace the default mesh of the gizmo
  54899. */
  54900. setCustomMesh(mesh: Mesh): void;
  54901. }
  54902. }
  54903. declare module BABYLON {
  54904. /**
  54905. * Single axis drag gizmo
  54906. */
  54907. export class AxisDragGizmo extends Gizmo {
  54908. /**
  54909. * Drag behavior responsible for the gizmos dragging interactions
  54910. */
  54911. dragBehavior: PointerDragBehavior;
  54912. private _pointerObserver;
  54913. /**
  54914. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  54915. */
  54916. snapDistance: number;
  54917. /**
  54918. * Event that fires each time the gizmo snaps to a new location.
  54919. * * snapDistance is the the change in distance
  54920. */
  54921. onSnapObservable: Observable<{
  54922. snapDistance: number;
  54923. }>;
  54924. private _isEnabled;
  54925. private _parent;
  54926. private _gizmoMesh;
  54927. private _coloredMaterial;
  54928. private _hoverMaterial;
  54929. private _disableMaterial;
  54930. private _dragging;
  54931. /** @hidden */
  54932. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number, isCollider?: boolean): TransformNode;
  54933. /** @hidden */
  54934. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  54935. /**
  54936. * Creates an AxisDragGizmo
  54937. * @param gizmoLayer The utility layer the gizmo will be added to
  54938. * @param dragAxis The axis which the gizmo will be able to drag on
  54939. * @param color The color of the gizmo
  54940. * @param thickness display gizmo axis thickness
  54941. */
  54942. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  54943. protected _attachedNodeChanged(value: Nullable<Node>): void;
  54944. /**
  54945. * If the gizmo is enabled
  54946. */
  54947. set isEnabled(value: boolean);
  54948. get isEnabled(): boolean;
  54949. /**
  54950. * Disposes of the gizmo
  54951. */
  54952. dispose(): void;
  54953. }
  54954. }
  54955. declare module BABYLON.Debug {
  54956. /**
  54957. * The Axes viewer will show 3 axes in a specific point in space
  54958. */
  54959. export class AxesViewer {
  54960. private _xAxis;
  54961. private _yAxis;
  54962. private _zAxis;
  54963. private _scaleLinesFactor;
  54964. private _instanced;
  54965. /**
  54966. * Gets the hosting scene
  54967. */
  54968. scene: Nullable<Scene>;
  54969. /**
  54970. * Gets or sets a number used to scale line length
  54971. */
  54972. scaleLines: number;
  54973. /** Gets the node hierarchy used to render x-axis */
  54974. get xAxis(): TransformNode;
  54975. /** Gets the node hierarchy used to render y-axis */
  54976. get yAxis(): TransformNode;
  54977. /** Gets the node hierarchy used to render z-axis */
  54978. get zAxis(): TransformNode;
  54979. /**
  54980. * Creates a new AxesViewer
  54981. * @param scene defines the hosting scene
  54982. * @param scaleLines defines a number used to scale line length (1 by default)
  54983. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  54984. * @param xAxis defines the node hierarchy used to render the x-axis
  54985. * @param yAxis defines the node hierarchy used to render the y-axis
  54986. * @param zAxis defines the node hierarchy used to render the z-axis
  54987. */
  54988. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  54989. /**
  54990. * Force the viewer to update
  54991. * @param position defines the position of the viewer
  54992. * @param xaxis defines the x axis of the viewer
  54993. * @param yaxis defines the y axis of the viewer
  54994. * @param zaxis defines the z axis of the viewer
  54995. */
  54996. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  54997. /**
  54998. * Creates an instance of this axes viewer.
  54999. * @returns a new axes viewer with instanced meshes
  55000. */
  55001. createInstance(): AxesViewer;
  55002. /** Releases resources */
  55003. dispose(): void;
  55004. private static _SetRenderingGroupId;
  55005. }
  55006. }
  55007. declare module BABYLON.Debug {
  55008. /**
  55009. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  55010. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  55011. */
  55012. export class BoneAxesViewer extends AxesViewer {
  55013. /**
  55014. * Gets or sets the target mesh where to display the axes viewer
  55015. */
  55016. mesh: Nullable<Mesh>;
  55017. /**
  55018. * Gets or sets the target bone where to display the axes viewer
  55019. */
  55020. bone: Nullable<Bone>;
  55021. /** Gets current position */
  55022. pos: Vector3;
  55023. /** Gets direction of X axis */
  55024. xaxis: Vector3;
  55025. /** Gets direction of Y axis */
  55026. yaxis: Vector3;
  55027. /** Gets direction of Z axis */
  55028. zaxis: Vector3;
  55029. /**
  55030. * Creates a new BoneAxesViewer
  55031. * @param scene defines the hosting scene
  55032. * @param bone defines the target bone
  55033. * @param mesh defines the target mesh
  55034. * @param scaleLines defines a scaling factor for line length (1 by default)
  55035. */
  55036. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  55037. /**
  55038. * Force the viewer to update
  55039. */
  55040. update(): void;
  55041. /** Releases resources */
  55042. dispose(): void;
  55043. }
  55044. }
  55045. declare module BABYLON {
  55046. /**
  55047. * Interface used to define scene explorer extensibility option
  55048. */
  55049. export interface IExplorerExtensibilityOption {
  55050. /**
  55051. * Define the option label
  55052. */
  55053. label: string;
  55054. /**
  55055. * Defines the action to execute on click
  55056. */
  55057. action: (entity: any) => void;
  55058. }
  55059. /**
  55060. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  55061. */
  55062. export interface IExplorerExtensibilityGroup {
  55063. /**
  55064. * Defines a predicate to test if a given type mut be extended
  55065. */
  55066. predicate: (entity: any) => boolean;
  55067. /**
  55068. * Gets the list of options added to a type
  55069. */
  55070. entries: IExplorerExtensibilityOption[];
  55071. }
  55072. /**
  55073. * Interface used to define the options to use to create the Inspector
  55074. */
  55075. export interface IInspectorOptions {
  55076. /**
  55077. * Display in overlay mode (default: false)
  55078. */
  55079. overlay?: boolean;
  55080. /**
  55081. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  55082. */
  55083. globalRoot?: HTMLElement;
  55084. /**
  55085. * Display the Scene explorer
  55086. */
  55087. showExplorer?: boolean;
  55088. /**
  55089. * Display the property inspector
  55090. */
  55091. showInspector?: boolean;
  55092. /**
  55093. * Display in embed mode (both panes on the right)
  55094. */
  55095. embedMode?: boolean;
  55096. /**
  55097. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  55098. */
  55099. handleResize?: boolean;
  55100. /**
  55101. * Allow the panes to popup (default: true)
  55102. */
  55103. enablePopup?: boolean;
  55104. /**
  55105. * Allow the panes to be closed by users (default: true)
  55106. */
  55107. enableClose?: boolean;
  55108. /**
  55109. * Optional list of extensibility entries
  55110. */
  55111. explorerExtensibility?: IExplorerExtensibilityGroup[];
  55112. /**
  55113. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  55114. */
  55115. inspectorURL?: string;
  55116. /**
  55117. * Optional initial tab (default to DebugLayerTab.Properties)
  55118. */
  55119. initialTab?: DebugLayerTab;
  55120. }
  55121. interface Scene {
  55122. /**
  55123. * @hidden
  55124. * Backing field
  55125. */
  55126. _debugLayer: DebugLayer;
  55127. /**
  55128. * Gets the debug layer (aka Inspector) associated with the scene
  55129. * @see https://doc.babylonjs.com/features/playground_debuglayer
  55130. */
  55131. debugLayer: DebugLayer;
  55132. }
  55133. /**
  55134. * Enum of inspector action tab
  55135. */
  55136. export enum DebugLayerTab {
  55137. /**
  55138. * Properties tag (default)
  55139. */
  55140. Properties = 0,
  55141. /**
  55142. * Debug tab
  55143. */
  55144. Debug = 1,
  55145. /**
  55146. * Statistics tab
  55147. */
  55148. Statistics = 2,
  55149. /**
  55150. * Tools tab
  55151. */
  55152. Tools = 3,
  55153. /**
  55154. * Settings tab
  55155. */
  55156. Settings = 4
  55157. }
  55158. /**
  55159. * The debug layer (aka Inspector) is the go to tool in order to better understand
  55160. * what is happening in your scene
  55161. * @see https://doc.babylonjs.com/features/playground_debuglayer
  55162. */
  55163. export class DebugLayer {
  55164. /**
  55165. * Define the url to get the inspector script from.
  55166. * By default it uses the babylonjs CDN.
  55167. * @ignoreNaming
  55168. */
  55169. static InspectorURL: string;
  55170. private _scene;
  55171. private BJSINSPECTOR;
  55172. private _onPropertyChangedObservable?;
  55173. /**
  55174. * Observable triggered when a property is changed through the inspector.
  55175. */
  55176. get onPropertyChangedObservable(): any;
  55177. /**
  55178. * Instantiates a new debug layer.
  55179. * The debug layer (aka Inspector) is the go to tool in order to better understand
  55180. * what is happening in your scene
  55181. * @see https://doc.babylonjs.com/features/playground_debuglayer
  55182. * @param scene Defines the scene to inspect
  55183. */
  55184. constructor(scene: Scene);
  55185. /** Creates the inspector window. */
  55186. private _createInspector;
  55187. /**
  55188. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  55189. * @param entity defines the entity to select
  55190. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  55191. */
  55192. select(entity: any, lineContainerTitles?: string | string[]): void;
  55193. /** Get the inspector from bundle or global */
  55194. private _getGlobalInspector;
  55195. /**
  55196. * Get if the inspector is visible or not.
  55197. * @returns true if visible otherwise, false
  55198. */
  55199. isVisible(): boolean;
  55200. /**
  55201. * Hide the inspector and close its window.
  55202. */
  55203. hide(): void;
  55204. /**
  55205. * Update the scene in the inspector
  55206. */
  55207. setAsActiveScene(): void;
  55208. /**
  55209. * Launch the debugLayer.
  55210. * @param config Define the configuration of the inspector
  55211. * @return a promise fulfilled when the debug layer is visible
  55212. */
  55213. show(config?: IInspectorOptions): Promise<DebugLayer>;
  55214. }
  55215. }
  55216. declare module BABYLON.Debug {
  55217. /**
  55218. * Used to show the physics impostor around the specific mesh
  55219. */
  55220. export class PhysicsViewer {
  55221. /** @hidden */
  55222. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  55223. /** @hidden */
  55224. protected _meshes: Array<Nullable<AbstractMesh>>;
  55225. /** @hidden */
  55226. protected _scene: Nullable<Scene>;
  55227. /** @hidden */
  55228. protected _numMeshes: number;
  55229. /** @hidden */
  55230. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  55231. private _renderFunction;
  55232. private _utilityLayer;
  55233. private _debugBoxMesh;
  55234. private _debugSphereMesh;
  55235. private _debugCylinderMesh;
  55236. private _debugMaterial;
  55237. private _debugMeshMeshes;
  55238. /**
  55239. * Creates a new PhysicsViewer
  55240. * @param scene defines the hosting scene
  55241. */
  55242. constructor(scene: Scene);
  55243. /** @hidden */
  55244. protected _updateDebugMeshes(): void;
  55245. /**
  55246. * Renders a specified physic impostor
  55247. * @param impostor defines the impostor to render
  55248. * @param targetMesh defines the mesh represented by the impostor
  55249. * @returns the new debug mesh used to render the impostor
  55250. */
  55251. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  55252. /**
  55253. * Hides a specified physic impostor
  55254. * @param impostor defines the impostor to hide
  55255. */
  55256. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  55257. private _getDebugMaterial;
  55258. private _getDebugBoxMesh;
  55259. private _getDebugSphereMesh;
  55260. private _getDebugCylinderMesh;
  55261. private _getDebugMeshMesh;
  55262. private _getDebugMesh;
  55263. /** Releases all resources */
  55264. dispose(): void;
  55265. }
  55266. }
  55267. declare module BABYLON {
  55268. /**
  55269. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  55270. * in order to better appreciate the issue one might have.
  55271. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  55272. */
  55273. export class RayHelper {
  55274. /**
  55275. * Defines the ray we are currently tryin to visualize.
  55276. */
  55277. ray: Nullable<Ray>;
  55278. private _renderPoints;
  55279. private _renderLine;
  55280. private _renderFunction;
  55281. private _scene;
  55282. private _onAfterRenderObserver;
  55283. private _onAfterStepObserver;
  55284. private _attachedToMesh;
  55285. private _meshSpaceDirection;
  55286. private _meshSpaceOrigin;
  55287. /**
  55288. * Helper function to create a colored helper in a scene in one line.
  55289. * @param ray Defines the ray we are currently tryin to visualize
  55290. * @param scene Defines the scene the ray is used in
  55291. * @param color Defines the color we want to see the ray in
  55292. * @returns The newly created ray helper.
  55293. */
  55294. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  55295. /**
  55296. * Instantiate a new ray helper.
  55297. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  55298. * in order to better appreciate the issue one might have.
  55299. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  55300. * @param ray Defines the ray we are currently tryin to visualize
  55301. */
  55302. constructor(ray: Ray);
  55303. /**
  55304. * Shows the ray we are willing to debug.
  55305. * @param scene Defines the scene the ray needs to be rendered in
  55306. * @param color Defines the color the ray needs to be rendered in
  55307. */
  55308. show(scene: Scene, color?: Color3): void;
  55309. /**
  55310. * Hides the ray we are debugging.
  55311. */
  55312. hide(): void;
  55313. private _render;
  55314. /**
  55315. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  55316. * @param mesh Defines the mesh we want the helper attached to
  55317. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  55318. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  55319. * @param length Defines the length of the ray
  55320. */
  55321. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  55322. /**
  55323. * Detach the ray helper from the mesh it has previously been attached to.
  55324. */
  55325. detachFromMesh(): void;
  55326. private _updateToMesh;
  55327. /**
  55328. * Dispose the helper and release its associated resources.
  55329. */
  55330. dispose(): void;
  55331. }
  55332. }
  55333. declare module BABYLON {
  55334. /**
  55335. * Defines the options associated with the creation of a SkeletonViewer.
  55336. */
  55337. export interface ISkeletonViewerOptions {
  55338. /** Should the system pause animations before building the Viewer? */
  55339. pauseAnimations: boolean;
  55340. /** Should the system return the skeleton to rest before building? */
  55341. returnToRest: boolean;
  55342. /** public Display Mode of the Viewer */
  55343. displayMode: number;
  55344. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  55345. displayOptions: ISkeletonViewerDisplayOptions;
  55346. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  55347. computeBonesUsingShaders: boolean;
  55348. /** Flag ignore non weighted bones */
  55349. useAllBones: boolean;
  55350. }
  55351. /**
  55352. * Defines how to display the various bone meshes for the viewer.
  55353. */
  55354. export interface ISkeletonViewerDisplayOptions {
  55355. /** How far down to start tapering the bone spurs */
  55356. midStep?: number;
  55357. /** How big is the midStep? */
  55358. midStepFactor?: number;
  55359. /** Base for the Sphere Size */
  55360. sphereBaseSize?: number;
  55361. /** The ratio of the sphere to the longest bone in units */
  55362. sphereScaleUnit?: number;
  55363. /** Ratio for the Sphere Size */
  55364. sphereFactor?: number;
  55365. /** Whether a spur should attach its far end to the child bone position */
  55366. spurFollowsChild?: boolean;
  55367. /** Whether to show local axes or not */
  55368. showLocalAxes?: boolean;
  55369. /** Length of each local axis */
  55370. localAxesSize?: number;
  55371. }
  55372. /**
  55373. * Defines the constructor options for the BoneWeight Shader.
  55374. */
  55375. export interface IBoneWeightShaderOptions {
  55376. /** Skeleton to Map */
  55377. skeleton: Skeleton;
  55378. /** Colors for Uninfluenced bones */
  55379. colorBase?: Color3;
  55380. /** Colors for 0.0-0.25 Weight bones */
  55381. colorZero?: Color3;
  55382. /** Color for 0.25-0.5 Weight Influence */
  55383. colorQuarter?: Color3;
  55384. /** Color for 0.5-0.75 Weight Influence */
  55385. colorHalf?: Color3;
  55386. /** Color for 0.75-1 Weight Influence */
  55387. colorFull?: Color3;
  55388. /** Color for Zero Weight Influence */
  55389. targetBoneIndex?: number;
  55390. }
  55391. /**
  55392. * Simple structure of the gradient steps for the Color Map.
  55393. */
  55394. export interface ISkeletonMapShaderColorMapKnot {
  55395. /** Color of the Knot */
  55396. color: Color3;
  55397. /** Location of the Knot */
  55398. location: number;
  55399. }
  55400. /**
  55401. * Defines the constructor options for the SkeletonMap Shader.
  55402. */
  55403. export interface ISkeletonMapShaderOptions {
  55404. /** Skeleton to Map */
  55405. skeleton: Skeleton;
  55406. /** Array of ColorMapKnots that make the gradient must be ordered with knot[i].location < knot[i+1].location*/
  55407. colorMap?: ISkeletonMapShaderColorMapKnot[];
  55408. }
  55409. }
  55410. declare module BABYLON {
  55411. /**
  55412. * Class containing static functions to help procedurally build meshes
  55413. */
  55414. export class RibbonBuilder {
  55415. /**
  55416. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  55417. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  55418. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  55419. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  55420. * * 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
  55421. * * 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
  55422. * * 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
  55423. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55424. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  55425. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  55426. * * 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
  55427. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  55428. * * 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
  55429. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  55430. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  55431. * @param name defines the name of the mesh
  55432. * @param options defines the options used to create the mesh
  55433. * @param scene defines the hosting scene
  55434. * @returns the ribbon mesh
  55435. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  55436. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  55437. */
  55438. static CreateRibbon(name: string, options: {
  55439. pathArray: Vector3[][];
  55440. closeArray?: boolean;
  55441. closePath?: boolean;
  55442. offset?: number;
  55443. updatable?: boolean;
  55444. sideOrientation?: number;
  55445. frontUVs?: Vector4;
  55446. backUVs?: Vector4;
  55447. instance?: Mesh;
  55448. invertUV?: boolean;
  55449. uvs?: Vector2[];
  55450. colors?: Color4[];
  55451. }, scene?: Nullable<Scene>): Mesh;
  55452. }
  55453. }
  55454. declare module BABYLON {
  55455. /**
  55456. * Class containing static functions to help procedurally build meshes
  55457. */
  55458. export class ShapeBuilder {
  55459. /**
  55460. * 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.
  55461. * * 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.
  55462. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  55463. * * 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.
  55464. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  55465. * * 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
  55466. * * 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
  55467. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  55468. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55469. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  55470. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  55471. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  55472. * @param name defines the name of the mesh
  55473. * @param options defines the options used to create the mesh
  55474. * @param scene defines the hosting scene
  55475. * @returns the extruded shape mesh
  55476. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  55477. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  55478. */
  55479. static ExtrudeShape(name: string, options: {
  55480. shape: Vector3[];
  55481. path: Vector3[];
  55482. scale?: number;
  55483. rotation?: number;
  55484. cap?: number;
  55485. updatable?: boolean;
  55486. sideOrientation?: number;
  55487. frontUVs?: Vector4;
  55488. backUVs?: Vector4;
  55489. instance?: Mesh;
  55490. invertUV?: boolean;
  55491. }, scene?: Nullable<Scene>): Mesh;
  55492. /**
  55493. * Creates an custom extruded shape mesh.
  55494. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  55495. * * 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.
  55496. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  55497. * * 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
  55498. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  55499. * * 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
  55500. * * It must returns a float value that will be the scale value applied to the shape on each path point
  55501. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  55502. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  55503. * * 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
  55504. * * 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
  55505. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  55506. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55507. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  55508. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  55509. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  55510. * @param name defines the name of the mesh
  55511. * @param options defines the options used to create the mesh
  55512. * @param scene defines the hosting scene
  55513. * @returns the custom extruded shape mesh
  55514. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  55515. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  55516. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  55517. */
  55518. static ExtrudeShapeCustom(name: string, options: {
  55519. shape: Vector3[];
  55520. path: Vector3[];
  55521. scaleFunction?: any;
  55522. rotationFunction?: any;
  55523. ribbonCloseArray?: boolean;
  55524. ribbonClosePath?: boolean;
  55525. cap?: number;
  55526. updatable?: boolean;
  55527. sideOrientation?: number;
  55528. frontUVs?: Vector4;
  55529. backUVs?: Vector4;
  55530. instance?: Mesh;
  55531. invertUV?: boolean;
  55532. }, scene?: Nullable<Scene>): Mesh;
  55533. private static _ExtrudeShapeGeneric;
  55534. }
  55535. }
  55536. declare module BABYLON.Debug {
  55537. /**
  55538. * Class used to render a debug view of a given skeleton
  55539. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  55540. */
  55541. export class SkeletonViewer {
  55542. /** defines the skeleton to render */
  55543. skeleton: Skeleton;
  55544. /** defines the mesh attached to the skeleton */
  55545. mesh: AbstractMesh;
  55546. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  55547. autoUpdateBonesMatrices: boolean;
  55548. /** defines the rendering group id to use with the viewer */
  55549. renderingGroupId: number;
  55550. /** is the options for the viewer */
  55551. options: Partial<ISkeletonViewerOptions>;
  55552. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  55553. static readonly DISPLAY_LINES: number;
  55554. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  55555. static readonly DISPLAY_SPHERES: number;
  55556. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  55557. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  55558. /** public static method to create a BoneWeight Shader
  55559. * @param options The constructor options
  55560. * @param scene The scene that the shader is scoped to
  55561. * @returns The created ShaderMaterial
  55562. * @see http://www.babylonjs-playground.com/#1BZJVJ#395
  55563. */
  55564. static CreateBoneWeightShader(options: IBoneWeightShaderOptions, scene: Scene): ShaderMaterial;
  55565. /** public static method to create a BoneWeight Shader
  55566. * @param options The constructor options
  55567. * @param scene The scene that the shader is scoped to
  55568. * @returns The created ShaderMaterial
  55569. */
  55570. static CreateSkeletonMapShader(options: ISkeletonMapShaderOptions, scene: Scene): ShaderMaterial;
  55571. /** private static method to create a BoneWeight Shader
  55572. * @param size The size of the buffer to create (usually the bone count)
  55573. * @param colorMap The gradient data to generate
  55574. * @param scene The scene that the shader is scoped to
  55575. * @returns an Array of floats from the color gradient values
  55576. */
  55577. private static _CreateBoneMapColorBuffer;
  55578. /** If SkeletonViewer scene scope. */
  55579. private _scene;
  55580. /** Gets or sets the color used to render the skeleton */
  55581. color: Color3;
  55582. /** Array of the points of the skeleton fo the line view. */
  55583. private _debugLines;
  55584. /** The SkeletonViewers Mesh. */
  55585. private _debugMesh;
  55586. /** The local axes Meshes. */
  55587. private _localAxes;
  55588. /** If SkeletonViewer is enabled. */
  55589. private _isEnabled;
  55590. /** If SkeletonViewer is ready. */
  55591. private _ready;
  55592. /** SkeletonViewer render observable. */
  55593. private _obs;
  55594. /** The Utility Layer to render the gizmos in. */
  55595. private _utilityLayer;
  55596. private _boneIndices;
  55597. /** Gets the Scene. */
  55598. get scene(): Scene;
  55599. /** Gets the utilityLayer. */
  55600. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  55601. /** Checks Ready Status. */
  55602. get isReady(): Boolean;
  55603. /** Sets Ready Status. */
  55604. set ready(value: boolean);
  55605. /** Gets the debugMesh */
  55606. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  55607. /** Sets the debugMesh */
  55608. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  55609. /** Gets the displayMode */
  55610. get displayMode(): number;
  55611. /** Sets the displayMode */
  55612. set displayMode(value: number);
  55613. /**
  55614. * Creates a new SkeletonViewer
  55615. * @param skeleton defines the skeleton to render
  55616. * @param mesh defines the mesh attached to the skeleton
  55617. * @param scene defines the hosting scene
  55618. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  55619. * @param renderingGroupId defines the rendering group id to use with the viewer
  55620. * @param options All of the extra constructor options for the SkeletonViewer
  55621. */
  55622. constructor(
  55623. /** defines the skeleton to render */
  55624. skeleton: Skeleton,
  55625. /** defines the mesh attached to the skeleton */
  55626. mesh: AbstractMesh,
  55627. /** The Scene scope*/
  55628. scene: Scene,
  55629. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  55630. autoUpdateBonesMatrices?: boolean,
  55631. /** defines the rendering group id to use with the viewer */
  55632. renderingGroupId?: number,
  55633. /** is the options for the viewer */
  55634. options?: Partial<ISkeletonViewerOptions>);
  55635. /** The Dynamic bindings for the update functions */
  55636. private _bindObs;
  55637. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  55638. update(): void;
  55639. /** Gets or sets a boolean indicating if the viewer is enabled */
  55640. set isEnabled(value: boolean);
  55641. get isEnabled(): boolean;
  55642. private _getBonePosition;
  55643. private _getLinesForBonesWithLength;
  55644. private _getLinesForBonesNoLength;
  55645. /** function to revert the mesh and scene back to the initial state. */
  55646. private _revert;
  55647. /** function to get the absolute bind pose of a bone by accumulating transformations up the bone hierarchy. */
  55648. private _getAbsoluteBindPoseToRef;
  55649. /** function to build and bind sphere joint points and spur bone representations. */
  55650. private _buildSpheresAndSpurs;
  55651. private _buildLocalAxes;
  55652. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  55653. private _displayLinesUpdate;
  55654. /** Changes the displayMode of the skeleton viewer
  55655. * @param mode The displayMode numerical value
  55656. */
  55657. changeDisplayMode(mode: number): void;
  55658. /** Sets a display option of the skeleton viewer
  55659. *
  55660. * | Option | Type | Default | Description |
  55661. * | ---------------- | ------- | ------- | ----------- |
  55662. * | midStep | float | 0.235 | A percentage between a bone and its child that determines the widest part of a spur. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
  55663. * | midStepFactor | float | 0.15 | Mid step width expressed as a factor of the length. A value of 0.5 makes the spur width half of the spur length. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
  55664. * | sphereBaseSize | float | 2 | Sphere base size. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
  55665. * | sphereScaleUnit | float | 0.865 | Sphere scale factor used to scale spheres in relation to the longest bone. Only used when `displayMode` is set to `DISPLAY_SPHERE_AND_SPURS`. |
  55666. * | spurFollowsChild | boolean | false | Whether a spur should attach its far end to the child bone. |
  55667. * | showLocalAxes | boolean | false | Displays local axes on all bones. |
  55668. * | localAxesSize | float | 0.075 | Determines the length of each local axis. |
  55669. *
  55670. * @param option String of the option name
  55671. * @param value The numerical option value
  55672. */
  55673. changeDisplayOptions(option: string, value: number): void;
  55674. /** Release associated resources */
  55675. dispose(): void;
  55676. }
  55677. }
  55678. declare module BABYLON {
  55679. /**
  55680. * Enum for Device Types
  55681. */
  55682. export enum DeviceType {
  55683. /** Generic */
  55684. Generic = 0,
  55685. /** Keyboard */
  55686. Keyboard = 1,
  55687. /** Mouse */
  55688. Mouse = 2,
  55689. /** Touch Pointers */
  55690. Touch = 3,
  55691. /** PS4 Dual Shock */
  55692. DualShock = 4,
  55693. /** Xbox */
  55694. Xbox = 5,
  55695. /** Switch Controller */
  55696. Switch = 6
  55697. }
  55698. /**
  55699. * Enum for All Pointers (Touch/Mouse)
  55700. */
  55701. export enum PointerInput {
  55702. /** Horizontal Axis */
  55703. Horizontal = 0,
  55704. /** Vertical Axis */
  55705. Vertical = 1,
  55706. /** Left Click or Touch */
  55707. LeftClick = 2,
  55708. /** Middle Click */
  55709. MiddleClick = 3,
  55710. /** Right Click */
  55711. RightClick = 4,
  55712. /** Browser Back */
  55713. BrowserBack = 5,
  55714. /** Browser Forward */
  55715. BrowserForward = 6
  55716. }
  55717. /**
  55718. * Enum for Dual Shock Gamepad
  55719. */
  55720. export enum DualShockInput {
  55721. /** Cross */
  55722. Cross = 0,
  55723. /** Circle */
  55724. Circle = 1,
  55725. /** Square */
  55726. Square = 2,
  55727. /** Triangle */
  55728. Triangle = 3,
  55729. /** L1 */
  55730. L1 = 4,
  55731. /** R1 */
  55732. R1 = 5,
  55733. /** L2 */
  55734. L2 = 6,
  55735. /** R2 */
  55736. R2 = 7,
  55737. /** Share */
  55738. Share = 8,
  55739. /** Options */
  55740. Options = 9,
  55741. /** L3 */
  55742. L3 = 10,
  55743. /** R3 */
  55744. R3 = 11,
  55745. /** DPadUp */
  55746. DPadUp = 12,
  55747. /** DPadDown */
  55748. DPadDown = 13,
  55749. /** DPadLeft */
  55750. DPadLeft = 14,
  55751. /** DRight */
  55752. DPadRight = 15,
  55753. /** Home */
  55754. Home = 16,
  55755. /** TouchPad */
  55756. TouchPad = 17,
  55757. /** LStickXAxis */
  55758. LStickXAxis = 18,
  55759. /** LStickYAxis */
  55760. LStickYAxis = 19,
  55761. /** RStickXAxis */
  55762. RStickXAxis = 20,
  55763. /** RStickYAxis */
  55764. RStickYAxis = 21
  55765. }
  55766. /**
  55767. * Enum for Xbox Gamepad
  55768. */
  55769. export enum XboxInput {
  55770. /** A */
  55771. A = 0,
  55772. /** B */
  55773. B = 1,
  55774. /** X */
  55775. X = 2,
  55776. /** Y */
  55777. Y = 3,
  55778. /** LB */
  55779. LB = 4,
  55780. /** RB */
  55781. RB = 5,
  55782. /** LT */
  55783. LT = 6,
  55784. /** RT */
  55785. RT = 7,
  55786. /** Back */
  55787. Back = 8,
  55788. /** Start */
  55789. Start = 9,
  55790. /** LS */
  55791. LS = 10,
  55792. /** RS */
  55793. RS = 11,
  55794. /** DPadUp */
  55795. DPadUp = 12,
  55796. /** DPadDown */
  55797. DPadDown = 13,
  55798. /** DPadLeft */
  55799. DPadLeft = 14,
  55800. /** DRight */
  55801. DPadRight = 15,
  55802. /** Home */
  55803. Home = 16,
  55804. /** LStickXAxis */
  55805. LStickXAxis = 17,
  55806. /** LStickYAxis */
  55807. LStickYAxis = 18,
  55808. /** RStickXAxis */
  55809. RStickXAxis = 19,
  55810. /** RStickYAxis */
  55811. RStickYAxis = 20
  55812. }
  55813. /**
  55814. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  55815. */
  55816. export enum SwitchInput {
  55817. /** B */
  55818. B = 0,
  55819. /** A */
  55820. A = 1,
  55821. /** Y */
  55822. Y = 2,
  55823. /** X */
  55824. X = 3,
  55825. /** L */
  55826. L = 4,
  55827. /** R */
  55828. R = 5,
  55829. /** ZL */
  55830. ZL = 6,
  55831. /** ZR */
  55832. ZR = 7,
  55833. /** Minus */
  55834. Minus = 8,
  55835. /** Plus */
  55836. Plus = 9,
  55837. /** LS */
  55838. LS = 10,
  55839. /** RS */
  55840. RS = 11,
  55841. /** DPadUp */
  55842. DPadUp = 12,
  55843. /** DPadDown */
  55844. DPadDown = 13,
  55845. /** DPadLeft */
  55846. DPadLeft = 14,
  55847. /** DRight */
  55848. DPadRight = 15,
  55849. /** Home */
  55850. Home = 16,
  55851. /** Capture */
  55852. Capture = 17,
  55853. /** LStickXAxis */
  55854. LStickXAxis = 18,
  55855. /** LStickYAxis */
  55856. LStickYAxis = 19,
  55857. /** RStickXAxis */
  55858. RStickXAxis = 20,
  55859. /** RStickYAxis */
  55860. RStickYAxis = 21
  55861. }
  55862. }
  55863. declare module BABYLON {
  55864. /**
  55865. * This class will take all inputs from Keyboard, Pointer, and
  55866. * any Gamepads and provide a polling system that all devices
  55867. * will use. This class assumes that there will only be one
  55868. * pointer device and one keyboard.
  55869. */
  55870. export class DeviceInputSystem implements IDisposable {
  55871. /**
  55872. * Returns onDeviceConnected callback property
  55873. * @returns Callback with function to execute when a device is connected
  55874. */
  55875. get onDeviceConnected(): (deviceType: DeviceType, deviceSlot: number) => void;
  55876. /**
  55877. * Sets callback function when a device is connected and executes against all connected devices
  55878. * @param callback Function to execute when a device is connected
  55879. */
  55880. set onDeviceConnected(callback: (deviceType: DeviceType, deviceSlot: number) => void);
  55881. /**
  55882. * Callback to be triggered when a device is disconnected
  55883. */
  55884. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  55885. /**
  55886. * Callback to be triggered when event driven input is updated
  55887. */
  55888. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  55889. private _inputs;
  55890. private _gamepads;
  55891. private _keyboardActive;
  55892. private _pointerActive;
  55893. private _elementToAttachTo;
  55894. private _keyboardDownEvent;
  55895. private _keyboardUpEvent;
  55896. private _pointerMoveEvent;
  55897. private _pointerDownEvent;
  55898. private _pointerUpEvent;
  55899. private _gamepadConnectedEvent;
  55900. private _gamepadDisconnectedEvent;
  55901. private _onDeviceConnected;
  55902. private static _MAX_KEYCODES;
  55903. private static _MAX_POINTER_INPUTS;
  55904. private constructor();
  55905. /**
  55906. * Creates a new DeviceInputSystem instance
  55907. * @param engine Engine to pull input element from
  55908. * @returns The new instance
  55909. */
  55910. static Create(engine: Engine): DeviceInputSystem;
  55911. /**
  55912. * Checks for current device input value, given an id and input index
  55913. * @param deviceName Id of connected device
  55914. * @param inputIndex Index of device input
  55915. * @returns Current value of input
  55916. */
  55917. /**
  55918. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  55919. * @param deviceType Enum specifiying device type
  55920. * @param deviceSlot "Slot" or index that device is referenced in
  55921. * @param inputIndex Id of input to be checked
  55922. * @returns Current value of input
  55923. */
  55924. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  55925. /**
  55926. * Dispose of all the eventlisteners
  55927. */
  55928. dispose(): void;
  55929. /**
  55930. * Checks for existing connections to devices and register them, if necessary
  55931. * Currently handles gamepads and mouse
  55932. */
  55933. private _checkForConnectedDevices;
  55934. /**
  55935. * Add a gamepad to the DeviceInputSystem
  55936. * @param gamepad A single DOM Gamepad object
  55937. */
  55938. private _addGamePad;
  55939. /**
  55940. * Add pointer device to DeviceInputSystem
  55941. * @param deviceType Type of Pointer to add
  55942. * @param deviceSlot Pointer ID (0 for mouse, pointerId for Touch)
  55943. * @param currentX Current X at point of adding
  55944. * @param currentY Current Y at point of adding
  55945. */
  55946. private _addPointerDevice;
  55947. /**
  55948. * Add device and inputs to device array
  55949. * @param deviceType Enum specifiying device type
  55950. * @param deviceSlot "Slot" or index that device is referenced in
  55951. * @param numberOfInputs Number of input entries to create for given device
  55952. */
  55953. private _registerDevice;
  55954. /**
  55955. * Given a specific device name, remove that device from the device map
  55956. * @param deviceType Enum specifiying device type
  55957. * @param deviceSlot "Slot" or index that device is referenced in
  55958. */
  55959. private _unregisterDevice;
  55960. /**
  55961. * Handle all actions that come from keyboard interaction
  55962. */
  55963. private _handleKeyActions;
  55964. /**
  55965. * Handle all actions that come from pointer interaction
  55966. */
  55967. private _handlePointerActions;
  55968. /**
  55969. * Handle all actions that come from gamepad interaction
  55970. */
  55971. private _handleGamepadActions;
  55972. /**
  55973. * Update all non-event based devices with each frame
  55974. * @param deviceType Enum specifiying device type
  55975. * @param deviceSlot "Slot" or index that device is referenced in
  55976. * @param inputIndex Id of input to be checked
  55977. */
  55978. private _updateDevice;
  55979. /**
  55980. * Gets DeviceType from the device name
  55981. * @param deviceName Name of Device from DeviceInputSystem
  55982. * @returns DeviceType enum value
  55983. */
  55984. private _getGamepadDeviceType;
  55985. }
  55986. }
  55987. declare module BABYLON {
  55988. /**
  55989. * Type to handle enforcement of inputs
  55990. */
  55991. export type DeviceInput<T extends DeviceType> = T extends DeviceType.Keyboard | DeviceType.Generic ? number : T extends DeviceType.Mouse | DeviceType.Touch ? PointerInput : T extends DeviceType.DualShock ? DualShockInput : T extends DeviceType.Xbox ? XboxInput : T extends DeviceType.Switch ? SwitchInput : never;
  55992. }
  55993. declare module BABYLON {
  55994. /**
  55995. * Class that handles all input for a specific device
  55996. */
  55997. export class DeviceSource<T extends DeviceType> {
  55998. /** Type of device */
  55999. readonly deviceType: DeviceType;
  56000. /** "Slot" or index that device is referenced in */
  56001. readonly deviceSlot: number;
  56002. /**
  56003. * Observable to handle device input changes per device
  56004. */
  56005. readonly onInputChangedObservable: Observable<{
  56006. inputIndex: DeviceInput<T>;
  56007. previousState: Nullable<number>;
  56008. currentState: Nullable<number>;
  56009. }>;
  56010. private readonly _deviceInputSystem;
  56011. /**
  56012. * Default Constructor
  56013. * @param deviceInputSystem Reference to DeviceInputSystem
  56014. * @param deviceType Type of device
  56015. * @param deviceSlot "Slot" or index that device is referenced in
  56016. */
  56017. constructor(deviceInputSystem: DeviceInputSystem,
  56018. /** Type of device */
  56019. deviceType: DeviceType,
  56020. /** "Slot" or index that device is referenced in */
  56021. deviceSlot?: number);
  56022. /**
  56023. * Get input for specific input
  56024. * @param inputIndex index of specific input on device
  56025. * @returns Input value from DeviceInputSystem
  56026. */
  56027. getInput(inputIndex: DeviceInput<T>): number;
  56028. }
  56029. /**
  56030. * Class to keep track of devices
  56031. */
  56032. export class DeviceSourceManager implements IDisposable {
  56033. /**
  56034. * Observable to be triggered when after a device is connected, any new observers added will be triggered against already connected devices
  56035. */
  56036. readonly onDeviceConnectedObservable: Observable<DeviceSource<DeviceType>>;
  56037. /**
  56038. * Observable to be triggered when after a device is disconnected
  56039. */
  56040. readonly onDeviceDisconnectedObservable: Observable<DeviceSource<DeviceType>>;
  56041. private readonly _devices;
  56042. private readonly _firstDevice;
  56043. private readonly _deviceInputSystem;
  56044. /**
  56045. * Default Constructor
  56046. * @param engine engine to pull input element from
  56047. */
  56048. constructor(engine: Engine);
  56049. /**
  56050. * Gets a DeviceSource, given a type and slot
  56051. * @param deviceType Enum specifying device type
  56052. * @param deviceSlot "Slot" or index that device is referenced in
  56053. * @returns DeviceSource object
  56054. */
  56055. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  56056. /**
  56057. * Gets an array of DeviceSource objects for a given device type
  56058. * @param deviceType Enum specifying device type
  56059. * @returns Array of DeviceSource objects
  56060. */
  56061. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  56062. /**
  56063. * Returns a read-only list of all available devices
  56064. * @returns Read-only array with active devices
  56065. */
  56066. getDevices(): ReadonlyArray<DeviceSource<DeviceType>>;
  56067. /**
  56068. * Dispose of DeviceInputSystem and other parts
  56069. */
  56070. dispose(): void;
  56071. /**
  56072. * Function to add device name to device list
  56073. * @param deviceType Enum specifying device type
  56074. * @param deviceSlot "Slot" or index that device is referenced in
  56075. */
  56076. private _addDevice;
  56077. /**
  56078. * Function to remove device name to device list
  56079. * @param deviceType Enum specifying device type
  56080. * @param deviceSlot "Slot" or index that device is referenced in
  56081. */
  56082. private _removeDevice;
  56083. /**
  56084. * Updates array storing first connected device of each type
  56085. * @param type Type of Device
  56086. */
  56087. private _updateFirstDevices;
  56088. }
  56089. }
  56090. declare module BABYLON {
  56091. /**
  56092. * Options to create the null engine
  56093. */
  56094. export class NullEngineOptions {
  56095. /**
  56096. * Render width (Default: 512)
  56097. */
  56098. renderWidth: number;
  56099. /**
  56100. * Render height (Default: 256)
  56101. */
  56102. renderHeight: number;
  56103. /**
  56104. * Texture size (Default: 512)
  56105. */
  56106. textureSize: number;
  56107. /**
  56108. * If delta time between frames should be constant
  56109. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  56110. */
  56111. deterministicLockstep: boolean;
  56112. /**
  56113. * Maximum about of steps between frames (Default: 4)
  56114. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  56115. */
  56116. lockstepMaxSteps: number;
  56117. /**
  56118. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  56119. */
  56120. useHighPrecisionMatrix?: boolean;
  56121. }
  56122. /**
  56123. * The null engine class provides support for headless version of babylon.js.
  56124. * This can be used in server side scenario or for testing purposes
  56125. */
  56126. export class NullEngine extends Engine {
  56127. private _options;
  56128. /**
  56129. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  56130. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  56131. * @returns true if engine is in deterministic lock step mode
  56132. */
  56133. isDeterministicLockStep(): boolean;
  56134. /**
  56135. * Gets the max steps when engine is running in deterministic lock step
  56136. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  56137. * @returns the max steps
  56138. */
  56139. getLockstepMaxSteps(): number;
  56140. /**
  56141. * Gets the current hardware scaling level.
  56142. * By default the hardware scaling level is computed from the window device ratio.
  56143. * 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.
  56144. * @returns a number indicating the current hardware scaling level
  56145. */
  56146. getHardwareScalingLevel(): number;
  56147. constructor(options?: NullEngineOptions);
  56148. /**
  56149. * Creates a vertex buffer
  56150. * @param vertices the data for the vertex buffer
  56151. * @returns the new WebGL static buffer
  56152. */
  56153. createVertexBuffer(vertices: FloatArray): DataBuffer;
  56154. /**
  56155. * Creates a new index buffer
  56156. * @param indices defines the content of the index buffer
  56157. * @param updatable defines if the index buffer must be updatable
  56158. * @returns a new webGL buffer
  56159. */
  56160. createIndexBuffer(indices: IndicesArray): DataBuffer;
  56161. /**
  56162. * Clear the current render buffer or the current render target (if any is set up)
  56163. * @param color defines the color to use
  56164. * @param backBuffer defines if the back buffer must be cleared
  56165. * @param depth defines if the depth buffer must be cleared
  56166. * @param stencil defines if the stencil buffer must be cleared
  56167. */
  56168. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  56169. /**
  56170. * Gets the current render width
  56171. * @param useScreen defines if screen size must be used (or the current render target if any)
  56172. * @returns a number defining the current render width
  56173. */
  56174. getRenderWidth(useScreen?: boolean): number;
  56175. /**
  56176. * Gets the current render height
  56177. * @param useScreen defines if screen size must be used (or the current render target if any)
  56178. * @returns a number defining the current render height
  56179. */
  56180. getRenderHeight(useScreen?: boolean): number;
  56181. /**
  56182. * Set the WebGL's viewport
  56183. * @param viewport defines the viewport element to be used
  56184. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  56185. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  56186. */
  56187. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  56188. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  56189. /**
  56190. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  56191. * @param pipelineContext defines the pipeline context to use
  56192. * @param uniformsNames defines the list of uniform names
  56193. * @returns an array of webGL uniform locations
  56194. */
  56195. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  56196. /**
  56197. * Gets the lsit of active attributes for a given webGL program
  56198. * @param pipelineContext defines the pipeline context to use
  56199. * @param attributesNames defines the list of attribute names to get
  56200. * @returns an array of indices indicating the offset of each attribute
  56201. */
  56202. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  56203. /**
  56204. * Binds an effect to the webGL context
  56205. * @param effect defines the effect to bind
  56206. */
  56207. bindSamplers(effect: Effect): void;
  56208. /**
  56209. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  56210. * @param effect defines the effect to activate
  56211. */
  56212. enableEffect(effect: Effect): void;
  56213. /**
  56214. * Set various states to the webGL context
  56215. * @param culling defines backface culling state
  56216. * @param zOffset defines the value to apply to zOffset (0 by default)
  56217. * @param force defines if states must be applied even if cache is up to date
  56218. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  56219. */
  56220. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  56221. /**
  56222. * Set the value of an uniform to an array of int32
  56223. * @param uniform defines the webGL uniform location where to store the value
  56224. * @param array defines the array of int32 to store
  56225. * @returns true if value was set
  56226. */
  56227. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  56228. /**
  56229. * Set the value of an uniform to an array of int32 (stored as vec2)
  56230. * @param uniform defines the webGL uniform location where to store the value
  56231. * @param array defines the array of int32 to store
  56232. * @returns true if value was set
  56233. */
  56234. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  56235. /**
  56236. * Set the value of an uniform to an array of int32 (stored as vec3)
  56237. * @param uniform defines the webGL uniform location where to store the value
  56238. * @param array defines the array of int32 to store
  56239. * @returns true if value was set
  56240. */
  56241. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  56242. /**
  56243. * Set the value of an uniform to an array of int32 (stored as vec4)
  56244. * @param uniform defines the webGL uniform location where to store the value
  56245. * @param array defines the array of int32 to store
  56246. * @returns true if value was set
  56247. */
  56248. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  56249. /**
  56250. * Set the value of an uniform to an array of float32
  56251. * @param uniform defines the webGL uniform location where to store the value
  56252. * @param array defines the array of float32 to store
  56253. * @returns true if value was set
  56254. */
  56255. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  56256. /**
  56257. * Set the value of an uniform to an array of float32 (stored as vec2)
  56258. * @param uniform defines the webGL uniform location where to store the value
  56259. * @param array defines the array of float32 to store
  56260. * @returns true if value was set
  56261. */
  56262. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  56263. /**
  56264. * Set the value of an uniform to an array of float32 (stored as vec3)
  56265. * @param uniform defines the webGL uniform location where to store the value
  56266. * @param array defines the array of float32 to store
  56267. * @returns true if value was set
  56268. */
  56269. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  56270. /**
  56271. * Set the value of an uniform to an array of float32 (stored as vec4)
  56272. * @param uniform defines the webGL uniform location where to store the value
  56273. * @param array defines the array of float32 to store
  56274. * @returns true if value was set
  56275. */
  56276. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  56277. /**
  56278. * Set the value of an uniform to an array of number
  56279. * @param uniform defines the webGL uniform location where to store the value
  56280. * @param array defines the array of number to store
  56281. * @returns true if value was set
  56282. */
  56283. setArray(uniform: WebGLUniformLocation, array: number[]): boolean;
  56284. /**
  56285. * Set the value of an uniform to an array of number (stored as vec2)
  56286. * @param uniform defines the webGL uniform location where to store the value
  56287. * @param array defines the array of number to store
  56288. * @returns true if value was set
  56289. */
  56290. setArray2(uniform: WebGLUniformLocation, array: number[]): boolean;
  56291. /**
  56292. * Set the value of an uniform to an array of number (stored as vec3)
  56293. * @param uniform defines the webGL uniform location where to store the value
  56294. * @param array defines the array of number to store
  56295. * @returns true if value was set
  56296. */
  56297. setArray3(uniform: WebGLUniformLocation, array: number[]): boolean;
  56298. /**
  56299. * Set the value of an uniform to an array of number (stored as vec4)
  56300. * @param uniform defines the webGL uniform location where to store the value
  56301. * @param array defines the array of number to store
  56302. * @returns true if value was set
  56303. */
  56304. setArray4(uniform: WebGLUniformLocation, array: number[]): boolean;
  56305. /**
  56306. * Set the value of an uniform to an array of float32 (stored as matrices)
  56307. * @param uniform defines the webGL uniform location where to store the value
  56308. * @param matrices defines the array of float32 to store
  56309. * @returns true if value was set
  56310. */
  56311. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): boolean;
  56312. /**
  56313. * Set the value of an uniform to a matrix (3x3)
  56314. * @param uniform defines the webGL uniform location where to store the value
  56315. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  56316. * @returns true if value was set
  56317. */
  56318. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  56319. /**
  56320. * Set the value of an uniform to a matrix (2x2)
  56321. * @param uniform defines the webGL uniform location where to store the value
  56322. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  56323. * @returns true if value was set
  56324. */
  56325. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  56326. /**
  56327. * Set the value of an uniform to a number (float)
  56328. * @param uniform defines the webGL uniform location where to store the value
  56329. * @param value defines the float number to store
  56330. * @returns true if value was set
  56331. */
  56332. setFloat(uniform: WebGLUniformLocation, value: number): boolean;
  56333. /**
  56334. * Set the value of an uniform to a vec2
  56335. * @param uniform defines the webGL uniform location where to store the value
  56336. * @param x defines the 1st component of the value
  56337. * @param y defines the 2nd component of the value
  56338. * @returns true if value was set
  56339. */
  56340. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): boolean;
  56341. /**
  56342. * Set the value of an uniform to a vec3
  56343. * @param uniform defines the webGL uniform location where to store the value
  56344. * @param x defines the 1st component of the value
  56345. * @param y defines the 2nd component of the value
  56346. * @param z defines the 3rd component of the value
  56347. * @returns true if value was set
  56348. */
  56349. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): boolean;
  56350. /**
  56351. * Set the value of an uniform to a boolean
  56352. * @param uniform defines the webGL uniform location where to store the value
  56353. * @param bool defines the boolean to store
  56354. * @returns true if value was set
  56355. */
  56356. setBool(uniform: WebGLUniformLocation, bool: number): boolean;
  56357. /**
  56358. * Set the value of an uniform to a vec4
  56359. * @param uniform defines the webGL uniform location where to store the value
  56360. * @param x defines the 1st component of the value
  56361. * @param y defines the 2nd component of the value
  56362. * @param z defines the 3rd component of the value
  56363. * @param w defines the 4th component of the value
  56364. * @returns true if value was set
  56365. */
  56366. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): boolean;
  56367. /**
  56368. * Sets the current alpha mode
  56369. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  56370. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  56371. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  56372. */
  56373. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  56374. /**
  56375. * Bind webGl buffers directly to the webGL context
  56376. * @param vertexBuffers defines the vertex buffer to bind
  56377. * @param indexBuffer defines the index buffer to bind
  56378. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  56379. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  56380. * @param effect defines the effect associated with the vertex buffer
  56381. */
  56382. bindBuffers(vertexBuffers: {
  56383. [key: string]: VertexBuffer;
  56384. }, indexBuffer: DataBuffer, effect: Effect): void;
  56385. /**
  56386. * Force the entire cache to be cleared
  56387. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  56388. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  56389. */
  56390. wipeCaches(bruteForce?: boolean): void;
  56391. /**
  56392. * Send a draw order
  56393. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  56394. * @param indexStart defines the starting index
  56395. * @param indexCount defines the number of index to draw
  56396. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  56397. */
  56398. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  56399. /**
  56400. * Draw a list of indexed primitives
  56401. * @param fillMode defines the primitive to use
  56402. * @param indexStart defines the starting index
  56403. * @param indexCount defines the number of index to draw
  56404. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  56405. */
  56406. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  56407. /**
  56408. * Draw a list of unindexed primitives
  56409. * @param fillMode defines the primitive to use
  56410. * @param verticesStart defines the index of first vertex to draw
  56411. * @param verticesCount defines the count of vertices to draw
  56412. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  56413. */
  56414. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  56415. /** @hidden */
  56416. _createTexture(): WebGLTexture;
  56417. /** @hidden */
  56418. _releaseTexture(texture: InternalTexture): void;
  56419. /**
  56420. * Usually called from Texture.ts.
  56421. * Passed information to create a WebGLTexture
  56422. * @param urlArg defines a value which contains one of the following:
  56423. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  56424. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  56425. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  56426. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  56427. * @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)
  56428. * @param scene needed for loading to the correct scene
  56429. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  56430. * @param onLoad optional callback to be called upon successful completion
  56431. * @param onError optional callback to be called upon failure
  56432. * @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
  56433. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  56434. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  56435. * @param forcedExtension defines the extension to use to pick the right loader
  56436. * @param mimeType defines an optional mime type
  56437. * @returns a InternalTexture for assignment back into BABYLON.Texture
  56438. */
  56439. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, mimeType?: string): InternalTexture;
  56440. /**
  56441. * Creates a new render target texture
  56442. * @param size defines the size of the texture
  56443. * @param options defines the options used to create the texture
  56444. * @returns a new render target texture stored in an InternalTexture
  56445. */
  56446. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  56447. /**
  56448. * Update the sampling mode of a given texture
  56449. * @param samplingMode defines the required sampling mode
  56450. * @param texture defines the texture to update
  56451. */
  56452. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  56453. /**
  56454. * Binds the frame buffer to the specified texture.
  56455. * @param texture The texture to render to or null for the default canvas
  56456. * @param faceIndex The face of the texture to render to in case of cube texture
  56457. * @param requiredWidth The width of the target to render to
  56458. * @param requiredHeight The height of the target to render to
  56459. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  56460. * @param lodLevel defines le lod level to bind to the frame buffer
  56461. */
  56462. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  56463. /**
  56464. * Unbind the current render target texture from the webGL context
  56465. * @param texture defines the render target texture to unbind
  56466. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  56467. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  56468. */
  56469. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  56470. /**
  56471. * Creates a dynamic vertex buffer
  56472. * @param vertices the data for the dynamic vertex buffer
  56473. * @returns the new WebGL dynamic buffer
  56474. */
  56475. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  56476. /**
  56477. * Update the content of a dynamic texture
  56478. * @param texture defines the texture to update
  56479. * @param canvas defines the canvas containing the source
  56480. * @param invertY defines if data must be stored with Y axis inverted
  56481. * @param premulAlpha defines if alpha is stored as premultiplied
  56482. * @param format defines the format of the data
  56483. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  56484. */
  56485. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  56486. /**
  56487. * Gets a boolean indicating if all created effects are ready
  56488. * @returns true if all effects are ready
  56489. */
  56490. areAllEffectsReady(): boolean;
  56491. /**
  56492. * @hidden
  56493. * Get the current error code of the webGL context
  56494. * @returns the error code
  56495. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  56496. */
  56497. getError(): number;
  56498. /** @hidden */
  56499. _getUnpackAlignement(): number;
  56500. /** @hidden */
  56501. _unpackFlipY(value: boolean): void;
  56502. /**
  56503. * Update a dynamic index buffer
  56504. * @param indexBuffer defines the target index buffer
  56505. * @param indices defines the data to update
  56506. * @param offset defines the offset in the target index buffer where update should start
  56507. */
  56508. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  56509. /**
  56510. * Updates a dynamic vertex buffer.
  56511. * @param vertexBuffer the vertex buffer to update
  56512. * @param vertices the data used to update the vertex buffer
  56513. * @param byteOffset the byte offset of the data (optional)
  56514. * @param byteLength the byte length of the data (optional)
  56515. */
  56516. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  56517. /** @hidden */
  56518. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  56519. /** @hidden */
  56520. _bindTexture(channel: number, texture: InternalTexture): void;
  56521. protected _deleteBuffer(buffer: WebGLBuffer): void;
  56522. /**
  56523. * 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
  56524. */
  56525. releaseEffects(): void;
  56526. displayLoadingUI(): void;
  56527. hideLoadingUI(): void;
  56528. /** @hidden */
  56529. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  56530. /** @hidden */
  56531. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  56532. /** @hidden */
  56533. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  56534. /** @hidden */
  56535. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  56536. }
  56537. }
  56538. declare module BABYLON {
  56539. /**
  56540. * @hidden
  56541. **/
  56542. export class _TimeToken {
  56543. _startTimeQuery: Nullable<WebGLQuery>;
  56544. _endTimeQuery: Nullable<WebGLQuery>;
  56545. _timeElapsedQuery: Nullable<WebGLQuery>;
  56546. _timeElapsedQueryEnded: boolean;
  56547. }
  56548. }
  56549. declare module BABYLON {
  56550. /** @hidden */
  56551. export class _OcclusionDataStorage {
  56552. /** @hidden */
  56553. occlusionInternalRetryCounter: number;
  56554. /** @hidden */
  56555. isOcclusionQueryInProgress: boolean;
  56556. /** @hidden */
  56557. isOccluded: boolean;
  56558. /** @hidden */
  56559. occlusionRetryCount: number;
  56560. /** @hidden */
  56561. occlusionType: number;
  56562. /** @hidden */
  56563. occlusionQueryAlgorithmType: number;
  56564. }
  56565. interface Engine {
  56566. /**
  56567. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  56568. * @return the new query
  56569. */
  56570. createQuery(): WebGLQuery;
  56571. /**
  56572. * Delete and release a webGL query
  56573. * @param query defines the query to delete
  56574. * @return the current engine
  56575. */
  56576. deleteQuery(query: WebGLQuery): Engine;
  56577. /**
  56578. * Check if a given query has resolved and got its value
  56579. * @param query defines the query to check
  56580. * @returns true if the query got its value
  56581. */
  56582. isQueryResultAvailable(query: WebGLQuery): boolean;
  56583. /**
  56584. * Gets the value of a given query
  56585. * @param query defines the query to check
  56586. * @returns the value of the query
  56587. */
  56588. getQueryResult(query: WebGLQuery): number;
  56589. /**
  56590. * Initiates an occlusion query
  56591. * @param algorithmType defines the algorithm to use
  56592. * @param query defines the query to use
  56593. * @returns the current engine
  56594. * @see https://doc.babylonjs.com/features/occlusionquery
  56595. */
  56596. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  56597. /**
  56598. * Ends an occlusion query
  56599. * @see https://doc.babylonjs.com/features/occlusionquery
  56600. * @param algorithmType defines the algorithm to use
  56601. * @returns the current engine
  56602. */
  56603. endOcclusionQuery(algorithmType: number): Engine;
  56604. /**
  56605. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  56606. * Please note that only one query can be issued at a time
  56607. * @returns a time token used to track the time span
  56608. */
  56609. startTimeQuery(): Nullable<_TimeToken>;
  56610. /**
  56611. * Ends a time query
  56612. * @param token defines the token used to measure the time span
  56613. * @returns the time spent (in ns)
  56614. */
  56615. endTimeQuery(token: _TimeToken): int;
  56616. /** @hidden */
  56617. _currentNonTimestampToken: Nullable<_TimeToken>;
  56618. /** @hidden */
  56619. _createTimeQuery(): WebGLQuery;
  56620. /** @hidden */
  56621. _deleteTimeQuery(query: WebGLQuery): void;
  56622. /** @hidden */
  56623. _getGlAlgorithmType(algorithmType: number): number;
  56624. /** @hidden */
  56625. _getTimeQueryResult(query: WebGLQuery): any;
  56626. /** @hidden */
  56627. _getTimeQueryAvailability(query: WebGLQuery): any;
  56628. }
  56629. interface AbstractMesh {
  56630. /**
  56631. * Backing filed
  56632. * @hidden
  56633. */
  56634. __occlusionDataStorage: _OcclusionDataStorage;
  56635. /**
  56636. * Access property
  56637. * @hidden
  56638. */
  56639. _occlusionDataStorage: _OcclusionDataStorage;
  56640. /**
  56641. * 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.
  56642. * The default value is -1 which means don't break the query and wait till the result
  56643. * @see https://doc.babylonjs.com/features/occlusionquery
  56644. */
  56645. occlusionRetryCount: number;
  56646. /**
  56647. * 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:
  56648. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  56649. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  56650. * * 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.
  56651. * @see https://doc.babylonjs.com/features/occlusionquery
  56652. */
  56653. occlusionType: number;
  56654. /**
  56655. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  56656. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  56657. * * 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.
  56658. * @see https://doc.babylonjs.com/features/occlusionquery
  56659. */
  56660. occlusionQueryAlgorithmType: number;
  56661. /**
  56662. * 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
  56663. * @see https://doc.babylonjs.com/features/occlusionquery
  56664. */
  56665. isOccluded: boolean;
  56666. /**
  56667. * Flag to check the progress status of the query
  56668. * @see https://doc.babylonjs.com/features/occlusionquery
  56669. */
  56670. isOcclusionQueryInProgress: boolean;
  56671. }
  56672. }
  56673. declare module BABYLON {
  56674. /** @hidden */
  56675. export var _forceTransformFeedbackToBundle: boolean;
  56676. interface Engine {
  56677. /**
  56678. * Creates a webGL transform feedback object
  56679. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  56680. * @returns the webGL transform feedback object
  56681. */
  56682. createTransformFeedback(): WebGLTransformFeedback;
  56683. /**
  56684. * Delete a webGL transform feedback object
  56685. * @param value defines the webGL transform feedback object to delete
  56686. */
  56687. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  56688. /**
  56689. * Bind a webGL transform feedback object to the webgl context
  56690. * @param value defines the webGL transform feedback object to bind
  56691. */
  56692. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  56693. /**
  56694. * Begins a transform feedback operation
  56695. * @param usePoints defines if points or triangles must be used
  56696. */
  56697. beginTransformFeedback(usePoints: boolean): void;
  56698. /**
  56699. * Ends a transform feedback operation
  56700. */
  56701. endTransformFeedback(): void;
  56702. /**
  56703. * Specify the varyings to use with transform feedback
  56704. * @param program defines the associated webGL program
  56705. * @param value defines the list of strings representing the varying names
  56706. */
  56707. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  56708. /**
  56709. * Bind a webGL buffer for a transform feedback operation
  56710. * @param value defines the webGL buffer to bind
  56711. */
  56712. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  56713. }
  56714. }
  56715. declare module BABYLON {
  56716. /**
  56717. * Class used to define an additional view for the engine
  56718. * @see https://doc.babylonjs.com/how_to/multi_canvases
  56719. */
  56720. export class EngineView {
  56721. /** Defines the canvas where to render the view */
  56722. target: HTMLCanvasElement;
  56723. /** Defines an optional camera used to render the view (will use active camera else) */
  56724. camera?: Camera;
  56725. }
  56726. interface Engine {
  56727. /**
  56728. * Gets or sets the HTML element to use for attaching events
  56729. */
  56730. inputElement: Nullable<HTMLElement>;
  56731. /**
  56732. * Gets the current engine view
  56733. * @see https://doc.babylonjs.com/how_to/multi_canvases
  56734. */
  56735. activeView: Nullable<EngineView>;
  56736. /** Gets or sets the list of views */
  56737. views: EngineView[];
  56738. /**
  56739. * Register a new child canvas
  56740. * @param canvas defines the canvas to register
  56741. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  56742. * @returns the associated view
  56743. */
  56744. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  56745. /**
  56746. * Remove a registered child canvas
  56747. * @param canvas defines the canvas to remove
  56748. * @returns the current engine
  56749. */
  56750. unRegisterView(canvas: HTMLCanvasElement): Engine;
  56751. }
  56752. }
  56753. declare module BABYLON {
  56754. interface Engine {
  56755. /** @hidden */
  56756. _excludedCompressedTextures: string[];
  56757. /** @hidden */
  56758. _textureFormatInUse: string;
  56759. /**
  56760. * Gets the list of texture formats supported
  56761. */
  56762. readonly texturesSupported: Array<string>;
  56763. /**
  56764. * Gets the texture format in use
  56765. */
  56766. readonly textureFormatInUse: Nullable<string>;
  56767. /**
  56768. * Set the compressed texture extensions or file names to skip.
  56769. *
  56770. * @param skippedFiles defines the list of those texture files you want to skip
  56771. * Example: [".dds", ".env", "myfile.png"]
  56772. */
  56773. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  56774. /**
  56775. * Set the compressed texture format to use, based on the formats you have, and the formats
  56776. * supported by the hardware / browser.
  56777. *
  56778. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  56779. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  56780. * to API arguments needed to compressed textures. This puts the burden on the container
  56781. * generator to house the arcane code for determining these for current & future formats.
  56782. *
  56783. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  56784. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  56785. *
  56786. * Note: The result of this call is not taken into account when a texture is base64.
  56787. *
  56788. * @param formatsAvailable defines the list of those format families you have created
  56789. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  56790. *
  56791. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  56792. * @returns The extension selected.
  56793. */
  56794. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  56795. }
  56796. }
  56797. declare module BABYLON {
  56798. /** @hidden */
  56799. export var rgbdEncodePixelShader: {
  56800. name: string;
  56801. shader: string;
  56802. };
  56803. }
  56804. declare module BABYLON {
  56805. /**
  56806. * Raw texture data and descriptor sufficient for WebGL texture upload
  56807. */
  56808. export interface EnvironmentTextureInfo {
  56809. /**
  56810. * Version of the environment map
  56811. */
  56812. version: number;
  56813. /**
  56814. * Width of image
  56815. */
  56816. width: number;
  56817. /**
  56818. * Irradiance information stored in the file.
  56819. */
  56820. irradiance: any;
  56821. /**
  56822. * Specular information stored in the file.
  56823. */
  56824. specular: any;
  56825. }
  56826. /**
  56827. * Defines One Image in the file. It requires only the position in the file
  56828. * as well as the length.
  56829. */
  56830. interface BufferImageData {
  56831. /**
  56832. * Length of the image data.
  56833. */
  56834. length: number;
  56835. /**
  56836. * Position of the data from the null terminator delimiting the end of the JSON.
  56837. */
  56838. position: number;
  56839. }
  56840. /**
  56841. * Defines the specular data enclosed in the file.
  56842. * This corresponds to the version 1 of the data.
  56843. */
  56844. export interface EnvironmentTextureSpecularInfoV1 {
  56845. /**
  56846. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  56847. */
  56848. specularDataPosition?: number;
  56849. /**
  56850. * This contains all the images data needed to reconstruct the cubemap.
  56851. */
  56852. mipmaps: Array<BufferImageData>;
  56853. /**
  56854. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  56855. */
  56856. lodGenerationScale: number;
  56857. }
  56858. /**
  56859. * Sets of helpers addressing the serialization and deserialization of environment texture
  56860. * stored in a BabylonJS env file.
  56861. * Those files are usually stored as .env files.
  56862. */
  56863. export class EnvironmentTextureTools {
  56864. /**
  56865. * Magic number identifying the env file.
  56866. */
  56867. private static _MagicBytes;
  56868. /**
  56869. * Gets the environment info from an env file.
  56870. * @param data The array buffer containing the .env bytes.
  56871. * @returns the environment file info (the json header) if successfully parsed.
  56872. */
  56873. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  56874. /**
  56875. * Creates an environment texture from a loaded cube texture.
  56876. * @param texture defines the cube texture to convert in env file
  56877. * @return a promise containing the environment data if succesfull.
  56878. */
  56879. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  56880. /**
  56881. * Creates a JSON representation of the spherical data.
  56882. * @param texture defines the texture containing the polynomials
  56883. * @return the JSON representation of the spherical info
  56884. */
  56885. private static _CreateEnvTextureIrradiance;
  56886. /**
  56887. * Creates the ArrayBufferViews used for initializing environment texture image data.
  56888. * @param data the image data
  56889. * @param info parameters that determine what views will be created for accessing the underlying buffer
  56890. * @return the views described by info providing access to the underlying buffer
  56891. */
  56892. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  56893. /**
  56894. * Uploads the texture info contained in the env file to the GPU.
  56895. * @param texture defines the internal texture to upload to
  56896. * @param data defines the data to load
  56897. * @param info defines the texture info retrieved through the GetEnvInfo method
  56898. * @returns a promise
  56899. */
  56900. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  56901. private static _OnImageReadyAsync;
  56902. /**
  56903. * Uploads the levels of image data to the GPU.
  56904. * @param texture defines the internal texture to upload to
  56905. * @param imageData defines the array buffer views of image data [mipmap][face]
  56906. * @returns a promise
  56907. */
  56908. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  56909. /**
  56910. * Uploads spherical polynomials information to the texture.
  56911. * @param texture defines the texture we are trying to upload the information to
  56912. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  56913. */
  56914. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  56915. /** @hidden */
  56916. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  56917. }
  56918. }
  56919. declare module BABYLON {
  56920. /**
  56921. * Class used to inline functions in shader code
  56922. */
  56923. export class ShaderCodeInliner {
  56924. private static readonly _RegexpFindFunctionNameAndType;
  56925. private _sourceCode;
  56926. private _functionDescr;
  56927. private _numMaxIterations;
  56928. /** Gets or sets the token used to mark the functions to inline */
  56929. inlineToken: string;
  56930. /** Gets or sets the debug mode */
  56931. debug: boolean;
  56932. /** Gets the code after the inlining process */
  56933. get code(): string;
  56934. /**
  56935. * Initializes the inliner
  56936. * @param sourceCode shader code source to inline
  56937. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  56938. */
  56939. constructor(sourceCode: string, numMaxIterations?: number);
  56940. /**
  56941. * Start the processing of the shader code
  56942. */
  56943. processCode(): void;
  56944. private _collectFunctions;
  56945. private _processInlining;
  56946. private _extractBetweenMarkers;
  56947. private _skipWhitespaces;
  56948. private _removeComments;
  56949. private _replaceFunctionCallsByCode;
  56950. private _findBackward;
  56951. private _escapeRegExp;
  56952. private _replaceNames;
  56953. }
  56954. }
  56955. declare module BABYLON {
  56956. /**
  56957. * Container for accessors for natively-stored mesh data buffers.
  56958. */
  56959. class NativeDataBuffer extends DataBuffer {
  56960. /**
  56961. * Accessor value used to identify/retrieve a natively-stored index buffer.
  56962. */
  56963. nativeIndexBuffer?: any;
  56964. /**
  56965. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  56966. */
  56967. nativeVertexBuffer?: any;
  56968. }
  56969. /** @hidden */
  56970. class NativeTexture extends InternalTexture {
  56971. getInternalTexture(): InternalTexture;
  56972. getViewCount(): number;
  56973. }
  56974. /** @hidden */
  56975. export class NativeEngine extends Engine {
  56976. private readonly _native;
  56977. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  56978. private readonly INVALID_HANDLE;
  56979. private _boundBuffersVertexArray;
  56980. private _currentDepthTest;
  56981. getHardwareScalingLevel(): number;
  56982. constructor();
  56983. dispose(): void;
  56984. /**
  56985. * Can be used to override the current requestAnimationFrame requester.
  56986. * @hidden
  56987. */
  56988. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  56989. /**
  56990. * Override default engine behavior.
  56991. * @param color
  56992. * @param backBuffer
  56993. * @param depth
  56994. * @param stencil
  56995. */
  56996. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  56997. /**
  56998. * Gets host document
  56999. * @returns the host document object
  57000. */
  57001. getHostDocument(): Nullable<Document>;
  57002. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  57003. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  57004. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  57005. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  57006. [key: string]: VertexBuffer;
  57007. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  57008. bindBuffers(vertexBuffers: {
  57009. [key: string]: VertexBuffer;
  57010. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  57011. recordVertexArrayObject(vertexBuffers: {
  57012. [key: string]: VertexBuffer;
  57013. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  57014. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  57015. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  57016. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  57017. /**
  57018. * Draw a list of indexed primitives
  57019. * @param fillMode defines the primitive to use
  57020. * @param indexStart defines the starting index
  57021. * @param indexCount defines the number of index to draw
  57022. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  57023. */
  57024. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  57025. /**
  57026. * Draw a list of unindexed primitives
  57027. * @param fillMode defines the primitive to use
  57028. * @param verticesStart defines the index of first vertex to draw
  57029. * @param verticesCount defines the count of vertices to draw
  57030. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  57031. */
  57032. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  57033. createPipelineContext(): IPipelineContext;
  57034. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  57035. /** @hidden */
  57036. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  57037. /** @hidden */
  57038. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  57039. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  57040. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  57041. protected _setProgram(program: WebGLProgram): void;
  57042. _releaseEffect(effect: Effect): void;
  57043. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  57044. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  57045. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  57046. bindSamplers(effect: Effect): void;
  57047. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  57048. getRenderWidth(useScreen?: boolean): number;
  57049. getRenderHeight(useScreen?: boolean): number;
  57050. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  57051. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  57052. /**
  57053. * Set the z offset to apply to current rendering
  57054. * @param value defines the offset to apply
  57055. */
  57056. setZOffset(value: number): void;
  57057. /**
  57058. * Gets the current value of the zOffset
  57059. * @returns the current zOffset state
  57060. */
  57061. getZOffset(): number;
  57062. /**
  57063. * Enable or disable depth buffering
  57064. * @param enable defines the state to set
  57065. */
  57066. setDepthBuffer(enable: boolean): void;
  57067. /**
  57068. * Gets a boolean indicating if depth writing is enabled
  57069. * @returns the current depth writing state
  57070. */
  57071. getDepthWrite(): boolean;
  57072. setDepthFunctionToGreater(): void;
  57073. setDepthFunctionToGreaterOrEqual(): void;
  57074. setDepthFunctionToLess(): void;
  57075. setDepthFunctionToLessOrEqual(): void;
  57076. /**
  57077. * Enable or disable depth writing
  57078. * @param enable defines the state to set
  57079. */
  57080. setDepthWrite(enable: boolean): void;
  57081. /**
  57082. * Enable or disable color writing
  57083. * @param enable defines the state to set
  57084. */
  57085. setColorWrite(enable: boolean): void;
  57086. /**
  57087. * Gets a boolean indicating if color writing is enabled
  57088. * @returns the current color writing state
  57089. */
  57090. getColorWrite(): boolean;
  57091. /**
  57092. * Sets alpha constants used by some alpha blending modes
  57093. * @param r defines the red component
  57094. * @param g defines the green component
  57095. * @param b defines the blue component
  57096. * @param a defines the alpha component
  57097. */
  57098. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  57099. /**
  57100. * Sets the current alpha mode
  57101. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  57102. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  57103. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  57104. */
  57105. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  57106. /**
  57107. * Gets the current alpha mode
  57108. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  57109. * @returns the current alpha mode
  57110. */
  57111. getAlphaMode(): number;
  57112. setInt(uniform: WebGLUniformLocation, int: number): boolean;
  57113. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  57114. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  57115. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  57116. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): boolean;
  57117. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  57118. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  57119. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  57120. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): boolean;
  57121. setArray(uniform: WebGLUniformLocation, array: number[]): boolean;
  57122. setArray2(uniform: WebGLUniformLocation, array: number[]): boolean;
  57123. setArray3(uniform: WebGLUniformLocation, array: number[]): boolean;
  57124. setArray4(uniform: WebGLUniformLocation, array: number[]): boolean;
  57125. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): boolean;
  57126. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  57127. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): boolean;
  57128. setFloat(uniform: WebGLUniformLocation, value: number): boolean;
  57129. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): boolean;
  57130. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): boolean;
  57131. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): boolean;
  57132. setColor3(uniform: WebGLUniformLocation, color3: Color3): boolean;
  57133. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): boolean;
  57134. wipeCaches(bruteForce?: boolean): void;
  57135. _createTexture(): WebGLTexture;
  57136. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  57137. /**
  57138. * Update the content of a dynamic texture
  57139. * @param texture defines the texture to update
  57140. * @param canvas defines the canvas containing the source
  57141. * @param invertY defines if data must be stored with Y axis inverted
  57142. * @param premulAlpha defines if alpha is stored as premultiplied
  57143. * @param format defines the format of the data
  57144. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  57145. */
  57146. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  57147. /**
  57148. * Usually called from Texture.ts.
  57149. * Passed information to create a WebGLTexture
  57150. * @param url defines a value which contains one of the following:
  57151. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  57152. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  57153. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  57154. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  57155. * @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)
  57156. * @param scene needed for loading to the correct scene
  57157. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  57158. * @param onLoad optional callback to be called upon successful completion
  57159. * @param onError optional callback to be called upon failure
  57160. * @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
  57161. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  57162. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  57163. * @param forcedExtension defines the extension to use to pick the right loader
  57164. * @param mimeType defines an optional mime type
  57165. * @param loaderOptions options to be passed to the loader
  57166. * @returns a InternalTexture for assignment back into BABYLON.Texture
  57167. */
  57168. createTexture(url: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, mimeType?: string, loaderOptions?: any): InternalTexture;
  57169. _createDepthStencilTexture(size: RenderTargetTextureSize, options: DepthTextureCreationOptions): NativeTexture;
  57170. _releaseFramebufferObjects(texture: InternalTexture): void;
  57171. /**
  57172. * Creates a cube texture
  57173. * @param rootUrl defines the url where the files to load is located
  57174. * @param scene defines the current scene
  57175. * @param files defines the list of files to load (1 per face)
  57176. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  57177. * @param onLoad defines an optional callback raised when the texture is loaded
  57178. * @param onError defines an optional callback raised if there is an issue to load the texture
  57179. * @param format defines the format of the data
  57180. * @param forcedExtension defines the extension to use to pick the right loader
  57181. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  57182. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  57183. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  57184. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  57185. * @returns the cube texture as an InternalTexture
  57186. */
  57187. 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;
  57188. createRenderTargetTexture(size: number | {
  57189. width: number;
  57190. height: number;
  57191. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  57192. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  57193. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  57194. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  57195. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  57196. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  57197. /**
  57198. * Updates a dynamic vertex buffer.
  57199. * @param vertexBuffer the vertex buffer to update
  57200. * @param data the data used to update the vertex buffer
  57201. * @param byteOffset the byte offset of the data (optional)
  57202. * @param byteLength the byte length of the data (optional)
  57203. */
  57204. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  57205. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  57206. private _updateAnisotropicLevel;
  57207. private _getAddressMode;
  57208. /** @hidden */
  57209. _bindTexture(channel: number, texture: InternalTexture): void;
  57210. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  57211. releaseEffects(): void;
  57212. /** @hidden */
  57213. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  57214. /** @hidden */
  57215. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  57216. /** @hidden */
  57217. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  57218. /** @hidden */
  57219. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  57220. private _getNativeSamplingMode;
  57221. private _getNativeTextureFormat;
  57222. private _getNativeAlphaMode;
  57223. private _getNativeAttribType;
  57224. }
  57225. }
  57226. declare module BABYLON {
  57227. /**
  57228. * Gather the list of clipboard event types as constants.
  57229. */
  57230. export class ClipboardEventTypes {
  57231. /**
  57232. * The clipboard event is fired when a copy command is active (pressed).
  57233. */
  57234. static readonly COPY: number;
  57235. /**
  57236. * The clipboard event is fired when a cut command is active (pressed).
  57237. */
  57238. static readonly CUT: number;
  57239. /**
  57240. * The clipboard event is fired when a paste command is active (pressed).
  57241. */
  57242. static readonly PASTE: number;
  57243. }
  57244. /**
  57245. * This class is used to store clipboard related info for the onClipboardObservable event.
  57246. */
  57247. export class ClipboardInfo {
  57248. /**
  57249. * Defines the type of event (BABYLON.ClipboardEventTypes)
  57250. */
  57251. type: number;
  57252. /**
  57253. * Defines the related dom event
  57254. */
  57255. event: ClipboardEvent;
  57256. /**
  57257. *Creates an instance of ClipboardInfo.
  57258. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  57259. * @param event Defines the related dom event
  57260. */
  57261. constructor(
  57262. /**
  57263. * Defines the type of event (BABYLON.ClipboardEventTypes)
  57264. */
  57265. type: number,
  57266. /**
  57267. * Defines the related dom event
  57268. */
  57269. event: ClipboardEvent);
  57270. /**
  57271. * Get the clipboard event's type from the keycode.
  57272. * @param keyCode Defines the keyCode for the current keyboard event.
  57273. * @return {number}
  57274. */
  57275. static GetTypeFromCharacter(keyCode: number): number;
  57276. }
  57277. }
  57278. declare module BABYLON {
  57279. /**
  57280. * Google Daydream controller
  57281. */
  57282. export class DaydreamController extends WebVRController {
  57283. /**
  57284. * Base Url for the controller model.
  57285. */
  57286. static MODEL_BASE_URL: string;
  57287. /**
  57288. * File name for the controller model.
  57289. */
  57290. static MODEL_FILENAME: string;
  57291. /**
  57292. * Gamepad Id prefix used to identify Daydream Controller.
  57293. */
  57294. static readonly GAMEPAD_ID_PREFIX: string;
  57295. /**
  57296. * Creates a new DaydreamController from a gamepad
  57297. * @param vrGamepad the gamepad that the controller should be created from
  57298. */
  57299. constructor(vrGamepad: any);
  57300. /**
  57301. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  57302. * @param scene scene in which to add meshes
  57303. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  57304. */
  57305. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  57306. /**
  57307. * Called once for each button that changed state since the last frame
  57308. * @param buttonIdx Which button index changed
  57309. * @param state New state of the button
  57310. * @param changes Which properties on the state changed since last frame
  57311. */
  57312. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  57313. }
  57314. }
  57315. declare module BABYLON {
  57316. /**
  57317. * Gear VR Controller
  57318. */
  57319. export class GearVRController extends WebVRController {
  57320. /**
  57321. * Base Url for the controller model.
  57322. */
  57323. static MODEL_BASE_URL: string;
  57324. /**
  57325. * File name for the controller model.
  57326. */
  57327. static MODEL_FILENAME: string;
  57328. /**
  57329. * Gamepad Id prefix used to identify this controller.
  57330. */
  57331. static readonly GAMEPAD_ID_PREFIX: string;
  57332. private readonly _buttonIndexToObservableNameMap;
  57333. /**
  57334. * Creates a new GearVRController from a gamepad
  57335. * @param vrGamepad the gamepad that the controller should be created from
  57336. */
  57337. constructor(vrGamepad: any);
  57338. /**
  57339. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  57340. * @param scene scene in which to add meshes
  57341. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  57342. */
  57343. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  57344. /**
  57345. * Called once for each button that changed state since the last frame
  57346. * @param buttonIdx Which button index changed
  57347. * @param state New state of the button
  57348. * @param changes Which properties on the state changed since last frame
  57349. */
  57350. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  57351. }
  57352. }
  57353. declare module BABYLON {
  57354. /**
  57355. * Generic Controller
  57356. */
  57357. export class GenericController extends WebVRController {
  57358. /**
  57359. * Base Url for the controller model.
  57360. */
  57361. static readonly MODEL_BASE_URL: string;
  57362. /**
  57363. * File name for the controller model.
  57364. */
  57365. static readonly MODEL_FILENAME: string;
  57366. /**
  57367. * Creates a new GenericController from a gamepad
  57368. * @param vrGamepad the gamepad that the controller should be created from
  57369. */
  57370. constructor(vrGamepad: any);
  57371. /**
  57372. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  57373. * @param scene scene in which to add meshes
  57374. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  57375. */
  57376. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  57377. /**
  57378. * Called once for each button that changed state since the last frame
  57379. * @param buttonIdx Which button index changed
  57380. * @param state New state of the button
  57381. * @param changes Which properties on the state changed since last frame
  57382. */
  57383. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  57384. }
  57385. }
  57386. declare module BABYLON {
  57387. /**
  57388. * Oculus Touch Controller
  57389. */
  57390. export class OculusTouchController extends WebVRController {
  57391. /**
  57392. * Base Url for the controller model.
  57393. */
  57394. static MODEL_BASE_URL: string;
  57395. /**
  57396. * File name for the left controller model.
  57397. */
  57398. static MODEL_LEFT_FILENAME: string;
  57399. /**
  57400. * File name for the right controller model.
  57401. */
  57402. static MODEL_RIGHT_FILENAME: string;
  57403. /**
  57404. * Base Url for the Quest controller model.
  57405. */
  57406. static QUEST_MODEL_BASE_URL: string;
  57407. /**
  57408. * @hidden
  57409. * If the controllers are running on a device that needs the updated Quest controller models
  57410. */
  57411. static _IsQuest: boolean;
  57412. /**
  57413. * Fired when the secondary trigger on this controller is modified
  57414. */
  57415. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  57416. /**
  57417. * Fired when the thumb rest on this controller is modified
  57418. */
  57419. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  57420. /**
  57421. * Creates a new OculusTouchController from a gamepad
  57422. * @param vrGamepad the gamepad that the controller should be created from
  57423. */
  57424. constructor(vrGamepad: any);
  57425. /**
  57426. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  57427. * @param scene scene in which to add meshes
  57428. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  57429. */
  57430. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  57431. /**
  57432. * Fired when the A button on this controller is modified
  57433. */
  57434. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  57435. /**
  57436. * Fired when the B button on this controller is modified
  57437. */
  57438. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  57439. /**
  57440. * Fired when the X button on this controller is modified
  57441. */
  57442. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  57443. /**
  57444. * Fired when the Y button on this controller is modified
  57445. */
  57446. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  57447. /**
  57448. * Called once for each button that changed state since the last frame
  57449. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  57450. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  57451. * 2) secondary trigger (same)
  57452. * 3) A (right) X (left), touch, pressed = value
  57453. * 4) B / Y
  57454. * 5) thumb rest
  57455. * @param buttonIdx Which button index changed
  57456. * @param state New state of the button
  57457. * @param changes Which properties on the state changed since last frame
  57458. */
  57459. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  57460. }
  57461. }
  57462. declare module BABYLON {
  57463. /**
  57464. * Vive Controller
  57465. */
  57466. export class ViveController extends WebVRController {
  57467. /**
  57468. * Base Url for the controller model.
  57469. */
  57470. static MODEL_BASE_URL: string;
  57471. /**
  57472. * File name for the controller model.
  57473. */
  57474. static MODEL_FILENAME: string;
  57475. /**
  57476. * Creates a new ViveController from a gamepad
  57477. * @param vrGamepad the gamepad that the controller should be created from
  57478. */
  57479. constructor(vrGamepad: any);
  57480. /**
  57481. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  57482. * @param scene scene in which to add meshes
  57483. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  57484. */
  57485. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  57486. /**
  57487. * Fired when the left button on this controller is modified
  57488. */
  57489. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  57490. /**
  57491. * Fired when the right button on this controller is modified
  57492. */
  57493. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  57494. /**
  57495. * Fired when the menu button on this controller is modified
  57496. */
  57497. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  57498. /**
  57499. * Called once for each button that changed state since the last frame
  57500. * Vive mapping:
  57501. * 0: touchpad
  57502. * 1: trigger
  57503. * 2: left AND right buttons
  57504. * 3: menu button
  57505. * @param buttonIdx Which button index changed
  57506. * @param state New state of the button
  57507. * @param changes Which properties on the state changed since last frame
  57508. */
  57509. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  57510. }
  57511. }
  57512. declare module BABYLON {
  57513. /**
  57514. * Defines the WindowsMotionController object that the state of the windows motion controller
  57515. */
  57516. export class WindowsMotionController extends WebVRController {
  57517. /**
  57518. * The base url used to load the left and right controller models
  57519. */
  57520. static MODEL_BASE_URL: string;
  57521. /**
  57522. * The name of the left controller model file
  57523. */
  57524. static MODEL_LEFT_FILENAME: string;
  57525. /**
  57526. * The name of the right controller model file
  57527. */
  57528. static MODEL_RIGHT_FILENAME: string;
  57529. /**
  57530. * The controller name prefix for this controller type
  57531. */
  57532. static readonly GAMEPAD_ID_PREFIX: string;
  57533. /**
  57534. * The controller id pattern for this controller type
  57535. */
  57536. private static readonly GAMEPAD_ID_PATTERN;
  57537. private _loadedMeshInfo;
  57538. protected readonly _mapping: {
  57539. buttons: string[];
  57540. buttonMeshNames: {
  57541. trigger: string;
  57542. menu: string;
  57543. grip: string;
  57544. thumbstick: string;
  57545. trackpad: string;
  57546. };
  57547. buttonObservableNames: {
  57548. trigger: string;
  57549. menu: string;
  57550. grip: string;
  57551. thumbstick: string;
  57552. trackpad: string;
  57553. };
  57554. axisMeshNames: string[];
  57555. pointingPoseMeshName: string;
  57556. };
  57557. /**
  57558. * Fired when the trackpad on this controller is clicked
  57559. */
  57560. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  57561. /**
  57562. * Fired when the trackpad on this controller is modified
  57563. */
  57564. onTrackpadValuesChangedObservable: Observable<StickValues>;
  57565. /**
  57566. * The current x and y values of this controller's trackpad
  57567. */
  57568. trackpad: StickValues;
  57569. /**
  57570. * Creates a new WindowsMotionController from a gamepad
  57571. * @param vrGamepad the gamepad that the controller should be created from
  57572. */
  57573. constructor(vrGamepad: any);
  57574. /**
  57575. * Fired when the trigger on this controller is modified
  57576. */
  57577. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  57578. /**
  57579. * Fired when the menu button on this controller is modified
  57580. */
  57581. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  57582. /**
  57583. * Fired when the grip button on this controller is modified
  57584. */
  57585. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  57586. /**
  57587. * Fired when the thumbstick button on this controller is modified
  57588. */
  57589. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  57590. /**
  57591. * Fired when the touchpad button on this controller is modified
  57592. */
  57593. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  57594. /**
  57595. * Fired when the touchpad values on this controller are modified
  57596. */
  57597. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  57598. protected _updateTrackpad(): void;
  57599. /**
  57600. * Called once per frame by the engine.
  57601. */
  57602. update(): void;
  57603. /**
  57604. * Called once for each button that changed state since the last frame
  57605. * @param buttonIdx Which button index changed
  57606. * @param state New state of the button
  57607. * @param changes Which properties on the state changed since last frame
  57608. */
  57609. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  57610. /**
  57611. * Moves the buttons on the controller mesh based on their current state
  57612. * @param buttonName the name of the button to move
  57613. * @param buttonValue the value of the button which determines the buttons new position
  57614. */
  57615. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  57616. /**
  57617. * Moves the axis on the controller mesh based on its current state
  57618. * @param axis the index of the axis
  57619. * @param axisValue the value of the axis which determines the meshes new position
  57620. * @hidden
  57621. */
  57622. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  57623. /**
  57624. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  57625. * @param scene scene in which to add meshes
  57626. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  57627. */
  57628. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  57629. /**
  57630. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  57631. * can be transformed by button presses and axes values, based on this._mapping.
  57632. *
  57633. * @param scene scene in which the meshes exist
  57634. * @param meshes list of meshes that make up the controller model to process
  57635. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  57636. */
  57637. private processModel;
  57638. private createMeshInfo;
  57639. /**
  57640. * Gets the ray of the controller in the direction the controller is pointing
  57641. * @param length the length the resulting ray should be
  57642. * @returns a ray in the direction the controller is pointing
  57643. */
  57644. getForwardRay(length?: number): Ray;
  57645. /**
  57646. * Disposes of the controller
  57647. */
  57648. dispose(): void;
  57649. }
  57650. /**
  57651. * This class represents a new windows motion controller in XR.
  57652. */
  57653. export class XRWindowsMotionController extends WindowsMotionController {
  57654. /**
  57655. * Changing the original WIndowsMotionController mapping to fir the new mapping
  57656. */
  57657. protected readonly _mapping: {
  57658. buttons: string[];
  57659. buttonMeshNames: {
  57660. trigger: string;
  57661. menu: string;
  57662. grip: string;
  57663. thumbstick: string;
  57664. trackpad: string;
  57665. };
  57666. buttonObservableNames: {
  57667. trigger: string;
  57668. menu: string;
  57669. grip: string;
  57670. thumbstick: string;
  57671. trackpad: string;
  57672. };
  57673. axisMeshNames: string[];
  57674. pointingPoseMeshName: string;
  57675. };
  57676. /**
  57677. * Construct a new XR-Based windows motion controller
  57678. *
  57679. * @param gamepadInfo the gamepad object from the browser
  57680. */
  57681. constructor(gamepadInfo: any);
  57682. /**
  57683. * holds the thumbstick values (X,Y)
  57684. */
  57685. thumbstickValues: StickValues;
  57686. /**
  57687. * Fired when the thumbstick on this controller is clicked
  57688. */
  57689. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  57690. /**
  57691. * Fired when the thumbstick on this controller is modified
  57692. */
  57693. onThumbstickValuesChangedObservable: Observable<StickValues>;
  57694. /**
  57695. * Fired when the touchpad button on this controller is modified
  57696. */
  57697. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  57698. /**
  57699. * Fired when the touchpad values on this controller are modified
  57700. */
  57701. onTrackpadValuesChangedObservable: Observable<StickValues>;
  57702. /**
  57703. * Fired when the thumbstick button on this controller is modified
  57704. * here to prevent breaking changes
  57705. */
  57706. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  57707. /**
  57708. * updating the thumbstick(!) and not the trackpad.
  57709. * This is named this way due to the difference between WebVR and XR and to avoid
  57710. * changing the parent class.
  57711. */
  57712. protected _updateTrackpad(): void;
  57713. /**
  57714. * Disposes the class with joy
  57715. */
  57716. dispose(): void;
  57717. }
  57718. }
  57719. declare module BABYLON {
  57720. /**
  57721. * A directional light is defined by a direction (what a surprise!).
  57722. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  57723. * 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.
  57724. * Documentation: https://doc.babylonjs.com/babylon101/lights
  57725. */
  57726. export class DirectionalLight extends ShadowLight {
  57727. private _shadowFrustumSize;
  57728. /**
  57729. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  57730. */
  57731. get shadowFrustumSize(): number;
  57732. /**
  57733. * Specifies a fix frustum size for the shadow generation.
  57734. */
  57735. set shadowFrustumSize(value: number);
  57736. private _shadowOrthoScale;
  57737. /**
  57738. * Gets the shadow projection scale against the optimal computed one.
  57739. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  57740. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  57741. */
  57742. get shadowOrthoScale(): number;
  57743. /**
  57744. * Sets the shadow projection scale against the optimal computed one.
  57745. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  57746. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  57747. */
  57748. set shadowOrthoScale(value: number);
  57749. /**
  57750. * Automatically compute the projection matrix to best fit (including all the casters)
  57751. * on each frame.
  57752. */
  57753. autoUpdateExtends: boolean;
  57754. /**
  57755. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  57756. * on each frame. autoUpdateExtends must be set to true for this to work
  57757. */
  57758. autoCalcShadowZBounds: boolean;
  57759. private _orthoLeft;
  57760. private _orthoRight;
  57761. private _orthoTop;
  57762. private _orthoBottom;
  57763. /**
  57764. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  57765. * The directional light is emitted from everywhere in the given direction.
  57766. * It can cast shadows.
  57767. * Documentation : https://doc.babylonjs.com/babylon101/lights
  57768. * @param name The friendly name of the light
  57769. * @param direction The direction of the light
  57770. * @param scene The scene the light belongs to
  57771. */
  57772. constructor(name: string, direction: Vector3, scene: Scene);
  57773. /**
  57774. * Returns the string "DirectionalLight".
  57775. * @return The class name
  57776. */
  57777. getClassName(): string;
  57778. /**
  57779. * Returns the integer 1.
  57780. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  57781. */
  57782. getTypeID(): number;
  57783. /**
  57784. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  57785. * Returns the DirectionalLight Shadow projection matrix.
  57786. */
  57787. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  57788. /**
  57789. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  57790. * Returns the DirectionalLight Shadow projection matrix.
  57791. */
  57792. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  57793. /**
  57794. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  57795. * Returns the DirectionalLight Shadow projection matrix.
  57796. */
  57797. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  57798. protected _buildUniformLayout(): void;
  57799. /**
  57800. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  57801. * @param effect The effect to update
  57802. * @param lightIndex The index of the light in the effect to update
  57803. * @returns The directional light
  57804. */
  57805. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  57806. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  57807. /**
  57808. * Gets the minZ used for shadow according to both the scene and the light.
  57809. *
  57810. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  57811. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  57812. * @param activeCamera The camera we are returning the min for
  57813. * @returns the depth min z
  57814. */
  57815. getDepthMinZ(activeCamera: Camera): number;
  57816. /**
  57817. * Gets the maxZ used for shadow according to both the scene and the light.
  57818. *
  57819. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  57820. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  57821. * @param activeCamera The camera we are returning the max for
  57822. * @returns the depth max z
  57823. */
  57824. getDepthMaxZ(activeCamera: Camera): number;
  57825. /**
  57826. * Prepares the list of defines specific to the light type.
  57827. * @param defines the list of defines
  57828. * @param lightIndex defines the index of the light for the effect
  57829. */
  57830. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  57831. }
  57832. }
  57833. declare module BABYLON {
  57834. /**
  57835. * Class containing static functions to help procedurally build meshes
  57836. */
  57837. export class HemisphereBuilder {
  57838. /**
  57839. * Creates a hemisphere mesh
  57840. * @param name defines the name of the mesh
  57841. * @param options defines the options used to create the mesh
  57842. * @param scene defines the hosting scene
  57843. * @returns the hemisphere mesh
  57844. */
  57845. static CreateHemisphere(name: string, options: {
  57846. segments?: number;
  57847. diameter?: number;
  57848. sideOrientation?: number;
  57849. }, scene: any): Mesh;
  57850. }
  57851. }
  57852. declare module BABYLON {
  57853. /**
  57854. * A spot light is defined by a position, a direction, an angle, and an exponent.
  57855. * These values define a cone of light starting from the position, emitting toward the direction.
  57856. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  57857. * and the exponent defines the speed of the decay of the light with distance (reach).
  57858. * Documentation: https://doc.babylonjs.com/babylon101/lights
  57859. */
  57860. export class SpotLight extends ShadowLight {
  57861. private _angle;
  57862. private _innerAngle;
  57863. private _cosHalfAngle;
  57864. private _lightAngleScale;
  57865. private _lightAngleOffset;
  57866. /**
  57867. * Gets the cone angle of the spot light in Radians.
  57868. */
  57869. get angle(): number;
  57870. /**
  57871. * Sets the cone angle of the spot light in Radians.
  57872. */
  57873. set angle(value: number);
  57874. /**
  57875. * Only used in gltf falloff mode, this defines the angle where
  57876. * the directional falloff will start before cutting at angle which could be seen
  57877. * as outer angle.
  57878. */
  57879. get innerAngle(): number;
  57880. /**
  57881. * Only used in gltf falloff mode, this defines the angle where
  57882. * the directional falloff will start before cutting at angle which could be seen
  57883. * as outer angle.
  57884. */
  57885. set innerAngle(value: number);
  57886. private _shadowAngleScale;
  57887. /**
  57888. * Allows scaling the angle of the light for shadow generation only.
  57889. */
  57890. get shadowAngleScale(): number;
  57891. /**
  57892. * Allows scaling the angle of the light for shadow generation only.
  57893. */
  57894. set shadowAngleScale(value: number);
  57895. /**
  57896. * The light decay speed with the distance from the emission spot.
  57897. */
  57898. exponent: number;
  57899. private _projectionTextureMatrix;
  57900. /**
  57901. * Allows reading the projecton texture
  57902. */
  57903. get projectionTextureMatrix(): Matrix;
  57904. protected _projectionTextureLightNear: number;
  57905. /**
  57906. * Gets the near clip of the Spotlight for texture projection.
  57907. */
  57908. get projectionTextureLightNear(): number;
  57909. /**
  57910. * Sets the near clip of the Spotlight for texture projection.
  57911. */
  57912. set projectionTextureLightNear(value: number);
  57913. protected _projectionTextureLightFar: number;
  57914. /**
  57915. * Gets the far clip of the Spotlight for texture projection.
  57916. */
  57917. get projectionTextureLightFar(): number;
  57918. /**
  57919. * Sets the far clip of the Spotlight for texture projection.
  57920. */
  57921. set projectionTextureLightFar(value: number);
  57922. protected _projectionTextureUpDirection: Vector3;
  57923. /**
  57924. * Gets the Up vector of the Spotlight for texture projection.
  57925. */
  57926. get projectionTextureUpDirection(): Vector3;
  57927. /**
  57928. * Sets the Up vector of the Spotlight for texture projection.
  57929. */
  57930. set projectionTextureUpDirection(value: Vector3);
  57931. private _projectionTexture;
  57932. /**
  57933. * Gets the projection texture of the light.
  57934. */
  57935. get projectionTexture(): Nullable<BaseTexture>;
  57936. /**
  57937. * Sets the projection texture of the light.
  57938. */
  57939. set projectionTexture(value: Nullable<BaseTexture>);
  57940. private static _IsProceduralTexture;
  57941. private static _IsTexture;
  57942. private _projectionTextureViewLightDirty;
  57943. private _projectionTextureProjectionLightDirty;
  57944. private _projectionTextureDirty;
  57945. private _projectionTextureViewTargetVector;
  57946. private _projectionTextureViewLightMatrix;
  57947. private _projectionTextureProjectionLightMatrix;
  57948. private _projectionTextureScalingMatrix;
  57949. /**
  57950. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  57951. * It can cast shadows.
  57952. * Documentation : https://doc.babylonjs.com/babylon101/lights
  57953. * @param name The light friendly name
  57954. * @param position The position of the spot light in the scene
  57955. * @param direction The direction of the light in the scene
  57956. * @param angle The cone angle of the light in Radians
  57957. * @param exponent The light decay speed with the distance from the emission spot
  57958. * @param scene The scene the lights belongs to
  57959. */
  57960. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  57961. /**
  57962. * Returns the string "SpotLight".
  57963. * @returns the class name
  57964. */
  57965. getClassName(): string;
  57966. /**
  57967. * Returns the integer 2.
  57968. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  57969. */
  57970. getTypeID(): number;
  57971. /**
  57972. * Overrides the direction setter to recompute the projection texture view light Matrix.
  57973. */
  57974. protected _setDirection(value: Vector3): void;
  57975. /**
  57976. * Overrides the position setter to recompute the projection texture view light Matrix.
  57977. */
  57978. protected _setPosition(value: Vector3): void;
  57979. /**
  57980. * 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.
  57981. * Returns the SpotLight.
  57982. */
  57983. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  57984. protected _computeProjectionTextureViewLightMatrix(): void;
  57985. protected _computeProjectionTextureProjectionLightMatrix(): void;
  57986. /**
  57987. * Main function for light texture projection matrix computing.
  57988. */
  57989. protected _computeProjectionTextureMatrix(): void;
  57990. protected _buildUniformLayout(): void;
  57991. private _computeAngleValues;
  57992. /**
  57993. * Sets the passed Effect "effect" with the Light textures.
  57994. * @param effect The effect to update
  57995. * @param lightIndex The index of the light in the effect to update
  57996. * @returns The light
  57997. */
  57998. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  57999. /**
  58000. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  58001. * @param effect The effect to update
  58002. * @param lightIndex The index of the light in the effect to update
  58003. * @returns The spot light
  58004. */
  58005. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  58006. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  58007. /**
  58008. * Disposes the light and the associated resources.
  58009. */
  58010. dispose(): void;
  58011. /**
  58012. * Prepares the list of defines specific to the light type.
  58013. * @param defines the list of defines
  58014. * @param lightIndex defines the index of the light for the effect
  58015. */
  58016. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  58017. }
  58018. }
  58019. declare module BABYLON {
  58020. /**
  58021. * Gizmo that enables viewing a light
  58022. */
  58023. export class LightGizmo extends Gizmo {
  58024. private _lightMesh;
  58025. private _material;
  58026. private _cachedPosition;
  58027. private _cachedForward;
  58028. private _attachedMeshParent;
  58029. private _pointerObserver;
  58030. /**
  58031. * Event that fires each time the gizmo is clicked
  58032. */
  58033. onClickedObservable: Observable<Light>;
  58034. /**
  58035. * Creates a LightGizmo
  58036. * @param gizmoLayer The utility layer the gizmo will be added to
  58037. */
  58038. constructor(gizmoLayer?: UtilityLayerRenderer);
  58039. private _light;
  58040. /**
  58041. * The light that the gizmo is attached to
  58042. */
  58043. set light(light: Nullable<Light>);
  58044. get light(): Nullable<Light>;
  58045. /**
  58046. * Gets the material used to render the light gizmo
  58047. */
  58048. get material(): StandardMaterial;
  58049. /**
  58050. * @hidden
  58051. * Updates the gizmo to match the attached mesh's position/rotation
  58052. */
  58053. protected _update(): void;
  58054. private static _Scale;
  58055. /**
  58056. * Creates the lines for a light mesh
  58057. */
  58058. private static _CreateLightLines;
  58059. /**
  58060. * Disposes of the light gizmo
  58061. */
  58062. dispose(): void;
  58063. private static _CreateHemisphericLightMesh;
  58064. private static _CreatePointLightMesh;
  58065. private static _CreateSpotLightMesh;
  58066. private static _CreateDirectionalLightMesh;
  58067. }
  58068. }
  58069. declare module BABYLON {
  58070. /**
  58071. * Gizmo that enables viewing a camera
  58072. */
  58073. export class CameraGizmo extends Gizmo {
  58074. private _cameraMesh;
  58075. private _cameraLinesMesh;
  58076. private _material;
  58077. private _pointerObserver;
  58078. /**
  58079. * Event that fires each time the gizmo is clicked
  58080. */
  58081. onClickedObservable: Observable<Camera>;
  58082. /**
  58083. * Creates a CameraGizmo
  58084. * @param gizmoLayer The utility layer the gizmo will be added to
  58085. */
  58086. constructor(gizmoLayer?: UtilityLayerRenderer);
  58087. private _camera;
  58088. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  58089. get displayFrustum(): boolean;
  58090. set displayFrustum(value: boolean);
  58091. /**
  58092. * The camera that the gizmo is attached to
  58093. */
  58094. set camera(camera: Nullable<Camera>);
  58095. get camera(): Nullable<Camera>;
  58096. /**
  58097. * Gets the material used to render the camera gizmo
  58098. */
  58099. get material(): StandardMaterial;
  58100. /**
  58101. * @hidden
  58102. * Updates the gizmo to match the attached mesh's position/rotation
  58103. */
  58104. protected _update(): void;
  58105. private static _Scale;
  58106. private _invProjection;
  58107. /**
  58108. * Disposes of the camera gizmo
  58109. */
  58110. dispose(): void;
  58111. private static _CreateCameraMesh;
  58112. private static _CreateCameraFrustum;
  58113. }
  58114. }
  58115. declare module BABYLON {
  58116. /** @hidden */
  58117. export var backgroundFragmentDeclaration: {
  58118. name: string;
  58119. shader: string;
  58120. };
  58121. }
  58122. declare module BABYLON {
  58123. /** @hidden */
  58124. export var backgroundUboDeclaration: {
  58125. name: string;
  58126. shader: string;
  58127. };
  58128. }
  58129. declare module BABYLON {
  58130. /** @hidden */
  58131. export var backgroundPixelShader: {
  58132. name: string;
  58133. shader: string;
  58134. };
  58135. }
  58136. declare module BABYLON {
  58137. /** @hidden */
  58138. export var backgroundVertexDeclaration: {
  58139. name: string;
  58140. shader: string;
  58141. };
  58142. }
  58143. declare module BABYLON {
  58144. /** @hidden */
  58145. export var backgroundVertexShader: {
  58146. name: string;
  58147. shader: string;
  58148. };
  58149. }
  58150. declare module BABYLON {
  58151. /**
  58152. * Background material used to create an efficient environement around your scene.
  58153. */
  58154. export class BackgroundMaterial extends PushMaterial {
  58155. /**
  58156. * Standard reflectance value at parallel view angle.
  58157. */
  58158. static StandardReflectance0: number;
  58159. /**
  58160. * Standard reflectance value at grazing angle.
  58161. */
  58162. static StandardReflectance90: number;
  58163. protected _primaryColor: Color3;
  58164. /**
  58165. * Key light Color (multiply against the environement texture)
  58166. */
  58167. primaryColor: Color3;
  58168. protected __perceptualColor: Nullable<Color3>;
  58169. /**
  58170. * Experimental Internal Use Only.
  58171. *
  58172. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  58173. * This acts as a helper to set the primary color to a more "human friendly" value.
  58174. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  58175. * output color as close as possible from the chosen value.
  58176. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  58177. * part of lighting setup.)
  58178. */
  58179. get _perceptualColor(): Nullable<Color3>;
  58180. set _perceptualColor(value: Nullable<Color3>);
  58181. protected _primaryColorShadowLevel: float;
  58182. /**
  58183. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  58184. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  58185. */
  58186. get primaryColorShadowLevel(): float;
  58187. set primaryColorShadowLevel(value: float);
  58188. protected _primaryColorHighlightLevel: float;
  58189. /**
  58190. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  58191. * The primary color is used at the level chosen to define what the white area would look.
  58192. */
  58193. get primaryColorHighlightLevel(): float;
  58194. set primaryColorHighlightLevel(value: float);
  58195. protected _reflectionTexture: Nullable<BaseTexture>;
  58196. /**
  58197. * Reflection Texture used in the material.
  58198. * Should be author in a specific way for the best result (refer to the documentation).
  58199. */
  58200. reflectionTexture: Nullable<BaseTexture>;
  58201. protected _reflectionBlur: float;
  58202. /**
  58203. * Reflection Texture level of blur.
  58204. *
  58205. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  58206. * texture twice.
  58207. */
  58208. reflectionBlur: float;
  58209. protected _diffuseTexture: Nullable<BaseTexture>;
  58210. /**
  58211. * Diffuse Texture used in the material.
  58212. * Should be author in a specific way for the best result (refer to the documentation).
  58213. */
  58214. diffuseTexture: Nullable<BaseTexture>;
  58215. protected _shadowLights: Nullable<IShadowLight[]>;
  58216. /**
  58217. * Specify the list of lights casting shadow on the material.
  58218. * All scene shadow lights will be included if null.
  58219. */
  58220. shadowLights: Nullable<IShadowLight[]>;
  58221. protected _shadowLevel: float;
  58222. /**
  58223. * Helps adjusting the shadow to a softer level if required.
  58224. * 0 means black shadows and 1 means no shadows.
  58225. */
  58226. shadowLevel: float;
  58227. protected _sceneCenter: Vector3;
  58228. /**
  58229. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  58230. * It is usually zero but might be interesting to modify according to your setup.
  58231. */
  58232. sceneCenter: Vector3;
  58233. protected _opacityFresnel: boolean;
  58234. /**
  58235. * This helps specifying that the material is falling off to the sky box at grazing angle.
  58236. * This helps ensuring a nice transition when the camera goes under the ground.
  58237. */
  58238. opacityFresnel: boolean;
  58239. protected _reflectionFresnel: boolean;
  58240. /**
  58241. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  58242. * This helps adding a mirror texture on the ground.
  58243. */
  58244. reflectionFresnel: boolean;
  58245. protected _reflectionFalloffDistance: number;
  58246. /**
  58247. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  58248. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  58249. */
  58250. reflectionFalloffDistance: number;
  58251. protected _reflectionAmount: number;
  58252. /**
  58253. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  58254. */
  58255. reflectionAmount: number;
  58256. protected _reflectionReflectance0: number;
  58257. /**
  58258. * This specifies the weight of the reflection at grazing angle.
  58259. */
  58260. reflectionReflectance0: number;
  58261. protected _reflectionReflectance90: number;
  58262. /**
  58263. * This specifies the weight of the reflection at a perpendicular point of view.
  58264. */
  58265. reflectionReflectance90: number;
  58266. /**
  58267. * Sets the reflection reflectance fresnel values according to the default standard
  58268. * empirically know to work well :-)
  58269. */
  58270. set reflectionStandardFresnelWeight(value: number);
  58271. protected _useRGBColor: boolean;
  58272. /**
  58273. * Helps to directly use the maps channels instead of their level.
  58274. */
  58275. useRGBColor: boolean;
  58276. protected _enableNoise: boolean;
  58277. /**
  58278. * This helps reducing the banding effect that could occur on the background.
  58279. */
  58280. enableNoise: boolean;
  58281. /**
  58282. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  58283. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  58284. * Recommended to be keep at 1.0 except for special cases.
  58285. */
  58286. get fovMultiplier(): number;
  58287. set fovMultiplier(value: number);
  58288. private _fovMultiplier;
  58289. /**
  58290. * Enable the FOV adjustment feature controlled by fovMultiplier.
  58291. */
  58292. useEquirectangularFOV: boolean;
  58293. private _maxSimultaneousLights;
  58294. /**
  58295. * Number of Simultaneous lights allowed on the material.
  58296. */
  58297. maxSimultaneousLights: int;
  58298. private _shadowOnly;
  58299. /**
  58300. * Make the material only render shadows
  58301. */
  58302. shadowOnly: boolean;
  58303. /**
  58304. * Default configuration related to image processing available in the Background Material.
  58305. */
  58306. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  58307. /**
  58308. * Keep track of the image processing observer to allow dispose and replace.
  58309. */
  58310. private _imageProcessingObserver;
  58311. /**
  58312. * Attaches a new image processing configuration to the PBR Material.
  58313. * @param configuration (if null the scene configuration will be use)
  58314. */
  58315. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  58316. /**
  58317. * Gets the image processing configuration used either in this material.
  58318. */
  58319. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  58320. /**
  58321. * Sets the Default image processing configuration used either in the this material.
  58322. *
  58323. * If sets to null, the scene one is in use.
  58324. */
  58325. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  58326. /**
  58327. * Gets wether the color curves effect is enabled.
  58328. */
  58329. get cameraColorCurvesEnabled(): boolean;
  58330. /**
  58331. * Sets wether the color curves effect is enabled.
  58332. */
  58333. set cameraColorCurvesEnabled(value: boolean);
  58334. /**
  58335. * Gets wether the color grading effect is enabled.
  58336. */
  58337. get cameraColorGradingEnabled(): boolean;
  58338. /**
  58339. * Gets wether the color grading effect is enabled.
  58340. */
  58341. set cameraColorGradingEnabled(value: boolean);
  58342. /**
  58343. * Gets wether tonemapping is enabled or not.
  58344. */
  58345. get cameraToneMappingEnabled(): boolean;
  58346. /**
  58347. * Sets wether tonemapping is enabled or not
  58348. */
  58349. set cameraToneMappingEnabled(value: boolean);
  58350. /**
  58351. * The camera exposure used on this material.
  58352. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  58353. * This corresponds to a photographic exposure.
  58354. */
  58355. get cameraExposure(): float;
  58356. /**
  58357. * The camera exposure used on this material.
  58358. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  58359. * This corresponds to a photographic exposure.
  58360. */
  58361. set cameraExposure(value: float);
  58362. /**
  58363. * Gets The camera contrast used on this material.
  58364. */
  58365. get cameraContrast(): float;
  58366. /**
  58367. * Sets The camera contrast used on this material.
  58368. */
  58369. set cameraContrast(value: float);
  58370. /**
  58371. * Gets the Color Grading 2D Lookup Texture.
  58372. */
  58373. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  58374. /**
  58375. * Sets the Color Grading 2D Lookup Texture.
  58376. */
  58377. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  58378. /**
  58379. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  58380. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  58381. * 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;
  58382. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  58383. */
  58384. get cameraColorCurves(): Nullable<ColorCurves>;
  58385. /**
  58386. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  58387. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  58388. * 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;
  58389. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  58390. */
  58391. set cameraColorCurves(value: Nullable<ColorCurves>);
  58392. /**
  58393. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  58394. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  58395. */
  58396. switchToBGR: boolean;
  58397. private _renderTargets;
  58398. private _reflectionControls;
  58399. private _white;
  58400. private _primaryShadowColor;
  58401. private _primaryHighlightColor;
  58402. /**
  58403. * Instantiates a Background Material in the given scene
  58404. * @param name The friendly name of the material
  58405. * @param scene The scene to add the material to
  58406. */
  58407. constructor(name: string, scene: Scene);
  58408. /**
  58409. * Gets a boolean indicating that current material needs to register RTT
  58410. */
  58411. get hasRenderTargetTextures(): boolean;
  58412. /**
  58413. * The entire material has been created in order to prevent overdraw.
  58414. * @returns false
  58415. */
  58416. needAlphaTesting(): boolean;
  58417. /**
  58418. * The entire material has been created in order to prevent overdraw.
  58419. * @returns true if blending is enable
  58420. */
  58421. needAlphaBlending(): boolean;
  58422. /**
  58423. * Checks wether the material is ready to be rendered for a given mesh.
  58424. * @param mesh The mesh to render
  58425. * @param subMesh The submesh to check against
  58426. * @param useInstances Specify wether or not the material is used with instances
  58427. * @returns true if all the dependencies are ready (Textures, Effects...)
  58428. */
  58429. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  58430. /**
  58431. * Compute the primary color according to the chosen perceptual color.
  58432. */
  58433. private _computePrimaryColorFromPerceptualColor;
  58434. /**
  58435. * Compute the highlights and shadow colors according to their chosen levels.
  58436. */
  58437. private _computePrimaryColors;
  58438. /**
  58439. * Build the uniform buffer used in the material.
  58440. */
  58441. buildUniformLayout(): void;
  58442. /**
  58443. * Unbind the material.
  58444. */
  58445. unbind(): void;
  58446. /**
  58447. * Bind only the world matrix to the material.
  58448. * @param world The world matrix to bind.
  58449. */
  58450. bindOnlyWorldMatrix(world: Matrix): void;
  58451. /**
  58452. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  58453. * @param world The world matrix to bind.
  58454. * @param subMesh The submesh to bind for.
  58455. */
  58456. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  58457. /**
  58458. * Checks to see if a texture is used in the material.
  58459. * @param texture - Base texture to use.
  58460. * @returns - Boolean specifying if a texture is used in the material.
  58461. */
  58462. hasTexture(texture: BaseTexture): boolean;
  58463. /**
  58464. * Dispose the material.
  58465. * @param forceDisposeEffect Force disposal of the associated effect.
  58466. * @param forceDisposeTextures Force disposal of the associated textures.
  58467. */
  58468. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  58469. /**
  58470. * Clones the material.
  58471. * @param name The cloned name.
  58472. * @returns The cloned material.
  58473. */
  58474. clone(name: string): BackgroundMaterial;
  58475. /**
  58476. * Serializes the current material to its JSON representation.
  58477. * @returns The JSON representation.
  58478. */
  58479. serialize(): any;
  58480. /**
  58481. * Gets the class name of the material
  58482. * @returns "BackgroundMaterial"
  58483. */
  58484. getClassName(): string;
  58485. /**
  58486. * Parse a JSON input to create back a background material.
  58487. * @param source The JSON data to parse
  58488. * @param scene The scene to create the parsed material in
  58489. * @param rootUrl The root url of the assets the material depends upon
  58490. * @returns the instantiated BackgroundMaterial.
  58491. */
  58492. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  58493. }
  58494. }
  58495. declare module BABYLON {
  58496. /**
  58497. * Represents the different options available during the creation of
  58498. * a Environment helper.
  58499. *
  58500. * This can control the default ground, skybox and image processing setup of your scene.
  58501. */
  58502. export interface IEnvironmentHelperOptions {
  58503. /**
  58504. * Specifies whether or not to create a ground.
  58505. * True by default.
  58506. */
  58507. createGround: boolean;
  58508. /**
  58509. * Specifies the ground size.
  58510. * 15 by default.
  58511. */
  58512. groundSize: number;
  58513. /**
  58514. * The texture used on the ground for the main color.
  58515. * Comes from the BabylonJS CDN by default.
  58516. *
  58517. * Remarks: Can be either a texture or a url.
  58518. */
  58519. groundTexture: string | BaseTexture;
  58520. /**
  58521. * The color mixed in the ground texture by default.
  58522. * BabylonJS clearColor by default.
  58523. */
  58524. groundColor: Color3;
  58525. /**
  58526. * Specifies the ground opacity.
  58527. * 1 by default.
  58528. */
  58529. groundOpacity: number;
  58530. /**
  58531. * Enables the ground to receive shadows.
  58532. * True by default.
  58533. */
  58534. enableGroundShadow: boolean;
  58535. /**
  58536. * Helps preventing the shadow to be fully black on the ground.
  58537. * 0.5 by default.
  58538. */
  58539. groundShadowLevel: number;
  58540. /**
  58541. * Creates a mirror texture attach to the ground.
  58542. * false by default.
  58543. */
  58544. enableGroundMirror: boolean;
  58545. /**
  58546. * Specifies the ground mirror size ratio.
  58547. * 0.3 by default as the default kernel is 64.
  58548. */
  58549. groundMirrorSizeRatio: number;
  58550. /**
  58551. * Specifies the ground mirror blur kernel size.
  58552. * 64 by default.
  58553. */
  58554. groundMirrorBlurKernel: number;
  58555. /**
  58556. * Specifies the ground mirror visibility amount.
  58557. * 1 by default
  58558. */
  58559. groundMirrorAmount: number;
  58560. /**
  58561. * Specifies the ground mirror reflectance weight.
  58562. * This uses the standard weight of the background material to setup the fresnel effect
  58563. * of the mirror.
  58564. * 1 by default.
  58565. */
  58566. groundMirrorFresnelWeight: number;
  58567. /**
  58568. * Specifies the ground mirror Falloff distance.
  58569. * This can helps reducing the size of the reflection.
  58570. * 0 by Default.
  58571. */
  58572. groundMirrorFallOffDistance: number;
  58573. /**
  58574. * Specifies the ground mirror texture type.
  58575. * Unsigned Int by Default.
  58576. */
  58577. groundMirrorTextureType: number;
  58578. /**
  58579. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  58580. * the shown objects.
  58581. */
  58582. groundYBias: number;
  58583. /**
  58584. * Specifies whether or not to create a skybox.
  58585. * True by default.
  58586. */
  58587. createSkybox: boolean;
  58588. /**
  58589. * Specifies the skybox size.
  58590. * 20 by default.
  58591. */
  58592. skyboxSize: number;
  58593. /**
  58594. * The texture used on the skybox for the main color.
  58595. * Comes from the BabylonJS CDN by default.
  58596. *
  58597. * Remarks: Can be either a texture or a url.
  58598. */
  58599. skyboxTexture: string | BaseTexture;
  58600. /**
  58601. * The color mixed in the skybox texture by default.
  58602. * BabylonJS clearColor by default.
  58603. */
  58604. skyboxColor: Color3;
  58605. /**
  58606. * The background rotation around the Y axis of the scene.
  58607. * This helps aligning the key lights of your scene with the background.
  58608. * 0 by default.
  58609. */
  58610. backgroundYRotation: number;
  58611. /**
  58612. * Compute automatically the size of the elements to best fit with the scene.
  58613. */
  58614. sizeAuto: boolean;
  58615. /**
  58616. * Default position of the rootMesh if autoSize is not true.
  58617. */
  58618. rootPosition: Vector3;
  58619. /**
  58620. * Sets up the image processing in the scene.
  58621. * true by default.
  58622. */
  58623. setupImageProcessing: boolean;
  58624. /**
  58625. * The texture used as your environment texture in the scene.
  58626. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  58627. *
  58628. * Remarks: Can be either a texture or a url.
  58629. */
  58630. environmentTexture: string | BaseTexture;
  58631. /**
  58632. * The value of the exposure to apply to the scene.
  58633. * 0.6 by default if setupImageProcessing is true.
  58634. */
  58635. cameraExposure: number;
  58636. /**
  58637. * The value of the contrast to apply to the scene.
  58638. * 1.6 by default if setupImageProcessing is true.
  58639. */
  58640. cameraContrast: number;
  58641. /**
  58642. * Specifies whether or not tonemapping should be enabled in the scene.
  58643. * true by default if setupImageProcessing is true.
  58644. */
  58645. toneMappingEnabled: boolean;
  58646. }
  58647. /**
  58648. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  58649. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  58650. * It also helps with the default setup of your imageProcessing configuration.
  58651. */
  58652. export class EnvironmentHelper {
  58653. /**
  58654. * Default ground texture URL.
  58655. */
  58656. private static _groundTextureCDNUrl;
  58657. /**
  58658. * Default skybox texture URL.
  58659. */
  58660. private static _skyboxTextureCDNUrl;
  58661. /**
  58662. * Default environment texture URL.
  58663. */
  58664. private static _environmentTextureCDNUrl;
  58665. /**
  58666. * Creates the default options for the helper.
  58667. */
  58668. private static _getDefaultOptions;
  58669. private _rootMesh;
  58670. /**
  58671. * Gets the root mesh created by the helper.
  58672. */
  58673. get rootMesh(): Mesh;
  58674. private _skybox;
  58675. /**
  58676. * Gets the skybox created by the helper.
  58677. */
  58678. get skybox(): Nullable<Mesh>;
  58679. private _skyboxTexture;
  58680. /**
  58681. * Gets the skybox texture created by the helper.
  58682. */
  58683. get skyboxTexture(): Nullable<BaseTexture>;
  58684. private _skyboxMaterial;
  58685. /**
  58686. * Gets the skybox material created by the helper.
  58687. */
  58688. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  58689. private _ground;
  58690. /**
  58691. * Gets the ground mesh created by the helper.
  58692. */
  58693. get ground(): Nullable<Mesh>;
  58694. private _groundTexture;
  58695. /**
  58696. * Gets the ground texture created by the helper.
  58697. */
  58698. get groundTexture(): Nullable<BaseTexture>;
  58699. private _groundMirror;
  58700. /**
  58701. * Gets the ground mirror created by the helper.
  58702. */
  58703. get groundMirror(): Nullable<MirrorTexture>;
  58704. /**
  58705. * Gets the ground mirror render list to helps pushing the meshes
  58706. * you wish in the ground reflection.
  58707. */
  58708. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  58709. private _groundMaterial;
  58710. /**
  58711. * Gets the ground material created by the helper.
  58712. */
  58713. get groundMaterial(): Nullable<BackgroundMaterial>;
  58714. /**
  58715. * Stores the creation options.
  58716. */
  58717. private readonly _scene;
  58718. private _options;
  58719. /**
  58720. * This observable will be notified with any error during the creation of the environment,
  58721. * mainly texture creation errors.
  58722. */
  58723. onErrorObservable: Observable<{
  58724. message?: string;
  58725. exception?: any;
  58726. }>;
  58727. /**
  58728. * constructor
  58729. * @param options Defines the options we want to customize the helper
  58730. * @param scene The scene to add the material to
  58731. */
  58732. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  58733. /**
  58734. * Updates the background according to the new options
  58735. * @param options
  58736. */
  58737. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  58738. /**
  58739. * Sets the primary color of all the available elements.
  58740. * @param color the main color to affect to the ground and the background
  58741. */
  58742. setMainColor(color: Color3): void;
  58743. /**
  58744. * Setup the image processing according to the specified options.
  58745. */
  58746. private _setupImageProcessing;
  58747. /**
  58748. * Setup the environment texture according to the specified options.
  58749. */
  58750. private _setupEnvironmentTexture;
  58751. /**
  58752. * Setup the background according to the specified options.
  58753. */
  58754. private _setupBackground;
  58755. /**
  58756. * Get the scene sizes according to the setup.
  58757. */
  58758. private _getSceneSize;
  58759. /**
  58760. * Setup the ground according to the specified options.
  58761. */
  58762. private _setupGround;
  58763. /**
  58764. * Setup the ground material according to the specified options.
  58765. */
  58766. private _setupGroundMaterial;
  58767. /**
  58768. * Setup the ground diffuse texture according to the specified options.
  58769. */
  58770. private _setupGroundDiffuseTexture;
  58771. /**
  58772. * Setup the ground mirror texture according to the specified options.
  58773. */
  58774. private _setupGroundMirrorTexture;
  58775. /**
  58776. * Setup the ground to receive the mirror texture.
  58777. */
  58778. private _setupMirrorInGroundMaterial;
  58779. /**
  58780. * Setup the skybox according to the specified options.
  58781. */
  58782. private _setupSkybox;
  58783. /**
  58784. * Setup the skybox material according to the specified options.
  58785. */
  58786. private _setupSkyboxMaterial;
  58787. /**
  58788. * Setup the skybox reflection texture according to the specified options.
  58789. */
  58790. private _setupSkyboxReflectionTexture;
  58791. private _errorHandler;
  58792. /**
  58793. * Dispose all the elements created by the Helper.
  58794. */
  58795. dispose(): void;
  58796. }
  58797. }
  58798. declare module BABYLON {
  58799. /**
  58800. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  58801. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  58802. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  58803. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  58804. */
  58805. export abstract class TextureDome<T extends Texture> extends TransformNode {
  58806. protected onError: Nullable<(message?: string, exception?: any) => void>;
  58807. /**
  58808. * Define the source as a Monoscopic panoramic 360/180.
  58809. */
  58810. static readonly MODE_MONOSCOPIC: number;
  58811. /**
  58812. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  58813. */
  58814. static readonly MODE_TOPBOTTOM: number;
  58815. /**
  58816. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  58817. */
  58818. static readonly MODE_SIDEBYSIDE: number;
  58819. private _halfDome;
  58820. private _crossEye;
  58821. protected _useDirectMapping: boolean;
  58822. /**
  58823. * The texture being displayed on the sphere
  58824. */
  58825. protected _texture: T;
  58826. /**
  58827. * Gets the texture being displayed on the sphere
  58828. */
  58829. get texture(): T;
  58830. /**
  58831. * Sets the texture being displayed on the sphere
  58832. */
  58833. set texture(newTexture: T);
  58834. /**
  58835. * The skybox material
  58836. */
  58837. protected _material: BackgroundMaterial;
  58838. /**
  58839. * The surface used for the dome
  58840. */
  58841. protected _mesh: Mesh;
  58842. /**
  58843. * Gets the mesh used for the dome.
  58844. */
  58845. get mesh(): Mesh;
  58846. /**
  58847. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  58848. */
  58849. private _halfDomeMask;
  58850. /**
  58851. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  58852. * Also see the options.resolution property.
  58853. */
  58854. get fovMultiplier(): number;
  58855. set fovMultiplier(value: number);
  58856. protected _textureMode: number;
  58857. /**
  58858. * Gets or set the current texture mode for the texture. It can be:
  58859. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  58860. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  58861. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  58862. */
  58863. get textureMode(): number;
  58864. /**
  58865. * Sets the current texture mode for the texture. It can be:
  58866. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  58867. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  58868. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  58869. */
  58870. set textureMode(value: number);
  58871. /**
  58872. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  58873. */
  58874. get halfDome(): boolean;
  58875. /**
  58876. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  58877. */
  58878. set halfDome(enabled: boolean);
  58879. /**
  58880. * Set the cross-eye mode. If set, images that can be seen when crossing eyes will render correctly
  58881. */
  58882. set crossEye(enabled: boolean);
  58883. /**
  58884. * Is it a cross-eye texture?
  58885. */
  58886. get crossEye(): boolean;
  58887. /**
  58888. * The background material of this dome.
  58889. */
  58890. get material(): BackgroundMaterial;
  58891. /**
  58892. * Oberserver used in Stereoscopic VR Mode.
  58893. */
  58894. private _onBeforeCameraRenderObserver;
  58895. /**
  58896. * Observable raised when an error occured while loading the 360 image
  58897. */
  58898. onLoadErrorObservable: Observable<string>;
  58899. /**
  58900. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  58901. * @param name Element's name, child elements will append suffixes for their own names.
  58902. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  58903. * @param options An object containing optional or exposed sub element properties
  58904. */
  58905. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  58906. resolution?: number;
  58907. clickToPlay?: boolean;
  58908. autoPlay?: boolean;
  58909. loop?: boolean;
  58910. size?: number;
  58911. poster?: string;
  58912. faceForward?: boolean;
  58913. useDirectMapping?: boolean;
  58914. halfDomeMode?: boolean;
  58915. crossEyeMode?: boolean;
  58916. generateMipMaps?: boolean;
  58917. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  58918. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  58919. protected _changeTextureMode(value: number): void;
  58920. /**
  58921. * Releases resources associated with this node.
  58922. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  58923. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  58924. */
  58925. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  58926. }
  58927. }
  58928. declare module BABYLON {
  58929. /**
  58930. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  58931. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  58932. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  58933. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  58934. */
  58935. export class PhotoDome extends TextureDome<Texture> {
  58936. /**
  58937. * Define the image as a Monoscopic panoramic 360 image.
  58938. */
  58939. static readonly MODE_MONOSCOPIC: number;
  58940. /**
  58941. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  58942. */
  58943. static readonly MODE_TOPBOTTOM: number;
  58944. /**
  58945. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  58946. */
  58947. static readonly MODE_SIDEBYSIDE: number;
  58948. /**
  58949. * Gets or sets the texture being displayed on the sphere
  58950. */
  58951. get photoTexture(): Texture;
  58952. /**
  58953. * sets the texture being displayed on the sphere
  58954. */
  58955. set photoTexture(value: Texture);
  58956. /**
  58957. * Gets the current video mode for the video. It can be:
  58958. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  58959. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  58960. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  58961. */
  58962. get imageMode(): number;
  58963. /**
  58964. * Sets the current video mode for the video. It can be:
  58965. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  58966. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  58967. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  58968. */
  58969. set imageMode(value: number);
  58970. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  58971. }
  58972. }
  58973. declare module BABYLON {
  58974. /**
  58975. * Direct draw surface info
  58976. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  58977. */
  58978. export interface DDSInfo {
  58979. /**
  58980. * Width of the texture
  58981. */
  58982. width: number;
  58983. /**
  58984. * Width of the texture
  58985. */
  58986. height: number;
  58987. /**
  58988. * Number of Mipmaps for the texture
  58989. * @see https://en.wikipedia.org/wiki/Mipmap
  58990. */
  58991. mipmapCount: number;
  58992. /**
  58993. * If the textures format is a known fourCC format
  58994. * @see https://www.fourcc.org/
  58995. */
  58996. isFourCC: boolean;
  58997. /**
  58998. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  58999. */
  59000. isRGB: boolean;
  59001. /**
  59002. * If the texture is a lumincance format
  59003. */
  59004. isLuminance: boolean;
  59005. /**
  59006. * If this is a cube texture
  59007. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  59008. */
  59009. isCube: boolean;
  59010. /**
  59011. * If the texture is a compressed format eg. FOURCC_DXT1
  59012. */
  59013. isCompressed: boolean;
  59014. /**
  59015. * The dxgiFormat of the texture
  59016. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  59017. */
  59018. dxgiFormat: number;
  59019. /**
  59020. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  59021. */
  59022. textureType: number;
  59023. /**
  59024. * Sphericle polynomial created for the dds texture
  59025. */
  59026. sphericalPolynomial?: SphericalPolynomial;
  59027. }
  59028. /**
  59029. * Class used to provide DDS decompression tools
  59030. */
  59031. export class DDSTools {
  59032. /**
  59033. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  59034. */
  59035. static StoreLODInAlphaChannel: boolean;
  59036. /**
  59037. * Gets DDS information from an array buffer
  59038. * @param data defines the array buffer view to read data from
  59039. * @returns the DDS information
  59040. */
  59041. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  59042. private static _FloatView;
  59043. private static _Int32View;
  59044. private static _ToHalfFloat;
  59045. private static _FromHalfFloat;
  59046. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  59047. private static _GetHalfFloatRGBAArrayBuffer;
  59048. private static _GetFloatRGBAArrayBuffer;
  59049. private static _GetFloatAsUIntRGBAArrayBuffer;
  59050. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  59051. private static _GetRGBAArrayBuffer;
  59052. private static _ExtractLongWordOrder;
  59053. private static _GetRGBArrayBuffer;
  59054. private static _GetLuminanceArrayBuffer;
  59055. /**
  59056. * Uploads DDS Levels to a Babylon Texture
  59057. * @hidden
  59058. */
  59059. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  59060. }
  59061. interface ThinEngine {
  59062. /**
  59063. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  59064. * @param rootUrl defines the url where the file to load is located
  59065. * @param scene defines the current scene
  59066. * @param lodScale defines scale to apply to the mip map selection
  59067. * @param lodOffset defines offset to apply to the mip map selection
  59068. * @param onLoad defines an optional callback raised when the texture is loaded
  59069. * @param onError defines an optional callback raised if there is an issue to load the texture
  59070. * @param format defines the format of the data
  59071. * @param forcedExtension defines the extension to use to pick the right loader
  59072. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  59073. * @returns the cube texture as an InternalTexture
  59074. */
  59075. 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;
  59076. }
  59077. }
  59078. declare module BABYLON {
  59079. /**
  59080. * Implementation of the DDS Texture Loader.
  59081. * @hidden
  59082. */
  59083. export class _DDSTextureLoader implements IInternalTextureLoader {
  59084. /**
  59085. * Defines wether the loader supports cascade loading the different faces.
  59086. */
  59087. readonly supportCascades: boolean;
  59088. /**
  59089. * This returns if the loader support the current file information.
  59090. * @param extension defines the file extension of the file being loaded
  59091. * @returns true if the loader can load the specified file
  59092. */
  59093. canLoad(extension: string): boolean;
  59094. /**
  59095. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  59096. * @param data contains the texture data
  59097. * @param texture defines the BabylonJS internal texture
  59098. * @param createPolynomials will be true if polynomials have been requested
  59099. * @param onLoad defines the callback to trigger once the texture is ready
  59100. * @param onError defines the callback to trigger in case of error
  59101. */
  59102. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  59103. /**
  59104. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  59105. * @param data contains the texture data
  59106. * @param texture defines the BabylonJS internal texture
  59107. * @param callback defines the method to call once ready to upload
  59108. */
  59109. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  59110. }
  59111. }
  59112. declare module BABYLON {
  59113. /**
  59114. * Implementation of the ENV Texture Loader.
  59115. * @hidden
  59116. */
  59117. export class _ENVTextureLoader implements IInternalTextureLoader {
  59118. /**
  59119. * Defines wether the loader supports cascade loading the different faces.
  59120. */
  59121. readonly supportCascades: boolean;
  59122. /**
  59123. * This returns if the loader support the current file information.
  59124. * @param extension defines the file extension of the file being loaded
  59125. * @returns true if the loader can load the specified file
  59126. */
  59127. canLoad(extension: string): boolean;
  59128. /**
  59129. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  59130. * @param data contains the texture data
  59131. * @param texture defines the BabylonJS internal texture
  59132. * @param createPolynomials will be true if polynomials have been requested
  59133. * @param onLoad defines the callback to trigger once the texture is ready
  59134. * @param onError defines the callback to trigger in case of error
  59135. */
  59136. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  59137. /**
  59138. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  59139. * @param data contains the texture data
  59140. * @param texture defines the BabylonJS internal texture
  59141. * @param callback defines the method to call once ready to upload
  59142. */
  59143. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  59144. }
  59145. }
  59146. declare module BABYLON {
  59147. /**
  59148. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  59149. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  59150. */
  59151. export class KhronosTextureContainer {
  59152. /** contents of the KTX container file */
  59153. data: ArrayBufferView;
  59154. private static HEADER_LEN;
  59155. private static COMPRESSED_2D;
  59156. private static COMPRESSED_3D;
  59157. private static TEX_2D;
  59158. private static TEX_3D;
  59159. /**
  59160. * Gets the openGL type
  59161. */
  59162. glType: number;
  59163. /**
  59164. * Gets the openGL type size
  59165. */
  59166. glTypeSize: number;
  59167. /**
  59168. * Gets the openGL format
  59169. */
  59170. glFormat: number;
  59171. /**
  59172. * Gets the openGL internal format
  59173. */
  59174. glInternalFormat: number;
  59175. /**
  59176. * Gets the base internal format
  59177. */
  59178. glBaseInternalFormat: number;
  59179. /**
  59180. * Gets image width in pixel
  59181. */
  59182. pixelWidth: number;
  59183. /**
  59184. * Gets image height in pixel
  59185. */
  59186. pixelHeight: number;
  59187. /**
  59188. * Gets image depth in pixels
  59189. */
  59190. pixelDepth: number;
  59191. /**
  59192. * Gets the number of array elements
  59193. */
  59194. numberOfArrayElements: number;
  59195. /**
  59196. * Gets the number of faces
  59197. */
  59198. numberOfFaces: number;
  59199. /**
  59200. * Gets the number of mipmap levels
  59201. */
  59202. numberOfMipmapLevels: number;
  59203. /**
  59204. * Gets the bytes of key value data
  59205. */
  59206. bytesOfKeyValueData: number;
  59207. /**
  59208. * Gets the load type
  59209. */
  59210. loadType: number;
  59211. /**
  59212. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  59213. */
  59214. isInvalid: boolean;
  59215. /**
  59216. * Creates a new KhronosTextureContainer
  59217. * @param data contents of the KTX container file
  59218. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  59219. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  59220. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  59221. */
  59222. constructor(
  59223. /** contents of the KTX container file */
  59224. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  59225. /**
  59226. * Uploads KTX content to a Babylon Texture.
  59227. * It is assumed that the texture has already been created & is currently bound
  59228. * @hidden
  59229. */
  59230. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  59231. private _upload2DCompressedLevels;
  59232. /**
  59233. * Checks if the given data starts with a KTX file identifier.
  59234. * @param data the data to check
  59235. * @returns true if the data is a KTX file or false otherwise
  59236. */
  59237. static IsValid(data: ArrayBufferView): boolean;
  59238. }
  59239. }
  59240. declare module BABYLON {
  59241. /**
  59242. * Helper class to push actions to a pool of workers.
  59243. */
  59244. export class WorkerPool implements IDisposable {
  59245. private _workerInfos;
  59246. private _pendingActions;
  59247. /**
  59248. * Constructor
  59249. * @param workers Array of workers to use for actions
  59250. */
  59251. constructor(workers: Array<Worker>);
  59252. /**
  59253. * Terminates all workers and clears any pending actions.
  59254. */
  59255. dispose(): void;
  59256. /**
  59257. * Pushes an action to the worker pool. If all the workers are active, the action will be
  59258. * pended until a worker has completed its action.
  59259. * @param action The action to perform. Call onComplete when the action is complete.
  59260. */
  59261. push(action: (worker: Worker, onComplete: () => void) => void): void;
  59262. private _execute;
  59263. }
  59264. }
  59265. declare module BABYLON {
  59266. /**
  59267. * Class for loading KTX2 files
  59268. */
  59269. export class KhronosTextureContainer2 {
  59270. private static _WorkerPoolPromise?;
  59271. private static _Initialized;
  59272. private static _Ktx2Decoder;
  59273. /**
  59274. * URLs to use when loading the KTX2 decoder module as well as its dependencies
  59275. * If a url is null, the default url is used (pointing to https://preview.babylonjs.com)
  59276. * Note that jsDecoderModule can't be null and that the other dependencies will only be loaded if necessary
  59277. * Urls you can change:
  59278. * URLConfig.jsDecoderModule
  59279. * URLConfig.wasmUASTCToASTC
  59280. * URLConfig.wasmUASTCToBC7
  59281. * URLConfig.wasmUASTCToRGBA_UNORM
  59282. * URLConfig.wasmUASTCToRGBA_SRGB
  59283. * URLConfig.jsMSCTranscoder
  59284. * URLConfig.wasmMSCTranscoder
  59285. * You can see their default values in this PG: https://playground.babylonjs.com/#EIJH8L#9
  59286. */
  59287. static URLConfig: {
  59288. jsDecoderModule: string;
  59289. wasmUASTCToASTC: null;
  59290. wasmUASTCToBC7: null;
  59291. wasmUASTCToRGBA_UNORM: null;
  59292. wasmUASTCToRGBA_SRGB: null;
  59293. jsMSCTranscoder: null;
  59294. wasmMSCTranscoder: null;
  59295. };
  59296. /**
  59297. * Default number of workers used to handle data decoding
  59298. */
  59299. static DefaultNumWorkers: number;
  59300. private static GetDefaultNumWorkers;
  59301. private _engine;
  59302. private static _CreateWorkerPool;
  59303. /**
  59304. * Constructor
  59305. * @param engine The engine to use
  59306. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  59307. */
  59308. constructor(engine: ThinEngine, numWorkers?: number);
  59309. /** @hidden */
  59310. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture, options?: any): Promise<void>;
  59311. /**
  59312. * Stop all async operations and release resources.
  59313. */
  59314. dispose(): void;
  59315. protected _createTexture(data: any, internalTexture: InternalTexture, options?: any): void;
  59316. /**
  59317. * Checks if the given data starts with a KTX2 file identifier.
  59318. * @param data the data to check
  59319. * @returns true if the data is a KTX2 file or false otherwise
  59320. */
  59321. static IsValid(data: ArrayBufferView): boolean;
  59322. }
  59323. }
  59324. declare module BABYLON {
  59325. /**
  59326. * Implementation of the KTX Texture Loader.
  59327. * @hidden
  59328. */
  59329. export class _KTXTextureLoader implements IInternalTextureLoader {
  59330. /**
  59331. * Defines wether the loader supports cascade loading the different faces.
  59332. */
  59333. readonly supportCascades: boolean;
  59334. /**
  59335. * This returns if the loader support the current file information.
  59336. * @param extension defines the file extension of the file being loaded
  59337. * @param mimeType defines the optional mime type of the file being loaded
  59338. * @returns true if the loader can load the specified file
  59339. */
  59340. canLoad(extension: string, mimeType?: string): boolean;
  59341. /**
  59342. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  59343. * @param data contains the texture data
  59344. * @param texture defines the BabylonJS internal texture
  59345. * @param createPolynomials will be true if polynomials have been requested
  59346. * @param onLoad defines the callback to trigger once the texture is ready
  59347. * @param onError defines the callback to trigger in case of error
  59348. */
  59349. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  59350. /**
  59351. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  59352. * @param data contains the texture data
  59353. * @param texture defines the BabylonJS internal texture
  59354. * @param callback defines the method to call once ready to upload
  59355. */
  59356. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void, options?: any): void;
  59357. }
  59358. }
  59359. declare module BABYLON {
  59360. /** @hidden */
  59361. export var _forceSceneHelpersToBundle: boolean;
  59362. interface Scene {
  59363. /**
  59364. * Creates a default light for the scene.
  59365. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  59366. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  59367. */
  59368. createDefaultLight(replace?: boolean): void;
  59369. /**
  59370. * Creates a default camera for the scene.
  59371. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  59372. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  59373. * @param replace has default false, when true replaces the active camera in the scene
  59374. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  59375. */
  59376. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  59377. /**
  59378. * Creates a default camera and a default light.
  59379. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  59380. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  59381. * @param replace has the default false, when true replaces the active camera/light in the scene
  59382. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  59383. */
  59384. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  59385. /**
  59386. * Creates a new sky box
  59387. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  59388. * @param environmentTexture defines the texture to use as environment texture
  59389. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  59390. * @param scale defines the overall scale of the skybox
  59391. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  59392. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  59393. * @returns a new mesh holding the sky box
  59394. */
  59395. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  59396. /**
  59397. * Creates a new environment
  59398. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  59399. * @param options defines the options you can use to configure the environment
  59400. * @returns the new EnvironmentHelper
  59401. */
  59402. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  59403. /**
  59404. * Creates a new VREXperienceHelper
  59405. * @see https://doc.babylonjs.com/how_to/webvr_helper
  59406. * @param webVROptions defines the options used to create the new VREXperienceHelper
  59407. * @returns a new VREXperienceHelper
  59408. */
  59409. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  59410. /**
  59411. * Creates a new WebXRDefaultExperience
  59412. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  59413. * @param options experience options
  59414. * @returns a promise for a new WebXRDefaultExperience
  59415. */
  59416. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  59417. }
  59418. }
  59419. declare module BABYLON {
  59420. /**
  59421. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  59422. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  59423. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  59424. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  59425. */
  59426. export class VideoDome extends TextureDome<VideoTexture> {
  59427. /**
  59428. * Define the video source as a Monoscopic panoramic 360 video.
  59429. */
  59430. static readonly MODE_MONOSCOPIC: number;
  59431. /**
  59432. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  59433. */
  59434. static readonly MODE_TOPBOTTOM: number;
  59435. /**
  59436. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  59437. */
  59438. static readonly MODE_SIDEBYSIDE: number;
  59439. /**
  59440. * Get the video texture associated with this video dome
  59441. */
  59442. get videoTexture(): VideoTexture;
  59443. /**
  59444. * Get the video mode of this dome
  59445. */
  59446. get videoMode(): number;
  59447. /**
  59448. * Set the video mode of this dome.
  59449. * @see textureMode
  59450. */
  59451. set videoMode(value: number);
  59452. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  59453. }
  59454. }
  59455. declare module BABYLON {
  59456. /**
  59457. * This class can be used to get instrumentation data from a Babylon engine
  59458. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  59459. */
  59460. export class EngineInstrumentation implements IDisposable {
  59461. /**
  59462. * Define the instrumented engine.
  59463. */
  59464. engine: Engine;
  59465. private _captureGPUFrameTime;
  59466. private _gpuFrameTimeToken;
  59467. private _gpuFrameTime;
  59468. private _captureShaderCompilationTime;
  59469. private _shaderCompilationTime;
  59470. private _onBeginFrameObserver;
  59471. private _onEndFrameObserver;
  59472. private _onBeforeShaderCompilationObserver;
  59473. private _onAfterShaderCompilationObserver;
  59474. /**
  59475. * Gets the perf counter used for GPU frame time
  59476. */
  59477. get gpuFrameTimeCounter(): PerfCounter;
  59478. /**
  59479. * Gets the GPU frame time capture status
  59480. */
  59481. get captureGPUFrameTime(): boolean;
  59482. /**
  59483. * Enable or disable the GPU frame time capture
  59484. */
  59485. set captureGPUFrameTime(value: boolean);
  59486. /**
  59487. * Gets the perf counter used for shader compilation time
  59488. */
  59489. get shaderCompilationTimeCounter(): PerfCounter;
  59490. /**
  59491. * Gets the shader compilation time capture status
  59492. */
  59493. get captureShaderCompilationTime(): boolean;
  59494. /**
  59495. * Enable or disable the shader compilation time capture
  59496. */
  59497. set captureShaderCompilationTime(value: boolean);
  59498. /**
  59499. * Instantiates a new engine instrumentation.
  59500. * This class can be used to get instrumentation data from a Babylon engine
  59501. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  59502. * @param engine Defines the engine to instrument
  59503. */
  59504. constructor(
  59505. /**
  59506. * Define the instrumented engine.
  59507. */
  59508. engine: Engine);
  59509. /**
  59510. * Dispose and release associated resources.
  59511. */
  59512. dispose(): void;
  59513. }
  59514. }
  59515. declare module BABYLON {
  59516. /**
  59517. * This class can be used to get instrumentation data from a Babylon engine
  59518. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  59519. */
  59520. export class SceneInstrumentation implements IDisposable {
  59521. /**
  59522. * Defines the scene to instrument
  59523. */
  59524. scene: Scene;
  59525. private _captureActiveMeshesEvaluationTime;
  59526. private _activeMeshesEvaluationTime;
  59527. private _captureRenderTargetsRenderTime;
  59528. private _renderTargetsRenderTime;
  59529. private _captureFrameTime;
  59530. private _frameTime;
  59531. private _captureRenderTime;
  59532. private _renderTime;
  59533. private _captureInterFrameTime;
  59534. private _interFrameTime;
  59535. private _captureParticlesRenderTime;
  59536. private _particlesRenderTime;
  59537. private _captureSpritesRenderTime;
  59538. private _spritesRenderTime;
  59539. private _capturePhysicsTime;
  59540. private _physicsTime;
  59541. private _captureAnimationsTime;
  59542. private _animationsTime;
  59543. private _captureCameraRenderTime;
  59544. private _cameraRenderTime;
  59545. private _onBeforeActiveMeshesEvaluationObserver;
  59546. private _onAfterActiveMeshesEvaluationObserver;
  59547. private _onBeforeRenderTargetsRenderObserver;
  59548. private _onAfterRenderTargetsRenderObserver;
  59549. private _onAfterRenderObserver;
  59550. private _onBeforeDrawPhaseObserver;
  59551. private _onAfterDrawPhaseObserver;
  59552. private _onBeforeAnimationsObserver;
  59553. private _onBeforeParticlesRenderingObserver;
  59554. private _onAfterParticlesRenderingObserver;
  59555. private _onBeforeSpritesRenderingObserver;
  59556. private _onAfterSpritesRenderingObserver;
  59557. private _onBeforePhysicsObserver;
  59558. private _onAfterPhysicsObserver;
  59559. private _onAfterAnimationsObserver;
  59560. private _onBeforeCameraRenderObserver;
  59561. private _onAfterCameraRenderObserver;
  59562. /**
  59563. * Gets the perf counter used for active meshes evaluation time
  59564. */
  59565. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  59566. /**
  59567. * Gets the active meshes evaluation time capture status
  59568. */
  59569. get captureActiveMeshesEvaluationTime(): boolean;
  59570. /**
  59571. * Enable or disable the active meshes evaluation time capture
  59572. */
  59573. set captureActiveMeshesEvaluationTime(value: boolean);
  59574. /**
  59575. * Gets the perf counter used for render targets render time
  59576. */
  59577. get renderTargetsRenderTimeCounter(): PerfCounter;
  59578. /**
  59579. * Gets the render targets render time capture status
  59580. */
  59581. get captureRenderTargetsRenderTime(): boolean;
  59582. /**
  59583. * Enable or disable the render targets render time capture
  59584. */
  59585. set captureRenderTargetsRenderTime(value: boolean);
  59586. /**
  59587. * Gets the perf counter used for particles render time
  59588. */
  59589. get particlesRenderTimeCounter(): PerfCounter;
  59590. /**
  59591. * Gets the particles render time capture status
  59592. */
  59593. get captureParticlesRenderTime(): boolean;
  59594. /**
  59595. * Enable or disable the particles render time capture
  59596. */
  59597. set captureParticlesRenderTime(value: boolean);
  59598. /**
  59599. * Gets the perf counter used for sprites render time
  59600. */
  59601. get spritesRenderTimeCounter(): PerfCounter;
  59602. /**
  59603. * Gets the sprites render time capture status
  59604. */
  59605. get captureSpritesRenderTime(): boolean;
  59606. /**
  59607. * Enable or disable the sprites render time capture
  59608. */
  59609. set captureSpritesRenderTime(value: boolean);
  59610. /**
  59611. * Gets the perf counter used for physics time
  59612. */
  59613. get physicsTimeCounter(): PerfCounter;
  59614. /**
  59615. * Gets the physics time capture status
  59616. */
  59617. get capturePhysicsTime(): boolean;
  59618. /**
  59619. * Enable or disable the physics time capture
  59620. */
  59621. set capturePhysicsTime(value: boolean);
  59622. /**
  59623. * Gets the perf counter used for animations time
  59624. */
  59625. get animationsTimeCounter(): PerfCounter;
  59626. /**
  59627. * Gets the animations time capture status
  59628. */
  59629. get captureAnimationsTime(): boolean;
  59630. /**
  59631. * Enable or disable the animations time capture
  59632. */
  59633. set captureAnimationsTime(value: boolean);
  59634. /**
  59635. * Gets the perf counter used for frame time capture
  59636. */
  59637. get frameTimeCounter(): PerfCounter;
  59638. /**
  59639. * Gets the frame time capture status
  59640. */
  59641. get captureFrameTime(): boolean;
  59642. /**
  59643. * Enable or disable the frame time capture
  59644. */
  59645. set captureFrameTime(value: boolean);
  59646. /**
  59647. * Gets the perf counter used for inter-frames time capture
  59648. */
  59649. get interFrameTimeCounter(): PerfCounter;
  59650. /**
  59651. * Gets the inter-frames time capture status
  59652. */
  59653. get captureInterFrameTime(): boolean;
  59654. /**
  59655. * Enable or disable the inter-frames time capture
  59656. */
  59657. set captureInterFrameTime(value: boolean);
  59658. /**
  59659. * Gets the perf counter used for render time capture
  59660. */
  59661. get renderTimeCounter(): PerfCounter;
  59662. /**
  59663. * Gets the render time capture status
  59664. */
  59665. get captureRenderTime(): boolean;
  59666. /**
  59667. * Enable or disable the render time capture
  59668. */
  59669. set captureRenderTime(value: boolean);
  59670. /**
  59671. * Gets the perf counter used for camera render time capture
  59672. */
  59673. get cameraRenderTimeCounter(): PerfCounter;
  59674. /**
  59675. * Gets the camera render time capture status
  59676. */
  59677. get captureCameraRenderTime(): boolean;
  59678. /**
  59679. * Enable or disable the camera render time capture
  59680. */
  59681. set captureCameraRenderTime(value: boolean);
  59682. /**
  59683. * Gets the perf counter used for draw calls
  59684. */
  59685. get drawCallsCounter(): PerfCounter;
  59686. /**
  59687. * Instantiates a new scene instrumentation.
  59688. * This class can be used to get instrumentation data from a Babylon engine
  59689. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  59690. * @param scene Defines the scene to instrument
  59691. */
  59692. constructor(
  59693. /**
  59694. * Defines the scene to instrument
  59695. */
  59696. scene: Scene);
  59697. /**
  59698. * Dispose and release associated resources.
  59699. */
  59700. dispose(): void;
  59701. }
  59702. }
  59703. declare module BABYLON {
  59704. /** @hidden */
  59705. export var glowMapGenerationPixelShader: {
  59706. name: string;
  59707. shader: string;
  59708. };
  59709. }
  59710. declare module BABYLON {
  59711. /** @hidden */
  59712. export var glowMapGenerationVertexShader: {
  59713. name: string;
  59714. shader: string;
  59715. };
  59716. }
  59717. declare module BABYLON {
  59718. /**
  59719. * Effect layer options. This helps customizing the behaviour
  59720. * of the effect layer.
  59721. */
  59722. export interface IEffectLayerOptions {
  59723. /**
  59724. * Multiplication factor apply to the canvas size to compute the render target size
  59725. * used to generated the objects (the smaller the faster).
  59726. */
  59727. mainTextureRatio: number;
  59728. /**
  59729. * Enforces a fixed size texture to ensure effect stability across devices.
  59730. */
  59731. mainTextureFixedSize?: number;
  59732. /**
  59733. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  59734. */
  59735. alphaBlendingMode: number;
  59736. /**
  59737. * The camera attached to the layer.
  59738. */
  59739. camera: Nullable<Camera>;
  59740. /**
  59741. * The rendering group to draw the layer in.
  59742. */
  59743. renderingGroupId: number;
  59744. }
  59745. /**
  59746. * The effect layer Helps adding post process effect blended with the main pass.
  59747. *
  59748. * This can be for instance use to generate glow or higlight effects on the scene.
  59749. *
  59750. * The effect layer class can not be used directly and is intented to inherited from to be
  59751. * customized per effects.
  59752. */
  59753. export abstract class EffectLayer {
  59754. private _vertexBuffers;
  59755. private _indexBuffer;
  59756. private _cachedDefines;
  59757. private _effectLayerMapGenerationEffect;
  59758. private _effectLayerOptions;
  59759. private _mergeEffect;
  59760. protected _scene: Scene;
  59761. protected _engine: Engine;
  59762. protected _maxSize: number;
  59763. protected _mainTextureDesiredSize: ISize;
  59764. protected _mainTexture: RenderTargetTexture;
  59765. protected _shouldRender: boolean;
  59766. protected _postProcesses: PostProcess[];
  59767. protected _textures: BaseTexture[];
  59768. protected _emissiveTextureAndColor: {
  59769. texture: Nullable<BaseTexture>;
  59770. color: Color4;
  59771. };
  59772. /**
  59773. * The name of the layer
  59774. */
  59775. name: string;
  59776. /**
  59777. * The clear color of the texture used to generate the glow map.
  59778. */
  59779. neutralColor: Color4;
  59780. /**
  59781. * Specifies whether the highlight layer is enabled or not.
  59782. */
  59783. isEnabled: boolean;
  59784. /**
  59785. * Gets the camera attached to the layer.
  59786. */
  59787. get camera(): Nullable<Camera>;
  59788. /**
  59789. * Gets the rendering group id the layer should render in.
  59790. */
  59791. get renderingGroupId(): number;
  59792. set renderingGroupId(renderingGroupId: number);
  59793. /**
  59794. * Specifies if the bounding boxes should be rendered normally or if they should undergo the effect of the layer
  59795. */
  59796. disableBoundingBoxesFromEffectLayer: boolean;
  59797. /**
  59798. * An event triggered when the effect layer has been disposed.
  59799. */
  59800. onDisposeObservable: Observable<EffectLayer>;
  59801. /**
  59802. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  59803. */
  59804. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  59805. /**
  59806. * An event triggered when the generated texture is being merged in the scene.
  59807. */
  59808. onBeforeComposeObservable: Observable<EffectLayer>;
  59809. /**
  59810. * An event triggered when the mesh is rendered into the effect render target.
  59811. */
  59812. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  59813. /**
  59814. * An event triggered after the mesh has been rendered into the effect render target.
  59815. */
  59816. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  59817. /**
  59818. * An event triggered when the generated texture has been merged in the scene.
  59819. */
  59820. onAfterComposeObservable: Observable<EffectLayer>;
  59821. /**
  59822. * An event triggered when the efffect layer changes its size.
  59823. */
  59824. onSizeChangedObservable: Observable<EffectLayer>;
  59825. /** @hidden */
  59826. static _SceneComponentInitialization: (scene: Scene) => void;
  59827. /**
  59828. * Instantiates a new effect Layer and references it in the scene.
  59829. * @param name The name of the layer
  59830. * @param scene The scene to use the layer in
  59831. */
  59832. constructor(
  59833. /** The Friendly of the effect in the scene */
  59834. name: string, scene: Scene);
  59835. /**
  59836. * Get the effect name of the layer.
  59837. * @return The effect name
  59838. */
  59839. abstract getEffectName(): string;
  59840. /**
  59841. * Checks for the readiness of the element composing the layer.
  59842. * @param subMesh the mesh to check for
  59843. * @param useInstances specify whether or not to use instances to render the mesh
  59844. * @return true if ready otherwise, false
  59845. */
  59846. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  59847. /**
  59848. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  59849. * @returns true if the effect requires stencil during the main canvas render pass.
  59850. */
  59851. abstract needStencil(): boolean;
  59852. /**
  59853. * Create the merge effect. This is the shader use to blit the information back
  59854. * to the main canvas at the end of the scene rendering.
  59855. * @returns The effect containing the shader used to merge the effect on the main canvas
  59856. */
  59857. protected abstract _createMergeEffect(): Effect;
  59858. /**
  59859. * Creates the render target textures and post processes used in the effect layer.
  59860. */
  59861. protected abstract _createTextureAndPostProcesses(): void;
  59862. /**
  59863. * Implementation specific of rendering the generating effect on the main canvas.
  59864. * @param effect The effect used to render through
  59865. */
  59866. protected abstract _internalRender(effect: Effect): void;
  59867. /**
  59868. * Sets the required values for both the emissive texture and and the main color.
  59869. */
  59870. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  59871. /**
  59872. * Free any resources and references associated to a mesh.
  59873. * Internal use
  59874. * @param mesh The mesh to free.
  59875. */
  59876. abstract _disposeMesh(mesh: Mesh): void;
  59877. /**
  59878. * Serializes this layer (Glow or Highlight for example)
  59879. * @returns a serialized layer object
  59880. */
  59881. abstract serialize?(): any;
  59882. /**
  59883. * Initializes the effect layer with the required options.
  59884. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  59885. */
  59886. protected _init(options: Partial<IEffectLayerOptions>): void;
  59887. /**
  59888. * Generates the index buffer of the full screen quad blending to the main canvas.
  59889. */
  59890. private _generateIndexBuffer;
  59891. /**
  59892. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  59893. */
  59894. private _generateVertexBuffer;
  59895. /**
  59896. * Sets the main texture desired size which is the closest power of two
  59897. * of the engine canvas size.
  59898. */
  59899. private _setMainTextureSize;
  59900. /**
  59901. * Creates the main texture for the effect layer.
  59902. */
  59903. protected _createMainTexture(): void;
  59904. /**
  59905. * Adds specific effects defines.
  59906. * @param defines The defines to add specifics to.
  59907. */
  59908. protected _addCustomEffectDefines(defines: string[]): void;
  59909. /**
  59910. * Checks for the readiness of the element composing the layer.
  59911. * @param subMesh the mesh to check for
  59912. * @param useInstances specify whether or not to use instances to render the mesh
  59913. * @param emissiveTexture the associated emissive texture used to generate the glow
  59914. * @return true if ready otherwise, false
  59915. */
  59916. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  59917. /**
  59918. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  59919. */
  59920. render(): void;
  59921. /**
  59922. * Determine if a given mesh will be used in the current effect.
  59923. * @param mesh mesh to test
  59924. * @returns true if the mesh will be used
  59925. */
  59926. hasMesh(mesh: AbstractMesh): boolean;
  59927. /**
  59928. * Returns true if the layer contains information to display, otherwise false.
  59929. * @returns true if the glow layer should be rendered
  59930. */
  59931. shouldRender(): boolean;
  59932. /**
  59933. * Returns true if the mesh should render, otherwise false.
  59934. * @param mesh The mesh to render
  59935. * @returns true if it should render otherwise false
  59936. */
  59937. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  59938. /**
  59939. * Returns true if the mesh can be rendered, otherwise false.
  59940. * @param mesh The mesh to render
  59941. * @param material The material used on the mesh
  59942. * @returns true if it can be rendered otherwise false
  59943. */
  59944. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  59945. /**
  59946. * Returns true if the mesh should render, otherwise false.
  59947. * @param mesh The mesh to render
  59948. * @returns true if it should render otherwise false
  59949. */
  59950. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  59951. /**
  59952. * Renders the submesh passed in parameter to the generation map.
  59953. */
  59954. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  59955. /**
  59956. * Defines whether the current material of the mesh should be use to render the effect.
  59957. * @param mesh defines the current mesh to render
  59958. */
  59959. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  59960. /**
  59961. * Rebuild the required buffers.
  59962. * @hidden Internal use only.
  59963. */
  59964. _rebuild(): void;
  59965. /**
  59966. * Dispose only the render target textures and post process.
  59967. */
  59968. private _disposeTextureAndPostProcesses;
  59969. /**
  59970. * Dispose the highlight layer and free resources.
  59971. */
  59972. dispose(): void;
  59973. /**
  59974. * Gets the class name of the effect layer
  59975. * @returns the string with the class name of the effect layer
  59976. */
  59977. getClassName(): string;
  59978. /**
  59979. * Creates an effect layer from parsed effect layer data
  59980. * @param parsedEffectLayer defines effect layer data
  59981. * @param scene defines the current scene
  59982. * @param rootUrl defines the root URL containing the effect layer information
  59983. * @returns a parsed effect Layer
  59984. */
  59985. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  59986. }
  59987. }
  59988. declare module BABYLON {
  59989. interface AbstractScene {
  59990. /**
  59991. * The list of effect layers (highlights/glow) added to the scene
  59992. * @see https://doc.babylonjs.com/how_to/highlight_layer
  59993. * @see https://doc.babylonjs.com/how_to/glow_layer
  59994. */
  59995. effectLayers: Array<EffectLayer>;
  59996. /**
  59997. * Removes the given effect layer from this scene.
  59998. * @param toRemove defines the effect layer to remove
  59999. * @returns the index of the removed effect layer
  60000. */
  60001. removeEffectLayer(toRemove: EffectLayer): number;
  60002. /**
  60003. * Adds the given effect layer to this scene
  60004. * @param newEffectLayer defines the effect layer to add
  60005. */
  60006. addEffectLayer(newEffectLayer: EffectLayer): void;
  60007. }
  60008. /**
  60009. * Defines the layer scene component responsible to manage any effect layers
  60010. * in a given scene.
  60011. */
  60012. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  60013. /**
  60014. * The component name helpfull to identify the component in the list of scene components.
  60015. */
  60016. readonly name: string;
  60017. /**
  60018. * The scene the component belongs to.
  60019. */
  60020. scene: Scene;
  60021. private _engine;
  60022. private _renderEffects;
  60023. private _needStencil;
  60024. private _previousStencilState;
  60025. /**
  60026. * Creates a new instance of the component for the given scene
  60027. * @param scene Defines the scene to register the component in
  60028. */
  60029. constructor(scene: Scene);
  60030. /**
  60031. * Registers the component in a given scene
  60032. */
  60033. register(): void;
  60034. /**
  60035. * Rebuilds the elements related to this component in case of
  60036. * context lost for instance.
  60037. */
  60038. rebuild(): void;
  60039. /**
  60040. * Serializes the component data to the specified json object
  60041. * @param serializationObject The object to serialize to
  60042. */
  60043. serialize(serializationObject: any): void;
  60044. /**
  60045. * Adds all the elements from the container to the scene
  60046. * @param container the container holding the elements
  60047. */
  60048. addFromContainer(container: AbstractScene): void;
  60049. /**
  60050. * Removes all the elements in the container from the scene
  60051. * @param container contains the elements to remove
  60052. * @param dispose if the removed element should be disposed (default: false)
  60053. */
  60054. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  60055. /**
  60056. * Disposes the component and the associated ressources.
  60057. */
  60058. dispose(): void;
  60059. private _isReadyForMesh;
  60060. private _renderMainTexture;
  60061. private _setStencil;
  60062. private _setStencilBack;
  60063. private _draw;
  60064. private _drawCamera;
  60065. private _drawRenderingGroup;
  60066. }
  60067. }
  60068. declare module BABYLON {
  60069. /** @hidden */
  60070. export var glowMapMergePixelShader: {
  60071. name: string;
  60072. shader: string;
  60073. };
  60074. }
  60075. declare module BABYLON {
  60076. /** @hidden */
  60077. export var glowMapMergeVertexShader: {
  60078. name: string;
  60079. shader: string;
  60080. };
  60081. }
  60082. declare module BABYLON {
  60083. interface AbstractScene {
  60084. /**
  60085. * Return a the first highlight layer of the scene with a given name.
  60086. * @param name The name of the highlight layer to look for.
  60087. * @return The highlight layer if found otherwise null.
  60088. */
  60089. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  60090. }
  60091. /**
  60092. * Glow layer options. This helps customizing the behaviour
  60093. * of the glow layer.
  60094. */
  60095. export interface IGlowLayerOptions {
  60096. /**
  60097. * Multiplication factor apply to the canvas size to compute the render target size
  60098. * used to generated the glowing objects (the smaller the faster).
  60099. */
  60100. mainTextureRatio: number;
  60101. /**
  60102. * Enforces a fixed size texture to ensure resize independant blur.
  60103. */
  60104. mainTextureFixedSize?: number;
  60105. /**
  60106. * How big is the kernel of the blur texture.
  60107. */
  60108. blurKernelSize: number;
  60109. /**
  60110. * The camera attached to the layer.
  60111. */
  60112. camera: Nullable<Camera>;
  60113. /**
  60114. * Enable MSAA by chosing the number of samples.
  60115. */
  60116. mainTextureSamples?: number;
  60117. /**
  60118. * The rendering group to draw the layer in.
  60119. */
  60120. renderingGroupId: number;
  60121. }
  60122. /**
  60123. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  60124. *
  60125. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  60126. *
  60127. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  60128. */
  60129. export class GlowLayer extends EffectLayer {
  60130. /**
  60131. * Effect Name of the layer.
  60132. */
  60133. static readonly EffectName: string;
  60134. /**
  60135. * The default blur kernel size used for the glow.
  60136. */
  60137. static DefaultBlurKernelSize: number;
  60138. /**
  60139. * The default texture size ratio used for the glow.
  60140. */
  60141. static DefaultTextureRatio: number;
  60142. /**
  60143. * Sets the kernel size of the blur.
  60144. */
  60145. set blurKernelSize(value: number);
  60146. /**
  60147. * Gets the kernel size of the blur.
  60148. */
  60149. get blurKernelSize(): number;
  60150. /**
  60151. * Sets the glow intensity.
  60152. */
  60153. set intensity(value: number);
  60154. /**
  60155. * Gets the glow intensity.
  60156. */
  60157. get intensity(): number;
  60158. private _options;
  60159. private _intensity;
  60160. private _horizontalBlurPostprocess1;
  60161. private _verticalBlurPostprocess1;
  60162. private _horizontalBlurPostprocess2;
  60163. private _verticalBlurPostprocess2;
  60164. private _blurTexture1;
  60165. private _blurTexture2;
  60166. private _postProcesses1;
  60167. private _postProcesses2;
  60168. private _includedOnlyMeshes;
  60169. private _excludedMeshes;
  60170. private _meshesUsingTheirOwnMaterials;
  60171. /**
  60172. * Callback used to let the user override the color selection on a per mesh basis
  60173. */
  60174. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  60175. /**
  60176. * Callback used to let the user override the texture selection on a per mesh basis
  60177. */
  60178. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  60179. /**
  60180. * Instantiates a new glow Layer and references it to the scene.
  60181. * @param name The name of the layer
  60182. * @param scene The scene to use the layer in
  60183. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  60184. */
  60185. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  60186. /**
  60187. * Get the effect name of the layer.
  60188. * @return The effect name
  60189. */
  60190. getEffectName(): string;
  60191. /**
  60192. * Create the merge effect. This is the shader use to blit the information back
  60193. * to the main canvas at the end of the scene rendering.
  60194. */
  60195. protected _createMergeEffect(): Effect;
  60196. /**
  60197. * Creates the render target textures and post processes used in the glow layer.
  60198. */
  60199. protected _createTextureAndPostProcesses(): void;
  60200. /**
  60201. * Checks for the readiness of the element composing the layer.
  60202. * @param subMesh the mesh to check for
  60203. * @param useInstances specify wether or not to use instances to render the mesh
  60204. * @param emissiveTexture the associated emissive texture used to generate the glow
  60205. * @return true if ready otherwise, false
  60206. */
  60207. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60208. /**
  60209. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  60210. */
  60211. needStencil(): boolean;
  60212. /**
  60213. * Returns true if the mesh can be rendered, otherwise false.
  60214. * @param mesh The mesh to render
  60215. * @param material The material used on the mesh
  60216. * @returns true if it can be rendered otherwise false
  60217. */
  60218. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  60219. /**
  60220. * Implementation specific of rendering the generating effect on the main canvas.
  60221. * @param effect The effect used to render through
  60222. */
  60223. protected _internalRender(effect: Effect): void;
  60224. /**
  60225. * Sets the required values for both the emissive texture and and the main color.
  60226. */
  60227. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60228. /**
  60229. * Returns true if the mesh should render, otherwise false.
  60230. * @param mesh The mesh to render
  60231. * @returns true if it should render otherwise false
  60232. */
  60233. protected _shouldRenderMesh(mesh: Mesh): boolean;
  60234. /**
  60235. * Adds specific effects defines.
  60236. * @param defines The defines to add specifics to.
  60237. */
  60238. protected _addCustomEffectDefines(defines: string[]): void;
  60239. /**
  60240. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  60241. * @param mesh The mesh to exclude from the glow layer
  60242. */
  60243. addExcludedMesh(mesh: Mesh): void;
  60244. /**
  60245. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  60246. * @param mesh The mesh to remove
  60247. */
  60248. removeExcludedMesh(mesh: Mesh): void;
  60249. /**
  60250. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  60251. * @param mesh The mesh to include in the glow layer
  60252. */
  60253. addIncludedOnlyMesh(mesh: Mesh): void;
  60254. /**
  60255. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  60256. * @param mesh The mesh to remove
  60257. */
  60258. removeIncludedOnlyMesh(mesh: Mesh): void;
  60259. /**
  60260. * Determine if a given mesh will be used in the glow layer
  60261. * @param mesh The mesh to test
  60262. * @returns true if the mesh will be highlighted by the current glow layer
  60263. */
  60264. hasMesh(mesh: AbstractMesh): boolean;
  60265. /**
  60266. * Defines whether the current material of the mesh should be use to render the effect.
  60267. * @param mesh defines the current mesh to render
  60268. */
  60269. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  60270. /**
  60271. * Add a mesh to be rendered through its own material and not with emissive only.
  60272. * @param mesh The mesh for which we need to use its material
  60273. */
  60274. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  60275. /**
  60276. * Remove a mesh from being rendered through its own material and not with emissive only.
  60277. * @param mesh The mesh for which we need to not use its material
  60278. */
  60279. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  60280. /**
  60281. * Free any resources and references associated to a mesh.
  60282. * Internal use
  60283. * @param mesh The mesh to free.
  60284. * @hidden
  60285. */
  60286. _disposeMesh(mesh: Mesh): void;
  60287. /**
  60288. * Gets the class name of the effect layer
  60289. * @returns the string with the class name of the effect layer
  60290. */
  60291. getClassName(): string;
  60292. /**
  60293. * Serializes this glow layer
  60294. * @returns a serialized glow layer object
  60295. */
  60296. serialize(): any;
  60297. /**
  60298. * Creates a Glow Layer from parsed glow layer data
  60299. * @param parsedGlowLayer defines glow layer data
  60300. * @param scene defines the current scene
  60301. * @param rootUrl defines the root URL containing the glow layer information
  60302. * @returns a parsed Glow Layer
  60303. */
  60304. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  60305. }
  60306. }
  60307. declare module BABYLON {
  60308. /** @hidden */
  60309. export var glowBlurPostProcessPixelShader: {
  60310. name: string;
  60311. shader: string;
  60312. };
  60313. }
  60314. declare module BABYLON {
  60315. interface AbstractScene {
  60316. /**
  60317. * Return a the first highlight layer of the scene with a given name.
  60318. * @param name The name of the highlight layer to look for.
  60319. * @return The highlight layer if found otherwise null.
  60320. */
  60321. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  60322. }
  60323. /**
  60324. * Highlight layer options. This helps customizing the behaviour
  60325. * of the highlight layer.
  60326. */
  60327. export interface IHighlightLayerOptions {
  60328. /**
  60329. * Multiplication factor apply to the canvas size to compute the render target size
  60330. * used to generated the glowing objects (the smaller the faster).
  60331. */
  60332. mainTextureRatio: number;
  60333. /**
  60334. * Enforces a fixed size texture to ensure resize independant blur.
  60335. */
  60336. mainTextureFixedSize?: number;
  60337. /**
  60338. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  60339. * of the picture to blur (the smaller the faster).
  60340. */
  60341. blurTextureSizeRatio: number;
  60342. /**
  60343. * How big in texel of the blur texture is the vertical blur.
  60344. */
  60345. blurVerticalSize: number;
  60346. /**
  60347. * How big in texel of the blur texture is the horizontal blur.
  60348. */
  60349. blurHorizontalSize: number;
  60350. /**
  60351. * Alpha blending mode used to apply the blur. Default is combine.
  60352. */
  60353. alphaBlendingMode: number;
  60354. /**
  60355. * The camera attached to the layer.
  60356. */
  60357. camera: Nullable<Camera>;
  60358. /**
  60359. * Should we display highlight as a solid stroke?
  60360. */
  60361. isStroke?: boolean;
  60362. /**
  60363. * The rendering group to draw the layer in.
  60364. */
  60365. renderingGroupId: number;
  60366. }
  60367. /**
  60368. * The highlight layer Helps adding a glow effect around a mesh.
  60369. *
  60370. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  60371. * glowy meshes to your scene.
  60372. *
  60373. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  60374. */
  60375. export class HighlightLayer extends EffectLayer {
  60376. name: string;
  60377. /**
  60378. * Effect Name of the highlight layer.
  60379. */
  60380. static readonly EffectName: string;
  60381. /**
  60382. * The neutral color used during the preparation of the glow effect.
  60383. * This is black by default as the blend operation is a blend operation.
  60384. */
  60385. static NeutralColor: Color4;
  60386. /**
  60387. * Stencil value used for glowing meshes.
  60388. */
  60389. static GlowingMeshStencilReference: number;
  60390. /**
  60391. * Stencil value used for the other meshes in the scene.
  60392. */
  60393. static NormalMeshStencilReference: number;
  60394. /**
  60395. * Specifies whether or not the inner glow is ACTIVE in the layer.
  60396. */
  60397. innerGlow: boolean;
  60398. /**
  60399. * Specifies whether or not the outer glow is ACTIVE in the layer.
  60400. */
  60401. outerGlow: boolean;
  60402. /**
  60403. * Specifies the horizontal size of the blur.
  60404. */
  60405. set blurHorizontalSize(value: number);
  60406. /**
  60407. * Specifies the vertical size of the blur.
  60408. */
  60409. set blurVerticalSize(value: number);
  60410. /**
  60411. * Gets the horizontal size of the blur.
  60412. */
  60413. get blurHorizontalSize(): number;
  60414. /**
  60415. * Gets the vertical size of the blur.
  60416. */
  60417. get blurVerticalSize(): number;
  60418. /**
  60419. * An event triggered when the highlight layer is being blurred.
  60420. */
  60421. onBeforeBlurObservable: Observable<HighlightLayer>;
  60422. /**
  60423. * An event triggered when the highlight layer has been blurred.
  60424. */
  60425. onAfterBlurObservable: Observable<HighlightLayer>;
  60426. private _instanceGlowingMeshStencilReference;
  60427. private _options;
  60428. private _downSamplePostprocess;
  60429. private _horizontalBlurPostprocess;
  60430. private _verticalBlurPostprocess;
  60431. private _blurTexture;
  60432. private _meshes;
  60433. private _excludedMeshes;
  60434. /**
  60435. * Instantiates a new highlight Layer and references it to the scene..
  60436. * @param name The name of the layer
  60437. * @param scene The scene to use the layer in
  60438. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  60439. */
  60440. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  60441. /**
  60442. * Get the effect name of the layer.
  60443. * @return The effect name
  60444. */
  60445. getEffectName(): string;
  60446. /**
  60447. * Create the merge effect. This is the shader use to blit the information back
  60448. * to the main canvas at the end of the scene rendering.
  60449. */
  60450. protected _createMergeEffect(): Effect;
  60451. /**
  60452. * Creates the render target textures and post processes used in the highlight layer.
  60453. */
  60454. protected _createTextureAndPostProcesses(): void;
  60455. /**
  60456. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  60457. */
  60458. needStencil(): boolean;
  60459. /**
  60460. * Checks for the readiness of the element composing the layer.
  60461. * @param subMesh the mesh to check for
  60462. * @param useInstances specify wether or not to use instances to render the mesh
  60463. * @param emissiveTexture the associated emissive texture used to generate the glow
  60464. * @return true if ready otherwise, false
  60465. */
  60466. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60467. /**
  60468. * Implementation specific of rendering the generating effect on the main canvas.
  60469. * @param effect The effect used to render through
  60470. */
  60471. protected _internalRender(effect: Effect): void;
  60472. /**
  60473. * Returns true if the layer contains information to display, otherwise false.
  60474. */
  60475. shouldRender(): boolean;
  60476. /**
  60477. * Returns true if the mesh should render, otherwise false.
  60478. * @param mesh The mesh to render
  60479. * @returns true if it should render otherwise false
  60480. */
  60481. protected _shouldRenderMesh(mesh: Mesh): boolean;
  60482. /**
  60483. * Returns true if the mesh can be rendered, otherwise false.
  60484. * @param mesh The mesh to render
  60485. * @param material The material used on the mesh
  60486. * @returns true if it can be rendered otherwise false
  60487. */
  60488. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  60489. /**
  60490. * Adds specific effects defines.
  60491. * @param defines The defines to add specifics to.
  60492. */
  60493. protected _addCustomEffectDefines(defines: string[]): void;
  60494. /**
  60495. * Sets the required values for both the emissive texture and and the main color.
  60496. */
  60497. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60498. /**
  60499. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  60500. * @param mesh The mesh to exclude from the highlight layer
  60501. */
  60502. addExcludedMesh(mesh: Mesh): void;
  60503. /**
  60504. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  60505. * @param mesh The mesh to highlight
  60506. */
  60507. removeExcludedMesh(mesh: Mesh): void;
  60508. /**
  60509. * Determine if a given mesh will be highlighted by the current HighlightLayer
  60510. * @param mesh mesh to test
  60511. * @returns true if the mesh will be highlighted by the current HighlightLayer
  60512. */
  60513. hasMesh(mesh: AbstractMesh): boolean;
  60514. /**
  60515. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  60516. * @param mesh The mesh to highlight
  60517. * @param color The color of the highlight
  60518. * @param glowEmissiveOnly Extract the glow from the emissive texture
  60519. */
  60520. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  60521. /**
  60522. * Remove a mesh from the highlight layer in order to make it stop glowing.
  60523. * @param mesh The mesh to highlight
  60524. */
  60525. removeMesh(mesh: Mesh): void;
  60526. /**
  60527. * Remove all the meshes currently referenced in the highlight layer
  60528. */
  60529. removeAllMeshes(): void;
  60530. /**
  60531. * Force the stencil to the normal expected value for none glowing parts
  60532. */
  60533. private _defaultStencilReference;
  60534. /**
  60535. * Free any resources and references associated to a mesh.
  60536. * Internal use
  60537. * @param mesh The mesh to free.
  60538. * @hidden
  60539. */
  60540. _disposeMesh(mesh: Mesh): void;
  60541. /**
  60542. * Dispose the highlight layer and free resources.
  60543. */
  60544. dispose(): void;
  60545. /**
  60546. * Gets the class name of the effect layer
  60547. * @returns the string with the class name of the effect layer
  60548. */
  60549. getClassName(): string;
  60550. /**
  60551. * Serializes this Highlight layer
  60552. * @returns a serialized Highlight layer object
  60553. */
  60554. serialize(): any;
  60555. /**
  60556. * Creates a Highlight layer from parsed Highlight layer data
  60557. * @param parsedHightlightLayer defines the Highlight layer data
  60558. * @param scene defines the current scene
  60559. * @param rootUrl defines the root URL containing the Highlight layer information
  60560. * @returns a parsed Highlight layer
  60561. */
  60562. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  60563. }
  60564. }
  60565. declare module BABYLON {
  60566. interface AbstractScene {
  60567. /**
  60568. * The list of layers (background and foreground) of the scene
  60569. */
  60570. layers: Array<Layer>;
  60571. }
  60572. /**
  60573. * Defines the layer scene component responsible to manage any layers
  60574. * in a given scene.
  60575. */
  60576. export class LayerSceneComponent implements ISceneComponent {
  60577. /**
  60578. * The component name helpfull to identify the component in the list of scene components.
  60579. */
  60580. readonly name: string;
  60581. /**
  60582. * The scene the component belongs to.
  60583. */
  60584. scene: Scene;
  60585. private _engine;
  60586. /**
  60587. * Creates a new instance of the component for the given scene
  60588. * @param scene Defines the scene to register the component in
  60589. */
  60590. constructor(scene: Scene);
  60591. /**
  60592. * Registers the component in a given scene
  60593. */
  60594. register(): void;
  60595. /**
  60596. * Rebuilds the elements related to this component in case of
  60597. * context lost for instance.
  60598. */
  60599. rebuild(): void;
  60600. /**
  60601. * Disposes the component and the associated ressources.
  60602. */
  60603. dispose(): void;
  60604. private _draw;
  60605. private _drawCameraPredicate;
  60606. private _drawCameraBackground;
  60607. private _drawCameraForeground;
  60608. private _drawRenderTargetPredicate;
  60609. private _drawRenderTargetBackground;
  60610. private _drawRenderTargetForeground;
  60611. /**
  60612. * Adds all the elements from the container to the scene
  60613. * @param container the container holding the elements
  60614. */
  60615. addFromContainer(container: AbstractScene): void;
  60616. /**
  60617. * Removes all the elements in the container from the scene
  60618. * @param container contains the elements to remove
  60619. * @param dispose if the removed element should be disposed (default: false)
  60620. */
  60621. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  60622. }
  60623. }
  60624. declare module BABYLON {
  60625. /** @hidden */
  60626. export var layerPixelShader: {
  60627. name: string;
  60628. shader: string;
  60629. };
  60630. }
  60631. declare module BABYLON {
  60632. /** @hidden */
  60633. export var layerVertexShader: {
  60634. name: string;
  60635. shader: string;
  60636. };
  60637. }
  60638. declare module BABYLON {
  60639. /**
  60640. * This represents a full screen 2d layer.
  60641. * This can be useful to display a picture in the background of your scene for instance.
  60642. * @see https://www.babylonjs-playground.com/#08A2BS#1
  60643. */
  60644. export class Layer {
  60645. /**
  60646. * Define the name of the layer.
  60647. */
  60648. name: string;
  60649. /**
  60650. * Define the texture the layer should display.
  60651. */
  60652. texture: Nullable<Texture>;
  60653. /**
  60654. * Is the layer in background or foreground.
  60655. */
  60656. isBackground: boolean;
  60657. /**
  60658. * Define the color of the layer (instead of texture).
  60659. */
  60660. color: Color4;
  60661. /**
  60662. * Define the scale of the layer in order to zoom in out of the texture.
  60663. */
  60664. scale: Vector2;
  60665. /**
  60666. * Define an offset for the layer in order to shift the texture.
  60667. */
  60668. offset: Vector2;
  60669. /**
  60670. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  60671. */
  60672. alphaBlendingMode: number;
  60673. /**
  60674. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  60675. * Alpha test will not mix with the background color in case of transparency.
  60676. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  60677. */
  60678. alphaTest: boolean;
  60679. /**
  60680. * Define a mask to restrict the layer to only some of the scene cameras.
  60681. */
  60682. layerMask: number;
  60683. /**
  60684. * Define the list of render target the layer is visible into.
  60685. */
  60686. renderTargetTextures: RenderTargetTexture[];
  60687. /**
  60688. * Define if the layer is only used in renderTarget or if it also
  60689. * renders in the main frame buffer of the canvas.
  60690. */
  60691. renderOnlyInRenderTargetTextures: boolean;
  60692. private _scene;
  60693. private _vertexBuffers;
  60694. private _indexBuffer;
  60695. private _effect;
  60696. private _previousDefines;
  60697. /**
  60698. * An event triggered when the layer is disposed.
  60699. */
  60700. onDisposeObservable: Observable<Layer>;
  60701. private _onDisposeObserver;
  60702. /**
  60703. * Back compatibility with callback before the onDisposeObservable existed.
  60704. * The set callback will be triggered when the layer has been disposed.
  60705. */
  60706. set onDispose(callback: () => void);
  60707. /**
  60708. * An event triggered before rendering the scene
  60709. */
  60710. onBeforeRenderObservable: Observable<Layer>;
  60711. private _onBeforeRenderObserver;
  60712. /**
  60713. * Back compatibility with callback before the onBeforeRenderObservable existed.
  60714. * The set callback will be triggered just before rendering the layer.
  60715. */
  60716. set onBeforeRender(callback: () => void);
  60717. /**
  60718. * An event triggered after rendering the scene
  60719. */
  60720. onAfterRenderObservable: Observable<Layer>;
  60721. private _onAfterRenderObserver;
  60722. /**
  60723. * Back compatibility with callback before the onAfterRenderObservable existed.
  60724. * The set callback will be triggered just after rendering the layer.
  60725. */
  60726. set onAfterRender(callback: () => void);
  60727. /**
  60728. * Instantiates a new layer.
  60729. * This represents a full screen 2d layer.
  60730. * This can be useful to display a picture in the background of your scene for instance.
  60731. * @see https://www.babylonjs-playground.com/#08A2BS#1
  60732. * @param name Define the name of the layer in the scene
  60733. * @param imgUrl Define the url of the texture to display in the layer
  60734. * @param scene Define the scene the layer belongs to
  60735. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  60736. * @param color Defines a color for the layer
  60737. */
  60738. constructor(
  60739. /**
  60740. * Define the name of the layer.
  60741. */
  60742. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  60743. private _createIndexBuffer;
  60744. /** @hidden */
  60745. _rebuild(): void;
  60746. /**
  60747. * Renders the layer in the scene.
  60748. */
  60749. render(): void;
  60750. /**
  60751. * Disposes and releases the associated ressources.
  60752. */
  60753. dispose(): void;
  60754. }
  60755. }
  60756. declare module BABYLON {
  60757. /** @hidden */
  60758. export var lensFlarePixelShader: {
  60759. name: string;
  60760. shader: string;
  60761. };
  60762. }
  60763. declare module BABYLON {
  60764. /** @hidden */
  60765. export var lensFlareVertexShader: {
  60766. name: string;
  60767. shader: string;
  60768. };
  60769. }
  60770. declare module BABYLON {
  60771. /**
  60772. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  60773. * It is usually composed of several `lensFlare`.
  60774. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  60775. */
  60776. export class LensFlareSystem {
  60777. /**
  60778. * Define the name of the lens flare system
  60779. */
  60780. name: string;
  60781. /**
  60782. * List of lens flares used in this system.
  60783. */
  60784. lensFlares: LensFlare[];
  60785. /**
  60786. * Define a limit from the border the lens flare can be visible.
  60787. */
  60788. borderLimit: number;
  60789. /**
  60790. * Define a viewport border we do not want to see the lens flare in.
  60791. */
  60792. viewportBorder: number;
  60793. /**
  60794. * Define a predicate which could limit the list of meshes able to occlude the effect.
  60795. */
  60796. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  60797. /**
  60798. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  60799. */
  60800. layerMask: number;
  60801. /**
  60802. * Define the id of the lens flare system in the scene.
  60803. * (equal to name by default)
  60804. */
  60805. id: string;
  60806. private _scene;
  60807. private _emitter;
  60808. private _vertexBuffers;
  60809. private _indexBuffer;
  60810. private _effect;
  60811. private _positionX;
  60812. private _positionY;
  60813. private _isEnabled;
  60814. /** @hidden */
  60815. static _SceneComponentInitialization: (scene: Scene) => void;
  60816. /**
  60817. * Instantiates a lens flare system.
  60818. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  60819. * It is usually composed of several `lensFlare`.
  60820. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  60821. * @param name Define the name of the lens flare system in the scene
  60822. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  60823. * @param scene Define the scene the lens flare system belongs to
  60824. */
  60825. constructor(
  60826. /**
  60827. * Define the name of the lens flare system
  60828. */
  60829. name: string, emitter: any, scene: Scene);
  60830. /**
  60831. * Define if the lens flare system is enabled.
  60832. */
  60833. get isEnabled(): boolean;
  60834. set isEnabled(value: boolean);
  60835. /**
  60836. * Get the scene the effects belongs to.
  60837. * @returns the scene holding the lens flare system
  60838. */
  60839. getScene(): Scene;
  60840. /**
  60841. * Get the emitter of the lens flare system.
  60842. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  60843. * @returns the emitter of the lens flare system
  60844. */
  60845. getEmitter(): any;
  60846. /**
  60847. * Set the emitter of the lens flare system.
  60848. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  60849. * @param newEmitter Define the new emitter of the system
  60850. */
  60851. setEmitter(newEmitter: any): void;
  60852. /**
  60853. * Get the lens flare system emitter position.
  60854. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  60855. * @returns the position
  60856. */
  60857. getEmitterPosition(): Vector3;
  60858. /**
  60859. * @hidden
  60860. */
  60861. computeEffectivePosition(globalViewport: Viewport): boolean;
  60862. /** @hidden */
  60863. _isVisible(): boolean;
  60864. /**
  60865. * @hidden
  60866. */
  60867. render(): boolean;
  60868. /**
  60869. * Dispose and release the lens flare with its associated resources.
  60870. */
  60871. dispose(): void;
  60872. /**
  60873. * Parse a lens flare system from a JSON repressentation
  60874. * @param parsedLensFlareSystem Define the JSON to parse
  60875. * @param scene Define the scene the parsed system should be instantiated in
  60876. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  60877. * @returns the parsed system
  60878. */
  60879. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  60880. /**
  60881. * Serialize the current Lens Flare System into a JSON representation.
  60882. * @returns the serialized JSON
  60883. */
  60884. serialize(): any;
  60885. }
  60886. }
  60887. declare module BABYLON {
  60888. /**
  60889. * This represents one of the lens effect in a `lensFlareSystem`.
  60890. * It controls one of the indiviual texture used in the effect.
  60891. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  60892. */
  60893. export class LensFlare {
  60894. /**
  60895. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  60896. */
  60897. size: number;
  60898. /**
  60899. * 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.
  60900. */
  60901. position: number;
  60902. /**
  60903. * Define the lens color.
  60904. */
  60905. color: Color3;
  60906. /**
  60907. * Define the lens texture.
  60908. */
  60909. texture: Nullable<Texture>;
  60910. /**
  60911. * Define the alpha mode to render this particular lens.
  60912. */
  60913. alphaMode: number;
  60914. private _system;
  60915. /**
  60916. * Creates a new Lens Flare.
  60917. * This represents one of the lens effect in a `lensFlareSystem`.
  60918. * It controls one of the indiviual texture used in the effect.
  60919. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  60920. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  60921. * @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.
  60922. * @param color Define the lens color
  60923. * @param imgUrl Define the lens texture url
  60924. * @param system Define the `lensFlareSystem` this flare is part of
  60925. * @returns The newly created Lens Flare
  60926. */
  60927. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  60928. /**
  60929. * Instantiates a new Lens Flare.
  60930. * This represents one of the lens effect in a `lensFlareSystem`.
  60931. * It controls one of the indiviual texture used in the effect.
  60932. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  60933. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  60934. * @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.
  60935. * @param color Define the lens color
  60936. * @param imgUrl Define the lens texture url
  60937. * @param system Define the `lensFlareSystem` this flare is part of
  60938. */
  60939. constructor(
  60940. /**
  60941. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  60942. */
  60943. size: number,
  60944. /**
  60945. * 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.
  60946. */
  60947. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  60948. /**
  60949. * Dispose and release the lens flare with its associated resources.
  60950. */
  60951. dispose(): void;
  60952. }
  60953. }
  60954. declare module BABYLON {
  60955. interface AbstractScene {
  60956. /**
  60957. * The list of lens flare system added to the scene
  60958. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  60959. */
  60960. lensFlareSystems: Array<LensFlareSystem>;
  60961. /**
  60962. * Removes the given lens flare system from this scene.
  60963. * @param toRemove The lens flare system to remove
  60964. * @returns The index of the removed lens flare system
  60965. */
  60966. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  60967. /**
  60968. * Adds the given lens flare system to this scene
  60969. * @param newLensFlareSystem The lens flare system to add
  60970. */
  60971. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  60972. /**
  60973. * Gets a lens flare system using its name
  60974. * @param name defines the name to look for
  60975. * @returns the lens flare system or null if not found
  60976. */
  60977. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  60978. /**
  60979. * Gets a lens flare system using its id
  60980. * @param id defines the id to look for
  60981. * @returns the lens flare system or null if not found
  60982. */
  60983. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  60984. }
  60985. /**
  60986. * Defines the lens flare scene component responsible to manage any lens flares
  60987. * in a given scene.
  60988. */
  60989. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  60990. /**
  60991. * The component name helpfull to identify the component in the list of scene components.
  60992. */
  60993. readonly name: string;
  60994. /**
  60995. * The scene the component belongs to.
  60996. */
  60997. scene: Scene;
  60998. /**
  60999. * Creates a new instance of the component for the given scene
  61000. * @param scene Defines the scene to register the component in
  61001. */
  61002. constructor(scene: Scene);
  61003. /**
  61004. * Registers the component in a given scene
  61005. */
  61006. register(): void;
  61007. /**
  61008. * Rebuilds the elements related to this component in case of
  61009. * context lost for instance.
  61010. */
  61011. rebuild(): void;
  61012. /**
  61013. * Adds all the elements from the container to the scene
  61014. * @param container the container holding the elements
  61015. */
  61016. addFromContainer(container: AbstractScene): void;
  61017. /**
  61018. * Removes all the elements in the container from the scene
  61019. * @param container contains the elements to remove
  61020. * @param dispose if the removed element should be disposed (default: false)
  61021. */
  61022. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61023. /**
  61024. * Serializes the component data to the specified json object
  61025. * @param serializationObject The object to serialize to
  61026. */
  61027. serialize(serializationObject: any): void;
  61028. /**
  61029. * Disposes the component and the associated ressources.
  61030. */
  61031. dispose(): void;
  61032. private _draw;
  61033. }
  61034. }
  61035. declare module BABYLON {
  61036. /** @hidden */
  61037. export var depthPixelShader: {
  61038. name: string;
  61039. shader: string;
  61040. };
  61041. }
  61042. declare module BABYLON {
  61043. /** @hidden */
  61044. export var depthVertexShader: {
  61045. name: string;
  61046. shader: string;
  61047. };
  61048. }
  61049. declare module BABYLON {
  61050. /**
  61051. * This represents a depth renderer in Babylon.
  61052. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  61053. */
  61054. export class DepthRenderer {
  61055. private _scene;
  61056. private _depthMap;
  61057. private _effect;
  61058. private readonly _storeNonLinearDepth;
  61059. private readonly _clearColor;
  61060. /** Get if the depth renderer is using packed depth or not */
  61061. readonly isPacked: boolean;
  61062. private _cachedDefines;
  61063. private _camera;
  61064. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  61065. enabled: boolean;
  61066. /**
  61067. * Specifiess that the depth renderer will only be used within
  61068. * the camera it is created for.
  61069. * This can help forcing its rendering during the camera processing.
  61070. */
  61071. useOnlyInActiveCamera: boolean;
  61072. /** @hidden */
  61073. static _SceneComponentInitialization: (scene: Scene) => void;
  61074. /**
  61075. * Instantiates a depth renderer
  61076. * @param scene The scene the renderer belongs to
  61077. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  61078. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  61079. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  61080. */
  61081. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  61082. /**
  61083. * Creates the depth rendering effect and checks if the effect is ready.
  61084. * @param subMesh The submesh to be used to render the depth map of
  61085. * @param useInstances If multiple world instances should be used
  61086. * @returns if the depth renderer is ready to render the depth map
  61087. */
  61088. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61089. /**
  61090. * Gets the texture which the depth map will be written to.
  61091. * @returns The depth map texture
  61092. */
  61093. getDepthMap(): RenderTargetTexture;
  61094. /**
  61095. * Disposes of the depth renderer.
  61096. */
  61097. dispose(): void;
  61098. }
  61099. }
  61100. declare module BABYLON {
  61101. /** @hidden */
  61102. export var minmaxReduxPixelShader: {
  61103. name: string;
  61104. shader: string;
  61105. };
  61106. }
  61107. declare module BABYLON {
  61108. /**
  61109. * This class computes a min/max reduction from a texture: it means it computes the minimum
  61110. * and maximum values from all values of the texture.
  61111. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  61112. * The source values are read from the red channel of the texture.
  61113. */
  61114. export class MinMaxReducer {
  61115. /**
  61116. * Observable triggered when the computation has been performed
  61117. */
  61118. onAfterReductionPerformed: Observable<{
  61119. min: number;
  61120. max: number;
  61121. }>;
  61122. protected _camera: Camera;
  61123. protected _sourceTexture: Nullable<RenderTargetTexture>;
  61124. protected _reductionSteps: Nullable<Array<PostProcess>>;
  61125. protected _postProcessManager: PostProcessManager;
  61126. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  61127. protected _forceFullscreenViewport: boolean;
  61128. /**
  61129. * Creates a min/max reducer
  61130. * @param camera The camera to use for the post processes
  61131. */
  61132. constructor(camera: Camera);
  61133. /**
  61134. * Gets the texture used to read the values from.
  61135. */
  61136. get sourceTexture(): Nullable<RenderTargetTexture>;
  61137. /**
  61138. * Sets the source texture to read the values from.
  61139. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  61140. * because in such textures '1' value must not be taken into account to compute the maximum
  61141. * as this value is used to clear the texture.
  61142. * Note that the computation is not activated by calling this function, you must call activate() for that!
  61143. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  61144. * @param depthRedux Indicates if the texture is a depth texture or not
  61145. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  61146. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  61147. */
  61148. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  61149. /**
  61150. * Defines the refresh rate of the computation.
  61151. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  61152. */
  61153. get refreshRate(): number;
  61154. set refreshRate(value: number);
  61155. protected _activated: boolean;
  61156. /**
  61157. * Gets the activation status of the reducer
  61158. */
  61159. get activated(): boolean;
  61160. /**
  61161. * Activates the reduction computation.
  61162. * When activated, the observers registered in onAfterReductionPerformed are
  61163. * called after the compuation is performed
  61164. */
  61165. activate(): void;
  61166. /**
  61167. * Deactivates the reduction computation.
  61168. */
  61169. deactivate(): void;
  61170. /**
  61171. * Disposes the min/max reducer
  61172. * @param disposeAll true to dispose all the resources. You should always call this function with true as the parameter (or without any parameter as it is the default one). This flag is meant to be used internally.
  61173. */
  61174. dispose(disposeAll?: boolean): void;
  61175. }
  61176. }
  61177. declare module BABYLON {
  61178. /**
  61179. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  61180. */
  61181. export class DepthReducer extends MinMaxReducer {
  61182. private _depthRenderer;
  61183. private _depthRendererId;
  61184. /**
  61185. * Gets the depth renderer used for the computation.
  61186. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  61187. */
  61188. get depthRenderer(): Nullable<DepthRenderer>;
  61189. /**
  61190. * Creates a depth reducer
  61191. * @param camera The camera used to render the depth texture
  61192. */
  61193. constructor(camera: Camera);
  61194. /**
  61195. * Sets the depth renderer to use to generate the depth map
  61196. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  61197. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  61198. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  61199. */
  61200. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  61201. /** @hidden */
  61202. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  61203. /**
  61204. * Activates the reduction computation.
  61205. * When activated, the observers registered in onAfterReductionPerformed are
  61206. * called after the compuation is performed
  61207. */
  61208. activate(): void;
  61209. /**
  61210. * Deactivates the reduction computation.
  61211. */
  61212. deactivate(): void;
  61213. /**
  61214. * Disposes the depth reducer
  61215. * @param disposeAll true to dispose all the resources. You should always call this function with true as the parameter (or without any parameter as it is the default one). This flag is meant to be used internally.
  61216. */
  61217. dispose(disposeAll?: boolean): void;
  61218. }
  61219. }
  61220. declare module BABYLON {
  61221. /**
  61222. * A CSM implementation allowing casting shadows on large scenes.
  61223. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  61224. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  61225. */
  61226. export class CascadedShadowGenerator extends ShadowGenerator {
  61227. private static readonly frustumCornersNDCSpace;
  61228. /**
  61229. * Name of the CSM class
  61230. */
  61231. static CLASSNAME: string;
  61232. /**
  61233. * Defines the default number of cascades used by the CSM.
  61234. */
  61235. static readonly DEFAULT_CASCADES_COUNT: number;
  61236. /**
  61237. * Defines the minimum number of cascades used by the CSM.
  61238. */
  61239. static readonly MIN_CASCADES_COUNT: number;
  61240. /**
  61241. * Defines the maximum number of cascades used by the CSM.
  61242. */
  61243. static readonly MAX_CASCADES_COUNT: number;
  61244. protected _validateFilter(filter: number): number;
  61245. /**
  61246. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  61247. */
  61248. penumbraDarkness: number;
  61249. private _numCascades;
  61250. /**
  61251. * Gets or set the number of cascades used by the CSM.
  61252. */
  61253. get numCascades(): number;
  61254. set numCascades(value: number);
  61255. /**
  61256. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  61257. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  61258. */
  61259. stabilizeCascades: boolean;
  61260. private _freezeShadowCastersBoundingInfo;
  61261. private _freezeShadowCastersBoundingInfoObservable;
  61262. /**
  61263. * Enables or disables the shadow casters bounding info computation.
  61264. * If your shadow casters don't move, you can disable this feature.
  61265. * If it is enabled, the bounding box computation is done every frame.
  61266. */
  61267. get freezeShadowCastersBoundingInfo(): boolean;
  61268. set freezeShadowCastersBoundingInfo(freeze: boolean);
  61269. private _scbiMin;
  61270. private _scbiMax;
  61271. protected _computeShadowCastersBoundingInfo(): void;
  61272. protected _shadowCastersBoundingInfo: BoundingInfo;
  61273. /**
  61274. * Gets or sets the shadow casters bounding info.
  61275. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  61276. * so that the system won't overwrite the bounds you provide
  61277. */
  61278. get shadowCastersBoundingInfo(): BoundingInfo;
  61279. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  61280. protected _breaksAreDirty: boolean;
  61281. protected _minDistance: number;
  61282. protected _maxDistance: number;
  61283. /**
  61284. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  61285. *
  61286. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  61287. * If you don't know these values, simply leave them to their defaults and don't call this function.
  61288. * @param min minimal distance for the breaks (default to 0.)
  61289. * @param max maximal distance for the breaks (default to 1.)
  61290. */
  61291. setMinMaxDistance(min: number, max: number): void;
  61292. /** Gets the minimal distance used in the cascade break computation */
  61293. get minDistance(): number;
  61294. /** Gets the maximal distance used in the cascade break computation */
  61295. get maxDistance(): number;
  61296. /**
  61297. * Gets the class name of that object
  61298. * @returns "CascadedShadowGenerator"
  61299. */
  61300. getClassName(): string;
  61301. private _cascadeMinExtents;
  61302. private _cascadeMaxExtents;
  61303. /**
  61304. * Gets a cascade minimum extents
  61305. * @param cascadeIndex index of the cascade
  61306. * @returns the minimum cascade extents
  61307. */
  61308. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  61309. /**
  61310. * Gets a cascade maximum extents
  61311. * @param cascadeIndex index of the cascade
  61312. * @returns the maximum cascade extents
  61313. */
  61314. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  61315. private _cascades;
  61316. private _currentLayer;
  61317. private _viewSpaceFrustumsZ;
  61318. private _viewMatrices;
  61319. private _projectionMatrices;
  61320. private _transformMatrices;
  61321. private _transformMatricesAsArray;
  61322. private _frustumLengths;
  61323. private _lightSizeUVCorrection;
  61324. private _depthCorrection;
  61325. private _frustumCornersWorldSpace;
  61326. private _frustumCenter;
  61327. private _shadowCameraPos;
  61328. private _shadowMaxZ;
  61329. /**
  61330. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  61331. * It defaults to camera.maxZ
  61332. */
  61333. get shadowMaxZ(): number;
  61334. /**
  61335. * Sets the shadow max z distance.
  61336. */
  61337. set shadowMaxZ(value: number);
  61338. protected _debug: boolean;
  61339. /**
  61340. * Gets or sets the debug flag.
  61341. * When enabled, the cascades are materialized by different colors on the screen.
  61342. */
  61343. get debug(): boolean;
  61344. set debug(dbg: boolean);
  61345. private _depthClamp;
  61346. /**
  61347. * Gets or sets the depth clamping value.
  61348. *
  61349. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  61350. * to account for the shadow casters far away.
  61351. *
  61352. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  61353. */
  61354. get depthClamp(): boolean;
  61355. set depthClamp(value: boolean);
  61356. private _cascadeBlendPercentage;
  61357. /**
  61358. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  61359. * It defaults to 0.1 (10% blending).
  61360. */
  61361. get cascadeBlendPercentage(): number;
  61362. set cascadeBlendPercentage(value: number);
  61363. private _lambda;
  61364. /**
  61365. * Gets or set the lambda parameter.
  61366. * This parameter is used to split the camera frustum and create the cascades.
  61367. * It's a value between 0. and 1.: If 0, the split is a uniform split of the frustum, if 1 it is a logarithmic split.
  61368. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  61369. */
  61370. get lambda(): number;
  61371. set lambda(value: number);
  61372. /**
  61373. * Gets the view matrix corresponding to a given cascade
  61374. * @param cascadeNum cascade to retrieve the view matrix from
  61375. * @returns the cascade view matrix
  61376. */
  61377. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  61378. /**
  61379. * Gets the projection matrix corresponding to a given cascade
  61380. * @param cascadeNum cascade to retrieve the projection matrix from
  61381. * @returns the cascade projection matrix
  61382. */
  61383. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  61384. /**
  61385. * Gets the transformation matrix corresponding to a given cascade
  61386. * @param cascadeNum cascade to retrieve the transformation matrix from
  61387. * @returns the cascade transformation matrix
  61388. */
  61389. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  61390. private _depthRenderer;
  61391. /**
  61392. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  61393. *
  61394. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  61395. *
  61396. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  61397. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  61398. * @param depthRenderer The depth renderer to use when autoCalcDepthBounds is enabled. If you pass null or don't call this function at all, a depth renderer will be automatically created
  61399. */
  61400. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  61401. private _depthReducer;
  61402. private _autoCalcDepthBounds;
  61403. /**
  61404. * Gets or sets the autoCalcDepthBounds property.
  61405. *
  61406. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  61407. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  61408. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  61409. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  61410. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  61411. */
  61412. get autoCalcDepthBounds(): boolean;
  61413. set autoCalcDepthBounds(value: boolean);
  61414. /**
  61415. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  61416. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  61417. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  61418. * for setting the refresh rate on the renderer yourself!
  61419. */
  61420. get autoCalcDepthBoundsRefreshRate(): number;
  61421. set autoCalcDepthBoundsRefreshRate(value: number);
  61422. /**
  61423. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  61424. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  61425. * you change the camera near/far planes!
  61426. */
  61427. splitFrustum(): void;
  61428. private _splitFrustum;
  61429. private _computeMatrices;
  61430. private _computeFrustumInWorldSpace;
  61431. private _computeCascadeFrustum;
  61432. /**
  61433. * Support test.
  61434. */
  61435. static get IsSupported(): boolean;
  61436. /** @hidden */
  61437. static _SceneComponentInitialization: (scene: Scene) => void;
  61438. /**
  61439. * Creates a Cascaded Shadow Generator object.
  61440. * A ShadowGenerator is the required tool to use the shadows.
  61441. * Each directional light casting shadows needs to use its own ShadowGenerator.
  61442. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  61443. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  61444. * @param light The directional light object generating the shadows.
  61445. * @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.
  61446. */
  61447. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  61448. protected _initializeGenerator(): void;
  61449. protected _createTargetRenderTexture(): void;
  61450. protected _initializeShadowMap(): void;
  61451. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  61452. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  61453. /**
  61454. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  61455. * @param defines Defines of the material we want to update
  61456. * @param lightIndex Index of the light in the enabled light list of the material
  61457. */
  61458. prepareDefines(defines: any, lightIndex: number): void;
  61459. /**
  61460. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  61461. * defined in the generator but impacting the effect).
  61462. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  61463. * @param effect The effect we are binfing the information for
  61464. */
  61465. bindShadowLight(lightIndex: string, effect: Effect): void;
  61466. /**
  61467. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  61468. * (eq to view projection * shadow projection matrices)
  61469. * @returns The transform matrix used to create the shadow map
  61470. */
  61471. getTransformMatrix(): Matrix;
  61472. /**
  61473. * Disposes the ShadowGenerator.
  61474. * Returns nothing.
  61475. */
  61476. dispose(): void;
  61477. /**
  61478. * Serializes the shadow generator setup to a json object.
  61479. * @returns The serialized JSON object
  61480. */
  61481. serialize(): any;
  61482. /**
  61483. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  61484. * @param parsedShadowGenerator The JSON object to parse
  61485. * @param scene The scene to create the shadow map for
  61486. * @returns The parsed shadow generator
  61487. */
  61488. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  61489. }
  61490. }
  61491. declare module BABYLON {
  61492. /**
  61493. * Defines the shadow generator component responsible to manage any shadow generators
  61494. * in a given scene.
  61495. */
  61496. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  61497. /**
  61498. * The component name helpfull to identify the component in the list of scene components.
  61499. */
  61500. readonly name: string;
  61501. /**
  61502. * The scene the component belongs to.
  61503. */
  61504. scene: Scene;
  61505. /**
  61506. * Creates a new instance of the component for the given scene
  61507. * @param scene Defines the scene to register the component in
  61508. */
  61509. constructor(scene: Scene);
  61510. /**
  61511. * Registers the component in a given scene
  61512. */
  61513. register(): void;
  61514. /**
  61515. * Rebuilds the elements related to this component in case of
  61516. * context lost for instance.
  61517. */
  61518. rebuild(): void;
  61519. /**
  61520. * Serializes the component data to the specified json object
  61521. * @param serializationObject The object to serialize to
  61522. */
  61523. serialize(serializationObject: any): void;
  61524. /**
  61525. * Adds all the elements from the container to the scene
  61526. * @param container the container holding the elements
  61527. */
  61528. addFromContainer(container: AbstractScene): void;
  61529. /**
  61530. * Removes all the elements in the container from the scene
  61531. * @param container contains the elements to remove
  61532. * @param dispose if the removed element should be disposed (default: false)
  61533. */
  61534. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61535. /**
  61536. * Rebuilds the elements related to this component in case of
  61537. * context lost for instance.
  61538. */
  61539. dispose(): void;
  61540. private _gatherRenderTargets;
  61541. }
  61542. }
  61543. declare module BABYLON {
  61544. /**
  61545. * A point light is a light defined by an unique point in world space.
  61546. * The light is emitted in every direction from this point.
  61547. * A good example of a point light is a standard light bulb.
  61548. * Documentation: https://doc.babylonjs.com/babylon101/lights
  61549. */
  61550. export class PointLight extends ShadowLight {
  61551. private _shadowAngle;
  61552. /**
  61553. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  61554. * This specifies what angle the shadow will use to be created.
  61555. *
  61556. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  61557. */
  61558. get shadowAngle(): number;
  61559. /**
  61560. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  61561. * This specifies what angle the shadow will use to be created.
  61562. *
  61563. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  61564. */
  61565. set shadowAngle(value: number);
  61566. /**
  61567. * Gets the direction if it has been set.
  61568. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  61569. */
  61570. get direction(): Vector3;
  61571. /**
  61572. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  61573. */
  61574. set direction(value: Vector3);
  61575. /**
  61576. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  61577. * A PointLight emits the light in every direction.
  61578. * It can cast shadows.
  61579. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  61580. * ```javascript
  61581. * var pointLight = new PointLight("pl", camera.position, scene);
  61582. * ```
  61583. * Documentation : https://doc.babylonjs.com/babylon101/lights
  61584. * @param name The light friendly name
  61585. * @param position The position of the point light in the scene
  61586. * @param scene The scene the lights belongs to
  61587. */
  61588. constructor(name: string, position: Vector3, scene: Scene);
  61589. /**
  61590. * Returns the string "PointLight"
  61591. * @returns the class name
  61592. */
  61593. getClassName(): string;
  61594. /**
  61595. * Returns the integer 0.
  61596. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  61597. */
  61598. getTypeID(): number;
  61599. /**
  61600. * Specifies wether or not the shadowmap should be a cube texture.
  61601. * @returns true if the shadowmap needs to be a cube texture.
  61602. */
  61603. needCube(): boolean;
  61604. /**
  61605. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  61606. * @param faceIndex The index of the face we are computed the direction to generate shadow
  61607. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  61608. */
  61609. getShadowDirection(faceIndex?: number): Vector3;
  61610. /**
  61611. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  61612. * - fov = PI / 2
  61613. * - aspect ratio : 1.0
  61614. * - z-near and far equal to the active camera minZ and maxZ.
  61615. * Returns the PointLight.
  61616. */
  61617. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  61618. protected _buildUniformLayout(): void;
  61619. /**
  61620. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  61621. * @param effect The effect to update
  61622. * @param lightIndex The index of the light in the effect to update
  61623. * @returns The point light
  61624. */
  61625. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  61626. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  61627. /**
  61628. * Prepares the list of defines specific to the light type.
  61629. * @param defines the list of defines
  61630. * @param lightIndex defines the index of the light for the effect
  61631. */
  61632. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  61633. }
  61634. }
  61635. declare module BABYLON {
  61636. /**
  61637. * Header information of HDR texture files.
  61638. */
  61639. export interface HDRInfo {
  61640. /**
  61641. * The height of the texture in pixels.
  61642. */
  61643. height: number;
  61644. /**
  61645. * The width of the texture in pixels.
  61646. */
  61647. width: number;
  61648. /**
  61649. * The index of the beginning of the data in the binary file.
  61650. */
  61651. dataPosition: number;
  61652. }
  61653. /**
  61654. * This groups tools to convert HDR texture to native colors array.
  61655. */
  61656. export class HDRTools {
  61657. private static Ldexp;
  61658. private static Rgbe2float;
  61659. private static readStringLine;
  61660. /**
  61661. * Reads header information from an RGBE texture stored in a native array.
  61662. * More information on this format are available here:
  61663. * https://en.wikipedia.org/wiki/RGBE_image_format
  61664. *
  61665. * @param uint8array The binary file stored in native array.
  61666. * @return The header information.
  61667. */
  61668. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  61669. /**
  61670. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  61671. * This RGBE texture needs to store the information as a panorama.
  61672. *
  61673. * More information on this format are available here:
  61674. * https://en.wikipedia.org/wiki/RGBE_image_format
  61675. *
  61676. * @param buffer The binary file stored in an array buffer.
  61677. * @param size The expected size of the extracted cubemap.
  61678. * @return The Cube Map information.
  61679. */
  61680. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  61681. /**
  61682. * Returns the pixels data extracted from an RGBE texture.
  61683. * This pixels will be stored left to right up to down in the R G B order in one array.
  61684. *
  61685. * More information on this format are available here:
  61686. * https://en.wikipedia.org/wiki/RGBE_image_format
  61687. *
  61688. * @param uint8array The binary file stored in an array buffer.
  61689. * @param hdrInfo The header information of the file.
  61690. * @return The pixels data in RGB right to left up to down order.
  61691. */
  61692. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  61693. private static RGBE_ReadPixels_RLE;
  61694. private static RGBE_ReadPixels_NOT_RLE;
  61695. }
  61696. }
  61697. declare module BABYLON {
  61698. /**
  61699. * Effect Render Options
  61700. */
  61701. export interface IEffectRendererOptions {
  61702. /**
  61703. * Defines the vertices positions.
  61704. */
  61705. positions?: number[];
  61706. /**
  61707. * Defines the indices.
  61708. */
  61709. indices?: number[];
  61710. }
  61711. /**
  61712. * Helper class to render one or more effects.
  61713. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  61714. */
  61715. export class EffectRenderer {
  61716. private engine;
  61717. private static _DefaultOptions;
  61718. private _vertexBuffers;
  61719. private _indexBuffer;
  61720. private _fullscreenViewport;
  61721. /**
  61722. * Creates an effect renderer
  61723. * @param engine the engine to use for rendering
  61724. * @param options defines the options of the effect renderer
  61725. */
  61726. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  61727. /**
  61728. * Sets the current viewport in normalized coordinates 0-1
  61729. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  61730. */
  61731. setViewport(viewport?: Viewport): void;
  61732. /**
  61733. * Binds the embedded attributes buffer to the effect.
  61734. * @param effect Defines the effect to bind the attributes for
  61735. */
  61736. bindBuffers(effect: Effect): void;
  61737. /**
  61738. * Sets the current effect wrapper to use during draw.
  61739. * The effect needs to be ready before calling this api.
  61740. * This also sets the default full screen position attribute.
  61741. * @param effectWrapper Defines the effect to draw with
  61742. */
  61743. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  61744. /**
  61745. * Restores engine states
  61746. */
  61747. restoreStates(): void;
  61748. /**
  61749. * Draws a full screen quad.
  61750. */
  61751. draw(): void;
  61752. private isRenderTargetTexture;
  61753. /**
  61754. * renders one or more effects to a specified texture
  61755. * @param effectWrapper the effect to renderer
  61756. * @param outputTexture texture to draw to, if null it will render to the screen.
  61757. */
  61758. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  61759. /**
  61760. * Disposes of the effect renderer
  61761. */
  61762. dispose(): void;
  61763. }
  61764. /**
  61765. * Options to create an EffectWrapper
  61766. */
  61767. interface EffectWrapperCreationOptions {
  61768. /**
  61769. * Engine to use to create the effect
  61770. */
  61771. engine: ThinEngine;
  61772. /**
  61773. * Fragment shader for the effect
  61774. */
  61775. fragmentShader: string;
  61776. /**
  61777. * Use the shader store instead of direct source code
  61778. */
  61779. useShaderStore?: boolean;
  61780. /**
  61781. * Vertex shader for the effect
  61782. */
  61783. vertexShader?: string;
  61784. /**
  61785. * Attributes to use in the shader
  61786. */
  61787. attributeNames?: Array<string>;
  61788. /**
  61789. * Uniforms to use in the shader
  61790. */
  61791. uniformNames?: Array<string>;
  61792. /**
  61793. * Texture sampler names to use in the shader
  61794. */
  61795. samplerNames?: Array<string>;
  61796. /**
  61797. * Defines to use in the shader
  61798. */
  61799. defines?: Array<string>;
  61800. /**
  61801. * Callback when effect is compiled
  61802. */
  61803. onCompiled?: Nullable<(effect: Effect) => void>;
  61804. /**
  61805. * The friendly name of the effect displayed in Spector.
  61806. */
  61807. name?: string;
  61808. }
  61809. /**
  61810. * Wraps an effect to be used for rendering
  61811. */
  61812. export class EffectWrapper {
  61813. /**
  61814. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  61815. */
  61816. onApplyObservable: Observable<{}>;
  61817. /**
  61818. * The underlying effect
  61819. */
  61820. effect: Effect;
  61821. /**
  61822. * Creates an effect to be renderer
  61823. * @param creationOptions options to create the effect
  61824. */
  61825. constructor(creationOptions: EffectWrapperCreationOptions);
  61826. /**
  61827. * Disposes of the effect wrapper
  61828. */
  61829. dispose(): void;
  61830. }
  61831. }
  61832. declare module BABYLON {
  61833. /** @hidden */
  61834. export var hdrFilteringVertexShader: {
  61835. name: string;
  61836. shader: string;
  61837. };
  61838. }
  61839. declare module BABYLON {
  61840. /** @hidden */
  61841. export var hdrFilteringPixelShader: {
  61842. name: string;
  61843. shader: string;
  61844. };
  61845. }
  61846. declare module BABYLON {
  61847. /**
  61848. * Options for texture filtering
  61849. */
  61850. interface IHDRFilteringOptions {
  61851. /**
  61852. * Scales pixel intensity for the input HDR map.
  61853. */
  61854. hdrScale?: number;
  61855. /**
  61856. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  61857. */
  61858. quality?: number;
  61859. }
  61860. /**
  61861. * Filters HDR maps to get correct renderings of PBR reflections
  61862. */
  61863. export class HDRFiltering {
  61864. private _engine;
  61865. private _effectRenderer;
  61866. private _effectWrapper;
  61867. private _lodGenerationOffset;
  61868. private _lodGenerationScale;
  61869. /**
  61870. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  61871. * you care about baking speed.
  61872. */
  61873. quality: number;
  61874. /**
  61875. * Scales pixel intensity for the input HDR map.
  61876. */
  61877. hdrScale: number;
  61878. /**
  61879. * Instantiates HDR filter for reflection maps
  61880. *
  61881. * @param engine Thin engine
  61882. * @param options Options
  61883. */
  61884. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  61885. private _createRenderTarget;
  61886. private _prefilterInternal;
  61887. private _createEffect;
  61888. /**
  61889. * Get a value indicating if the filter is ready to be used
  61890. * @param texture Texture to filter
  61891. * @returns true if the filter is ready
  61892. */
  61893. isReady(texture: BaseTexture): boolean;
  61894. /**
  61895. * Prefilters a cube texture to have mipmap levels representing roughness values.
  61896. * Prefiltering will be invoked at the end of next rendering pass.
  61897. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  61898. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  61899. * @param texture Texture to filter
  61900. * @param onFinished Callback when filtering is done
  61901. * @return Promise called when prefiltering is done
  61902. */
  61903. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  61904. }
  61905. }
  61906. declare module BABYLON {
  61907. /**
  61908. * This represents a texture coming from an HDR input.
  61909. *
  61910. * The only supported format is currently panorama picture stored in RGBE format.
  61911. * Example of such files can be found on HDRLib: http://hdrlib.com/
  61912. */
  61913. export class HDRCubeTexture extends BaseTexture {
  61914. private static _facesMapping;
  61915. private _generateHarmonics;
  61916. private _noMipmap;
  61917. private _prefilterOnLoad;
  61918. private _textureMatrix;
  61919. private _size;
  61920. private _onLoad;
  61921. private _onError;
  61922. /**
  61923. * The texture URL.
  61924. */
  61925. url: string;
  61926. protected _isBlocking: boolean;
  61927. /**
  61928. * Sets wether or not the texture is blocking during loading.
  61929. */
  61930. set isBlocking(value: boolean);
  61931. /**
  61932. * Gets wether or not the texture is blocking during loading.
  61933. */
  61934. get isBlocking(): boolean;
  61935. protected _rotationY: number;
  61936. /**
  61937. * Sets texture matrix rotation angle around Y axis in radians.
  61938. */
  61939. set rotationY(value: number);
  61940. /**
  61941. * Gets texture matrix rotation angle around Y axis radians.
  61942. */
  61943. get rotationY(): number;
  61944. /**
  61945. * Gets or sets the center of the bounding box associated with the cube texture
  61946. * It must define where the camera used to render the texture was set
  61947. */
  61948. boundingBoxPosition: Vector3;
  61949. private _boundingBoxSize;
  61950. /**
  61951. * Gets or sets the size of the bounding box associated with the cube texture
  61952. * When defined, the cubemap will switch to local mode
  61953. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  61954. * @example https://www.babylonjs-playground.com/#RNASML
  61955. */
  61956. set boundingBoxSize(value: Vector3);
  61957. get boundingBoxSize(): Vector3;
  61958. /**
  61959. * Instantiates an HDRTexture from the following parameters.
  61960. *
  61961. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  61962. * @param sceneOrEngine The scene or engine the texture will be used in
  61963. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  61964. * @param noMipmap Forces to not generate the mipmap if true
  61965. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  61966. * @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)
  61967. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  61968. */
  61969. constructor(url: string, sceneOrEngine: Scene | ThinEngine, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, prefilterOnLoad?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  61970. /**
  61971. * Get the current class name of the texture useful for serialization or dynamic coding.
  61972. * @returns "HDRCubeTexture"
  61973. */
  61974. getClassName(): string;
  61975. /**
  61976. * Occurs when the file is raw .hdr file.
  61977. */
  61978. private loadTexture;
  61979. clone(): HDRCubeTexture;
  61980. delayLoad(): void;
  61981. /**
  61982. * Get the texture reflection matrix used to rotate/transform the reflection.
  61983. * @returns the reflection matrix
  61984. */
  61985. getReflectionTextureMatrix(): Matrix;
  61986. /**
  61987. * Set the texture reflection matrix used to rotate/transform the reflection.
  61988. * @param value Define the reflection matrix to set
  61989. */
  61990. setReflectionTextureMatrix(value: Matrix): void;
  61991. /**
  61992. * Parses a JSON representation of an HDR Texture in order to create the texture
  61993. * @param parsedTexture Define the JSON representation
  61994. * @param scene Define the scene the texture should be created in
  61995. * @param rootUrl Define the root url in case we need to load relative dependencies
  61996. * @returns the newly created texture after parsing
  61997. */
  61998. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  61999. serialize(): any;
  62000. }
  62001. }
  62002. declare module BABYLON {
  62003. /**
  62004. * Class used to control physics engine
  62005. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  62006. */
  62007. export class PhysicsEngine implements IPhysicsEngine {
  62008. private _physicsPlugin;
  62009. /**
  62010. * Global value used to control the smallest number supported by the simulation
  62011. */
  62012. static Epsilon: number;
  62013. private _impostors;
  62014. private _joints;
  62015. private _subTimeStep;
  62016. /**
  62017. * Gets the gravity vector used by the simulation
  62018. */
  62019. gravity: Vector3;
  62020. /**
  62021. * Factory used to create the default physics plugin.
  62022. * @returns The default physics plugin
  62023. */
  62024. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  62025. /**
  62026. * Creates a new Physics Engine
  62027. * @param gravity defines the gravity vector used by the simulation
  62028. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  62029. */
  62030. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  62031. /**
  62032. * Sets the gravity vector used by the simulation
  62033. * @param gravity defines the gravity vector to use
  62034. */
  62035. setGravity(gravity: Vector3): void;
  62036. /**
  62037. * Set the time step of the physics engine.
  62038. * Default is 1/60.
  62039. * To slow it down, enter 1/600 for example.
  62040. * To speed it up, 1/30
  62041. * @param newTimeStep defines the new timestep to apply to this world.
  62042. */
  62043. setTimeStep(newTimeStep?: number): void;
  62044. /**
  62045. * Get the time step of the physics engine.
  62046. * @returns the current time step
  62047. */
  62048. getTimeStep(): number;
  62049. /**
  62050. * Set the sub time step of the physics engine.
  62051. * Default is 0 meaning there is no sub steps
  62052. * To increase physics resolution precision, set a small value (like 1 ms)
  62053. * @param subTimeStep defines the new sub timestep used for physics resolution.
  62054. */
  62055. setSubTimeStep(subTimeStep?: number): void;
  62056. /**
  62057. * Get the sub time step of the physics engine.
  62058. * @returns the current sub time step
  62059. */
  62060. getSubTimeStep(): number;
  62061. /**
  62062. * Release all resources
  62063. */
  62064. dispose(): void;
  62065. /**
  62066. * Gets the name of the current physics plugin
  62067. * @returns the name of the plugin
  62068. */
  62069. getPhysicsPluginName(): string;
  62070. /**
  62071. * Adding a new impostor for the impostor tracking.
  62072. * This will be done by the impostor itself.
  62073. * @param impostor the impostor to add
  62074. */
  62075. addImpostor(impostor: PhysicsImpostor): void;
  62076. /**
  62077. * Remove an impostor from the engine.
  62078. * This impostor and its mesh will not longer be updated by the physics engine.
  62079. * @param impostor the impostor to remove
  62080. */
  62081. removeImpostor(impostor: PhysicsImpostor): void;
  62082. /**
  62083. * Add a joint to the physics engine
  62084. * @param mainImpostor defines the main impostor to which the joint is added.
  62085. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  62086. * @param joint defines the joint that will connect both impostors.
  62087. */
  62088. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  62089. /**
  62090. * Removes a joint from the simulation
  62091. * @param mainImpostor defines the impostor used with the joint
  62092. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  62093. * @param joint defines the joint to remove
  62094. */
  62095. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  62096. /**
  62097. * Called by the scene. No need to call it.
  62098. * @param delta defines the timespam between frames
  62099. */
  62100. _step(delta: number): void;
  62101. /**
  62102. * Gets the current plugin used to run the simulation
  62103. * @returns current plugin
  62104. */
  62105. getPhysicsPlugin(): IPhysicsEnginePlugin;
  62106. /**
  62107. * Gets the list of physic impostors
  62108. * @returns an array of PhysicsImpostor
  62109. */
  62110. getImpostors(): Array<PhysicsImpostor>;
  62111. /**
  62112. * Gets the impostor for a physics enabled object
  62113. * @param object defines the object impersonated by the impostor
  62114. * @returns the PhysicsImpostor or null if not found
  62115. */
  62116. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  62117. /**
  62118. * Gets the impostor for a physics body object
  62119. * @param body defines physics body used by the impostor
  62120. * @returns the PhysicsImpostor or null if not found
  62121. */
  62122. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  62123. /**
  62124. * Does a raycast in the physics world
  62125. * @param from when should the ray start?
  62126. * @param to when should the ray end?
  62127. * @returns PhysicsRaycastResult
  62128. */
  62129. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  62130. }
  62131. }
  62132. declare module BABYLON {
  62133. /** @hidden */
  62134. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  62135. private _useDeltaForWorldStep;
  62136. world: any;
  62137. name: string;
  62138. private _physicsMaterials;
  62139. private _fixedTimeStep;
  62140. private _cannonRaycastResult;
  62141. private _raycastResult;
  62142. private _physicsBodysToRemoveAfterStep;
  62143. private _firstFrame;
  62144. BJSCANNON: any;
  62145. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  62146. setGravity(gravity: Vector3): void;
  62147. setTimeStep(timeStep: number): void;
  62148. getTimeStep(): number;
  62149. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  62150. private _removeMarkedPhysicsBodiesFromWorld;
  62151. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62152. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62153. generatePhysicsBody(impostor: PhysicsImpostor): void;
  62154. private _processChildMeshes;
  62155. removePhysicsBody(impostor: PhysicsImpostor): void;
  62156. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  62157. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  62158. private _addMaterial;
  62159. private _checkWithEpsilon;
  62160. private _createShape;
  62161. private _createHeightmap;
  62162. private _minus90X;
  62163. private _plus90X;
  62164. private _tmpPosition;
  62165. private _tmpDeltaPosition;
  62166. private _tmpUnityRotation;
  62167. private _updatePhysicsBodyTransformation;
  62168. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  62169. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  62170. isSupported(): boolean;
  62171. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62172. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62173. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62174. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62175. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  62176. getBodyMass(impostor: PhysicsImpostor): number;
  62177. getBodyFriction(impostor: PhysicsImpostor): number;
  62178. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  62179. getBodyRestitution(impostor: PhysicsImpostor): number;
  62180. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  62181. sleepBody(impostor: PhysicsImpostor): void;
  62182. wakeUpBody(impostor: PhysicsImpostor): void;
  62183. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  62184. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  62185. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  62186. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  62187. getRadius(impostor: PhysicsImpostor): number;
  62188. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  62189. dispose(): void;
  62190. private _extendNamespace;
  62191. /**
  62192. * Does a raycast in the physics world
  62193. * @param from when should the ray start?
  62194. * @param to when should the ray end?
  62195. * @returns PhysicsRaycastResult
  62196. */
  62197. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  62198. }
  62199. }
  62200. declare module BABYLON {
  62201. /** @hidden */
  62202. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  62203. private _useDeltaForWorldStep;
  62204. world: any;
  62205. name: string;
  62206. BJSOIMO: any;
  62207. private _raycastResult;
  62208. private _fixedTimeStep;
  62209. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  62210. setGravity(gravity: Vector3): void;
  62211. setTimeStep(timeStep: number): void;
  62212. getTimeStep(): number;
  62213. private _tmpImpostorsArray;
  62214. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  62215. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62216. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62217. generatePhysicsBody(impostor: PhysicsImpostor): void;
  62218. private _tmpPositionVector;
  62219. removePhysicsBody(impostor: PhysicsImpostor): void;
  62220. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  62221. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  62222. isSupported(): boolean;
  62223. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  62224. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  62225. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62226. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62227. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62228. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62229. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  62230. getBodyMass(impostor: PhysicsImpostor): number;
  62231. getBodyFriction(impostor: PhysicsImpostor): number;
  62232. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  62233. getBodyRestitution(impostor: PhysicsImpostor): number;
  62234. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  62235. sleepBody(impostor: PhysicsImpostor): void;
  62236. wakeUpBody(impostor: PhysicsImpostor): void;
  62237. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  62238. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  62239. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  62240. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  62241. getRadius(impostor: PhysicsImpostor): number;
  62242. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  62243. dispose(): void;
  62244. /**
  62245. * Does a raycast in the physics world
  62246. * @param from when should the ray start?
  62247. * @param to when should the ray end?
  62248. * @returns PhysicsRaycastResult
  62249. */
  62250. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  62251. }
  62252. }
  62253. declare module BABYLON {
  62254. /**
  62255. * AmmoJS Physics plugin
  62256. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  62257. * @see https://github.com/kripken/ammo.js/
  62258. */
  62259. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  62260. private _useDeltaForWorldStep;
  62261. /**
  62262. * Reference to the Ammo library
  62263. */
  62264. bjsAMMO: any;
  62265. /**
  62266. * Created ammoJS world which physics bodies are added to
  62267. */
  62268. world: any;
  62269. /**
  62270. * Name of the plugin
  62271. */
  62272. name: string;
  62273. private _timeStep;
  62274. private _fixedTimeStep;
  62275. private _maxSteps;
  62276. private _tmpQuaternion;
  62277. private _tmpAmmoTransform;
  62278. private _tmpAmmoQuaternion;
  62279. private _tmpAmmoConcreteContactResultCallback;
  62280. private _collisionConfiguration;
  62281. private _dispatcher;
  62282. private _overlappingPairCache;
  62283. private _solver;
  62284. private _softBodySolver;
  62285. private _tmpAmmoVectorA;
  62286. private _tmpAmmoVectorB;
  62287. private _tmpAmmoVectorC;
  62288. private _tmpAmmoVectorD;
  62289. private _tmpContactCallbackResult;
  62290. private _tmpAmmoVectorRCA;
  62291. private _tmpAmmoVectorRCB;
  62292. private _raycastResult;
  62293. private _tmpContactPoint;
  62294. private static readonly DISABLE_COLLISION_FLAG;
  62295. private static readonly KINEMATIC_FLAG;
  62296. private static readonly DISABLE_DEACTIVATION_FLAG;
  62297. /**
  62298. * Initializes the ammoJS plugin
  62299. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  62300. * @param ammoInjection can be used to inject your own ammo reference
  62301. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  62302. */
  62303. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  62304. /**
  62305. * Sets the gravity of the physics world (m/(s^2))
  62306. * @param gravity Gravity to set
  62307. */
  62308. setGravity(gravity: Vector3): void;
  62309. /**
  62310. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  62311. * @param timeStep timestep to use in seconds
  62312. */
  62313. setTimeStep(timeStep: number): void;
  62314. /**
  62315. * 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)
  62316. * @param fixedTimeStep fixedTimeStep to use in seconds
  62317. */
  62318. setFixedTimeStep(fixedTimeStep: number): void;
  62319. /**
  62320. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  62321. * @param maxSteps the maximum number of steps by the physics engine per frame
  62322. */
  62323. setMaxSteps(maxSteps: number): void;
  62324. /**
  62325. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  62326. * @returns the current timestep in seconds
  62327. */
  62328. getTimeStep(): number;
  62329. /**
  62330. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  62331. */
  62332. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  62333. private _isImpostorInContact;
  62334. private _isImpostorPairInContact;
  62335. private _stepSimulation;
  62336. /**
  62337. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  62338. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  62339. * After the step the babylon meshes are set to the position of the physics imposters
  62340. * @param delta amount of time to step forward
  62341. * @param impostors array of imposters to update before/after the step
  62342. */
  62343. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  62344. /**
  62345. * Update babylon mesh to match physics world object
  62346. * @param impostor imposter to match
  62347. */
  62348. private _afterSoftStep;
  62349. /**
  62350. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  62351. * @param impostor imposter to match
  62352. */
  62353. private _ropeStep;
  62354. /**
  62355. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  62356. * @param impostor imposter to match
  62357. */
  62358. private _softbodyOrClothStep;
  62359. private _tmpMatrix;
  62360. /**
  62361. * Applies an impulse on the imposter
  62362. * @param impostor imposter to apply impulse to
  62363. * @param force amount of force to be applied to the imposter
  62364. * @param contactPoint the location to apply the impulse on the imposter
  62365. */
  62366. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62367. /**
  62368. * Applies a force on the imposter
  62369. * @param impostor imposter to apply force
  62370. * @param force amount of force to be applied to the imposter
  62371. * @param contactPoint the location to apply the force on the imposter
  62372. */
  62373. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  62374. /**
  62375. * Creates a physics body using the plugin
  62376. * @param impostor the imposter to create the physics body on
  62377. */
  62378. generatePhysicsBody(impostor: PhysicsImpostor): void;
  62379. /**
  62380. * Removes the physics body from the imposter and disposes of the body's memory
  62381. * @param impostor imposter to remove the physics body from
  62382. */
  62383. removePhysicsBody(impostor: PhysicsImpostor): void;
  62384. /**
  62385. * Generates a joint
  62386. * @param impostorJoint the imposter joint to create the joint with
  62387. */
  62388. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  62389. /**
  62390. * Removes a joint
  62391. * @param impostorJoint the imposter joint to remove the joint from
  62392. */
  62393. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  62394. private _addMeshVerts;
  62395. /**
  62396. * Initialise the soft body vertices to match its object's (mesh) vertices
  62397. * Softbody vertices (nodes) are in world space and to match this
  62398. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  62399. * @param impostor to create the softbody for
  62400. */
  62401. private _softVertexData;
  62402. /**
  62403. * Create an impostor's soft body
  62404. * @param impostor to create the softbody for
  62405. */
  62406. private _createSoftbody;
  62407. /**
  62408. * Create cloth for an impostor
  62409. * @param impostor to create the softbody for
  62410. */
  62411. private _createCloth;
  62412. /**
  62413. * Create rope for an impostor
  62414. * @param impostor to create the softbody for
  62415. */
  62416. private _createRope;
  62417. /**
  62418. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  62419. * @param impostor to create the custom physics shape for
  62420. */
  62421. private _createCustom;
  62422. private _addHullVerts;
  62423. private _createShape;
  62424. /**
  62425. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  62426. * @param impostor imposter containing the physics body and babylon object
  62427. */
  62428. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  62429. /**
  62430. * Sets the babylon object's position/rotation from the physics body's position/rotation
  62431. * @param impostor imposter containing the physics body and babylon object
  62432. * @param newPosition new position
  62433. * @param newRotation new rotation
  62434. */
  62435. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  62436. /**
  62437. * If this plugin is supported
  62438. * @returns true if its supported
  62439. */
  62440. isSupported(): boolean;
  62441. /**
  62442. * Sets the linear velocity of the physics body
  62443. * @param impostor imposter to set the velocity on
  62444. * @param velocity velocity to set
  62445. */
  62446. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62447. /**
  62448. * Sets the angular velocity of the physics body
  62449. * @param impostor imposter to set the velocity on
  62450. * @param velocity velocity to set
  62451. */
  62452. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  62453. /**
  62454. * gets the linear velocity
  62455. * @param impostor imposter to get linear velocity from
  62456. * @returns linear velocity
  62457. */
  62458. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62459. /**
  62460. * gets the angular velocity
  62461. * @param impostor imposter to get angular velocity from
  62462. * @returns angular velocity
  62463. */
  62464. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  62465. /**
  62466. * Sets the mass of physics body
  62467. * @param impostor imposter to set the mass on
  62468. * @param mass mass to set
  62469. */
  62470. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  62471. /**
  62472. * Gets the mass of the physics body
  62473. * @param impostor imposter to get the mass from
  62474. * @returns mass
  62475. */
  62476. getBodyMass(impostor: PhysicsImpostor): number;
  62477. /**
  62478. * Gets friction of the impostor
  62479. * @param impostor impostor to get friction from
  62480. * @returns friction value
  62481. */
  62482. getBodyFriction(impostor: PhysicsImpostor): number;
  62483. /**
  62484. * Sets friction of the impostor
  62485. * @param impostor impostor to set friction on
  62486. * @param friction friction value
  62487. */
  62488. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  62489. /**
  62490. * Gets restitution of the impostor
  62491. * @param impostor impostor to get restitution from
  62492. * @returns restitution value
  62493. */
  62494. getBodyRestitution(impostor: PhysicsImpostor): number;
  62495. /**
  62496. * Sets resitution of the impostor
  62497. * @param impostor impostor to set resitution on
  62498. * @param restitution resitution value
  62499. */
  62500. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  62501. /**
  62502. * Gets pressure inside the impostor
  62503. * @param impostor impostor to get pressure from
  62504. * @returns pressure value
  62505. */
  62506. getBodyPressure(impostor: PhysicsImpostor): number;
  62507. /**
  62508. * Sets pressure inside a soft body impostor
  62509. * Cloth and rope must remain 0 pressure
  62510. * @param impostor impostor to set pressure on
  62511. * @param pressure pressure value
  62512. */
  62513. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  62514. /**
  62515. * Gets stiffness of the impostor
  62516. * @param impostor impostor to get stiffness from
  62517. * @returns pressure value
  62518. */
  62519. getBodyStiffness(impostor: PhysicsImpostor): number;
  62520. /**
  62521. * Sets stiffness of the impostor
  62522. * @param impostor impostor to set stiffness on
  62523. * @param stiffness stiffness value from 0 to 1
  62524. */
  62525. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  62526. /**
  62527. * Gets velocityIterations of the impostor
  62528. * @param impostor impostor to get velocity iterations from
  62529. * @returns velocityIterations value
  62530. */
  62531. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  62532. /**
  62533. * Sets velocityIterations of the impostor
  62534. * @param impostor impostor to set velocity iterations on
  62535. * @param velocityIterations velocityIterations value
  62536. */
  62537. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  62538. /**
  62539. * Gets positionIterations of the impostor
  62540. * @param impostor impostor to get position iterations from
  62541. * @returns positionIterations value
  62542. */
  62543. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  62544. /**
  62545. * Sets positionIterations of the impostor
  62546. * @param impostor impostor to set position on
  62547. * @param positionIterations positionIterations value
  62548. */
  62549. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  62550. /**
  62551. * Append an anchor to a cloth object
  62552. * @param impostor is the cloth impostor to add anchor to
  62553. * @param otherImpostor is the rigid impostor to anchor to
  62554. * @param width ratio across width from 0 to 1
  62555. * @param height ratio up height from 0 to 1
  62556. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  62557. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  62558. */
  62559. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  62560. /**
  62561. * Append an hook to a rope object
  62562. * @param impostor is the rope impostor to add hook to
  62563. * @param otherImpostor is the rigid impostor to hook to
  62564. * @param length ratio along the rope from 0 to 1
  62565. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  62566. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  62567. */
  62568. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  62569. /**
  62570. * Sleeps the physics body and stops it from being active
  62571. * @param impostor impostor to sleep
  62572. */
  62573. sleepBody(impostor: PhysicsImpostor): void;
  62574. /**
  62575. * Activates the physics body
  62576. * @param impostor impostor to activate
  62577. */
  62578. wakeUpBody(impostor: PhysicsImpostor): void;
  62579. /**
  62580. * Updates the distance parameters of the joint
  62581. * @param joint joint to update
  62582. * @param maxDistance maximum distance of the joint
  62583. * @param minDistance minimum distance of the joint
  62584. */
  62585. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  62586. /**
  62587. * Sets a motor on the joint
  62588. * @param joint joint to set motor on
  62589. * @param speed speed of the motor
  62590. * @param maxForce maximum force of the motor
  62591. * @param motorIndex index of the motor
  62592. */
  62593. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  62594. /**
  62595. * Sets the motors limit
  62596. * @param joint joint to set limit on
  62597. * @param upperLimit upper limit
  62598. * @param lowerLimit lower limit
  62599. */
  62600. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  62601. /**
  62602. * Syncs the position and rotation of a mesh with the impostor
  62603. * @param mesh mesh to sync
  62604. * @param impostor impostor to update the mesh with
  62605. */
  62606. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  62607. /**
  62608. * Gets the radius of the impostor
  62609. * @param impostor impostor to get radius from
  62610. * @returns the radius
  62611. */
  62612. getRadius(impostor: PhysicsImpostor): number;
  62613. /**
  62614. * Gets the box size of the impostor
  62615. * @param impostor impostor to get box size from
  62616. * @param result the resulting box size
  62617. */
  62618. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  62619. /**
  62620. * Disposes of the impostor
  62621. */
  62622. dispose(): void;
  62623. /**
  62624. * Does a raycast in the physics world
  62625. * @param from when should the ray start?
  62626. * @param to when should the ray end?
  62627. * @returns PhysicsRaycastResult
  62628. */
  62629. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  62630. }
  62631. }
  62632. declare module BABYLON {
  62633. interface AbstractScene {
  62634. /**
  62635. * The list of reflection probes added to the scene
  62636. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  62637. */
  62638. reflectionProbes: Array<ReflectionProbe>;
  62639. /**
  62640. * Removes the given reflection probe from this scene.
  62641. * @param toRemove The reflection probe to remove
  62642. * @returns The index of the removed reflection probe
  62643. */
  62644. removeReflectionProbe(toRemove: ReflectionProbe): number;
  62645. /**
  62646. * Adds the given reflection probe to this scene.
  62647. * @param newReflectionProbe The reflection probe to add
  62648. */
  62649. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  62650. }
  62651. /**
  62652. * Class used to generate realtime reflection / refraction cube textures
  62653. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  62654. */
  62655. export class ReflectionProbe {
  62656. /** defines the name of the probe */
  62657. name: string;
  62658. private _scene;
  62659. private _renderTargetTexture;
  62660. private _projectionMatrix;
  62661. private _viewMatrix;
  62662. private _target;
  62663. private _add;
  62664. private _attachedMesh;
  62665. private _invertYAxis;
  62666. /** Gets or sets probe position (center of the cube map) */
  62667. position: Vector3;
  62668. /**
  62669. * Creates a new reflection probe
  62670. * @param name defines the name of the probe
  62671. * @param size defines the texture resolution (for each face)
  62672. * @param scene defines the hosting scene
  62673. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  62674. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  62675. */
  62676. constructor(
  62677. /** defines the name of the probe */
  62678. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  62679. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  62680. get samples(): number;
  62681. set samples(value: number);
  62682. /** Gets or sets the refresh rate to use (on every frame by default) */
  62683. get refreshRate(): number;
  62684. set refreshRate(value: number);
  62685. /**
  62686. * Gets the hosting scene
  62687. * @returns a Scene
  62688. */
  62689. getScene(): Scene;
  62690. /** Gets the internal CubeTexture used to render to */
  62691. get cubeTexture(): RenderTargetTexture;
  62692. /** Gets the list of meshes to render */
  62693. get renderList(): Nullable<AbstractMesh[]>;
  62694. /**
  62695. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  62696. * @param mesh defines the mesh to attach to
  62697. */
  62698. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  62699. /**
  62700. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  62701. * @param renderingGroupId The rendering group id corresponding to its index
  62702. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  62703. */
  62704. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  62705. /**
  62706. * Clean all associated resources
  62707. */
  62708. dispose(): void;
  62709. /**
  62710. * Converts the reflection probe information to a readable string for debug purpose.
  62711. * @param fullDetails Supports for multiple levels of logging within scene loading
  62712. * @returns the human readable reflection probe info
  62713. */
  62714. toString(fullDetails?: boolean): string;
  62715. /**
  62716. * Get the class name of the relfection probe.
  62717. * @returns "ReflectionProbe"
  62718. */
  62719. getClassName(): string;
  62720. /**
  62721. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  62722. * @returns The JSON representation of the texture
  62723. */
  62724. serialize(): any;
  62725. /**
  62726. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  62727. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  62728. * @param scene Define the scene the parsed reflection probe should be instantiated in
  62729. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  62730. * @returns The parsed reflection probe if successful
  62731. */
  62732. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  62733. }
  62734. }
  62735. declare module BABYLON {
  62736. /** @hidden */
  62737. export var _BabylonLoaderRegistered: boolean;
  62738. /**
  62739. * Helps setting up some configuration for the babylon file loader.
  62740. */
  62741. export class BabylonFileLoaderConfiguration {
  62742. /**
  62743. * The loader does not allow injecting custom physix engine into the plugins.
  62744. * Unfortunately in ES6, we need to manually inject them into the plugin.
  62745. * So you could set this variable to your engine import to make it work.
  62746. */
  62747. static LoaderInjectedPhysicsEngine: any;
  62748. }
  62749. }
  62750. declare module BABYLON {
  62751. /**
  62752. * The Physically based simple base material of BJS.
  62753. *
  62754. * This enables better naming and convention enforcements on top of the pbrMaterial.
  62755. * It is used as the base class for both the specGloss and metalRough conventions.
  62756. */
  62757. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  62758. /**
  62759. * Number of Simultaneous lights allowed on the material.
  62760. */
  62761. maxSimultaneousLights: number;
  62762. /**
  62763. * If sets to true, disables all the lights affecting the material.
  62764. */
  62765. disableLighting: boolean;
  62766. /**
  62767. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  62768. */
  62769. environmentTexture: BaseTexture;
  62770. /**
  62771. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  62772. */
  62773. invertNormalMapX: boolean;
  62774. /**
  62775. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  62776. */
  62777. invertNormalMapY: boolean;
  62778. /**
  62779. * Normal map used in the model.
  62780. */
  62781. normalTexture: BaseTexture;
  62782. /**
  62783. * Emissivie color used to self-illuminate the model.
  62784. */
  62785. emissiveColor: Color3;
  62786. /**
  62787. * Emissivie texture used to self-illuminate the model.
  62788. */
  62789. emissiveTexture: BaseTexture;
  62790. /**
  62791. * Occlusion Channel Strenght.
  62792. */
  62793. occlusionStrength: number;
  62794. /**
  62795. * Occlusion Texture of the material (adding extra occlusion effects).
  62796. */
  62797. occlusionTexture: BaseTexture;
  62798. /**
  62799. * Defines the alpha limits in alpha test mode.
  62800. */
  62801. alphaCutOff: number;
  62802. /**
  62803. * Gets the current double sided mode.
  62804. */
  62805. get doubleSided(): boolean;
  62806. /**
  62807. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  62808. */
  62809. set doubleSided(value: boolean);
  62810. /**
  62811. * Stores the pre-calculated light information of a mesh in a texture.
  62812. */
  62813. lightmapTexture: BaseTexture;
  62814. /**
  62815. * If true, the light map contains occlusion information instead of lighting info.
  62816. */
  62817. useLightmapAsShadowmap: boolean;
  62818. /**
  62819. * Instantiates a new PBRMaterial instance.
  62820. *
  62821. * @param name The material name
  62822. * @param scene The scene the material will be use in.
  62823. */
  62824. constructor(name: string, scene: Scene);
  62825. getClassName(): string;
  62826. }
  62827. }
  62828. declare module BABYLON {
  62829. /**
  62830. * The PBR material of BJS following the metal roughness convention.
  62831. *
  62832. * This fits to the PBR convention in the GLTF definition:
  62833. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  62834. */
  62835. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  62836. /**
  62837. * The base color has two different interpretations depending on the value of metalness.
  62838. * When the material is a metal, the base color is the specific measured reflectance value
  62839. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  62840. * of the material.
  62841. */
  62842. baseColor: Color3;
  62843. /**
  62844. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  62845. * well as opacity information in the alpha channel.
  62846. */
  62847. baseTexture: BaseTexture;
  62848. /**
  62849. * Specifies the metallic scalar value of the material.
  62850. * Can also be used to scale the metalness values of the metallic texture.
  62851. */
  62852. metallic: number;
  62853. /**
  62854. * Specifies the roughness scalar value of the material.
  62855. * Can also be used to scale the roughness values of the metallic texture.
  62856. */
  62857. roughness: number;
  62858. /**
  62859. * Texture containing both the metallic value in the B channel and the
  62860. * roughness value in the G channel to keep better precision.
  62861. */
  62862. metallicRoughnessTexture: BaseTexture;
  62863. /**
  62864. * Instantiates a new PBRMetalRoughnessMaterial instance.
  62865. *
  62866. * @param name The material name
  62867. * @param scene The scene the material will be use in.
  62868. */
  62869. constructor(name: string, scene: Scene);
  62870. /**
  62871. * Return the currrent class name of the material.
  62872. */
  62873. getClassName(): string;
  62874. /**
  62875. * Makes a duplicate of the current material.
  62876. * @param name - name to use for the new material.
  62877. */
  62878. clone(name: string): PBRMetallicRoughnessMaterial;
  62879. /**
  62880. * Serialize the material to a parsable JSON object.
  62881. */
  62882. serialize(): any;
  62883. /**
  62884. * Parses a JSON object correponding to the serialize function.
  62885. */
  62886. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  62887. }
  62888. }
  62889. declare module BABYLON {
  62890. /**
  62891. * The PBR material of BJS following the specular glossiness convention.
  62892. *
  62893. * This fits to the PBR convention in the GLTF definition:
  62894. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  62895. */
  62896. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  62897. /**
  62898. * Specifies the diffuse color of the material.
  62899. */
  62900. diffuseColor: Color3;
  62901. /**
  62902. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  62903. * channel.
  62904. */
  62905. diffuseTexture: BaseTexture;
  62906. /**
  62907. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  62908. */
  62909. specularColor: Color3;
  62910. /**
  62911. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  62912. */
  62913. glossiness: number;
  62914. /**
  62915. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  62916. */
  62917. specularGlossinessTexture: BaseTexture;
  62918. /**
  62919. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  62920. *
  62921. * @param name The material name
  62922. * @param scene The scene the material will be use in.
  62923. */
  62924. constructor(name: string, scene: Scene);
  62925. /**
  62926. * Return the currrent class name of the material.
  62927. */
  62928. getClassName(): string;
  62929. /**
  62930. * Makes a duplicate of the current material.
  62931. * @param name - name to use for the new material.
  62932. */
  62933. clone(name: string): PBRSpecularGlossinessMaterial;
  62934. /**
  62935. * Serialize the material to a parsable JSON object.
  62936. */
  62937. serialize(): any;
  62938. /**
  62939. * Parses a JSON object correponding to the serialize function.
  62940. */
  62941. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  62942. }
  62943. }
  62944. declare module BABYLON {
  62945. /**
  62946. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  62947. * It can help converting any input color in a desired output one. This can then be used to create effects
  62948. * from sepia, black and white to sixties or futuristic rendering...
  62949. *
  62950. * The only supported format is currently 3dl.
  62951. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  62952. */
  62953. export class ColorGradingTexture extends BaseTexture {
  62954. /**
  62955. * The texture URL.
  62956. */
  62957. url: string;
  62958. /**
  62959. * Empty line regex stored for GC.
  62960. */
  62961. private static _noneEmptyLineRegex;
  62962. private _textureMatrix;
  62963. private _onLoad;
  62964. /**
  62965. * Instantiates a ColorGradingTexture from the following parameters.
  62966. *
  62967. * @param url The location of the color gradind data (currently only supporting 3dl)
  62968. * @param sceneOrEngine The scene or engine the texture will be used in
  62969. * @param onLoad defines a callback triggered when the texture has been loaded
  62970. */
  62971. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  62972. /**
  62973. * Fires the onload event from the constructor if requested.
  62974. */
  62975. private _triggerOnLoad;
  62976. /**
  62977. * Returns the texture matrix used in most of the material.
  62978. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  62979. */
  62980. getTextureMatrix(): Matrix;
  62981. /**
  62982. * Occurs when the file being loaded is a .3dl LUT file.
  62983. */
  62984. private load3dlTexture;
  62985. /**
  62986. * Starts the loading process of the texture.
  62987. */
  62988. private loadTexture;
  62989. /**
  62990. * Clones the color gradind texture.
  62991. */
  62992. clone(): ColorGradingTexture;
  62993. /**
  62994. * Called during delayed load for textures.
  62995. */
  62996. delayLoad(): void;
  62997. /**
  62998. * Parses a color grading texture serialized by Babylon.
  62999. * @param parsedTexture The texture information being parsedTexture
  63000. * @param scene The scene to load the texture in
  63001. * @param rootUrl The root url of the data assets to load
  63002. * @return A color gradind texture
  63003. */
  63004. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  63005. /**
  63006. * Serializes the LUT texture to json format.
  63007. */
  63008. serialize(): any;
  63009. }
  63010. }
  63011. declare module BABYLON {
  63012. /**
  63013. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  63014. */
  63015. export class EquiRectangularCubeTexture extends BaseTexture {
  63016. /** The six faces of the cube. */
  63017. private static _FacesMapping;
  63018. private _noMipmap;
  63019. private _onLoad;
  63020. private _onError;
  63021. /** The size of the cubemap. */
  63022. private _size;
  63023. /** The buffer of the image. */
  63024. private _buffer;
  63025. /** The width of the input image. */
  63026. private _width;
  63027. /** The height of the input image. */
  63028. private _height;
  63029. /** The URL to the image. */
  63030. url: string;
  63031. /**
  63032. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  63033. * @param url The location of the image
  63034. * @param scene The scene the texture will be used in
  63035. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  63036. * @param noMipmap Forces to not generate the mipmap if true
  63037. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  63038. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  63039. * @param onLoad — defines a callback called when texture is loaded
  63040. * @param onError — defines a callback called if there is an error
  63041. */
  63042. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  63043. /**
  63044. * Load the image data, by putting the image on a canvas and extracting its buffer.
  63045. */
  63046. private loadImage;
  63047. /**
  63048. * Convert the image buffer into a cubemap and create a CubeTexture.
  63049. */
  63050. private loadTexture;
  63051. /**
  63052. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  63053. * @param buffer The ArrayBuffer that should be converted.
  63054. * @returns The buffer as Float32Array.
  63055. */
  63056. private getFloat32ArrayFromArrayBuffer;
  63057. /**
  63058. * Get the current class name of the texture useful for serialization or dynamic coding.
  63059. * @returns "EquiRectangularCubeTexture"
  63060. */
  63061. getClassName(): string;
  63062. /**
  63063. * Create a clone of the current EquiRectangularCubeTexture and return it.
  63064. * @returns A clone of the current EquiRectangularCubeTexture.
  63065. */
  63066. clone(): EquiRectangularCubeTexture;
  63067. }
  63068. }
  63069. declare module BABYLON {
  63070. /**
  63071. * Defines the options related to the creation of an HtmlElementTexture
  63072. */
  63073. export interface IHtmlElementTextureOptions {
  63074. /**
  63075. * Defines wether mip maps should be created or not.
  63076. */
  63077. generateMipMaps?: boolean;
  63078. /**
  63079. * Defines the sampling mode of the texture.
  63080. */
  63081. samplingMode?: number;
  63082. /**
  63083. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  63084. */
  63085. engine: Nullable<ThinEngine>;
  63086. /**
  63087. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  63088. */
  63089. scene: Nullable<Scene>;
  63090. }
  63091. /**
  63092. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  63093. * To be as efficient as possible depending on your constraints nothing aside the first upload
  63094. * is automatically managed.
  63095. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  63096. * in your application.
  63097. *
  63098. * As the update is not automatic, you need to call them manually.
  63099. */
  63100. export class HtmlElementTexture extends BaseTexture {
  63101. /**
  63102. * The texture URL.
  63103. */
  63104. element: HTMLVideoElement | HTMLCanvasElement;
  63105. private static readonly DefaultOptions;
  63106. private _textureMatrix;
  63107. private _isVideo;
  63108. private _generateMipMaps;
  63109. private _samplingMode;
  63110. /**
  63111. * Instantiates a HtmlElementTexture from the following parameters.
  63112. *
  63113. * @param name Defines the name of the texture
  63114. * @param element Defines the video or canvas the texture is filled with
  63115. * @param options Defines the other none mandatory texture creation options
  63116. */
  63117. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  63118. private _createInternalTexture;
  63119. /**
  63120. * Returns the texture matrix used in most of the material.
  63121. */
  63122. getTextureMatrix(): Matrix;
  63123. /**
  63124. * Updates the content of the texture.
  63125. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  63126. */
  63127. update(invertY?: Nullable<boolean>): void;
  63128. }
  63129. }
  63130. declare module BABYLON {
  63131. /**
  63132. * Based on jsTGALoader - Javascript loader for TGA file
  63133. * By Vincent Thibault
  63134. * @see http://blog.robrowser.com/javascript-tga-loader.html
  63135. */
  63136. export class TGATools {
  63137. private static _TYPE_INDEXED;
  63138. private static _TYPE_RGB;
  63139. private static _TYPE_GREY;
  63140. private static _TYPE_RLE_INDEXED;
  63141. private static _TYPE_RLE_RGB;
  63142. private static _TYPE_RLE_GREY;
  63143. private static _ORIGIN_MASK;
  63144. private static _ORIGIN_SHIFT;
  63145. private static _ORIGIN_BL;
  63146. private static _ORIGIN_BR;
  63147. private static _ORIGIN_UL;
  63148. private static _ORIGIN_UR;
  63149. /**
  63150. * Gets the header of a TGA file
  63151. * @param data defines the TGA data
  63152. * @returns the header
  63153. */
  63154. static GetTGAHeader(data: Uint8Array): any;
  63155. /**
  63156. * Uploads TGA content to a Babylon Texture
  63157. * @hidden
  63158. */
  63159. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  63160. /** @hidden */
  63161. 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;
  63162. /** @hidden */
  63163. 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;
  63164. /** @hidden */
  63165. 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;
  63166. /** @hidden */
  63167. 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;
  63168. /** @hidden */
  63169. 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;
  63170. /** @hidden */
  63171. 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;
  63172. }
  63173. }
  63174. declare module BABYLON {
  63175. /**
  63176. * Implementation of the TGA Texture Loader.
  63177. * @hidden
  63178. */
  63179. export class _TGATextureLoader implements IInternalTextureLoader {
  63180. /**
  63181. * Defines wether the loader supports cascade loading the different faces.
  63182. */
  63183. readonly supportCascades: boolean;
  63184. /**
  63185. * This returns if the loader support the current file information.
  63186. * @param extension defines the file extension of the file being loaded
  63187. * @returns true if the loader can load the specified file
  63188. */
  63189. canLoad(extension: string): boolean;
  63190. /**
  63191. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  63192. * @param data contains the texture data
  63193. * @param texture defines the BabylonJS internal texture
  63194. * @param createPolynomials will be true if polynomials have been requested
  63195. * @param onLoad defines the callback to trigger once the texture is ready
  63196. * @param onError defines the callback to trigger in case of error
  63197. */
  63198. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  63199. /**
  63200. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  63201. * @param data contains the texture data
  63202. * @param texture defines the BabylonJS internal texture
  63203. * @param callback defines the method to call once ready to upload
  63204. */
  63205. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  63206. }
  63207. }
  63208. declare module BABYLON {
  63209. /**
  63210. * Info about the .basis files
  63211. */
  63212. class BasisFileInfo {
  63213. /**
  63214. * If the file has alpha
  63215. */
  63216. hasAlpha: boolean;
  63217. /**
  63218. * Info about each image of the basis file
  63219. */
  63220. images: Array<{
  63221. levels: Array<{
  63222. width: number;
  63223. height: number;
  63224. transcodedPixels: ArrayBufferView;
  63225. }>;
  63226. }>;
  63227. }
  63228. /**
  63229. * Result of transcoding a basis file
  63230. */
  63231. class TranscodeResult {
  63232. /**
  63233. * Info about the .basis file
  63234. */
  63235. fileInfo: BasisFileInfo;
  63236. /**
  63237. * Format to use when loading the file
  63238. */
  63239. format: number;
  63240. }
  63241. /**
  63242. * Configuration options for the Basis transcoder
  63243. */
  63244. export class BasisTranscodeConfiguration {
  63245. /**
  63246. * Supported compression formats used to determine the supported output format of the transcoder
  63247. */
  63248. supportedCompressionFormats?: {
  63249. /**
  63250. * etc1 compression format
  63251. */
  63252. etc1?: boolean;
  63253. /**
  63254. * s3tc compression format
  63255. */
  63256. s3tc?: boolean;
  63257. /**
  63258. * pvrtc compression format
  63259. */
  63260. pvrtc?: boolean;
  63261. /**
  63262. * etc2 compression format
  63263. */
  63264. etc2?: boolean;
  63265. };
  63266. /**
  63267. * If mipmap levels should be loaded for transcoded images (Default: true)
  63268. */
  63269. loadMipmapLevels?: boolean;
  63270. /**
  63271. * Index of a single image to load (Default: all images)
  63272. */
  63273. loadSingleImage?: number;
  63274. }
  63275. /**
  63276. * Used to load .Basis files
  63277. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  63278. */
  63279. export class BasisTools {
  63280. private static _IgnoreSupportedFormats;
  63281. /**
  63282. * URL to use when loading the basis transcoder
  63283. */
  63284. static JSModuleURL: string;
  63285. /**
  63286. * URL to use when loading the wasm module for the transcoder
  63287. */
  63288. static WasmModuleURL: string;
  63289. /**
  63290. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  63291. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  63292. * @returns internal format corresponding to the Basis format
  63293. */
  63294. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  63295. private static _WorkerPromise;
  63296. private static _Worker;
  63297. private static _actionId;
  63298. private static _CreateWorkerAsync;
  63299. /**
  63300. * Transcodes a loaded image file to compressed pixel data
  63301. * @param data image data to transcode
  63302. * @param config configuration options for the transcoding
  63303. * @returns a promise resulting in the transcoded image
  63304. */
  63305. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  63306. /**
  63307. * Loads a texture from the transcode result
  63308. * @param texture texture load to
  63309. * @param transcodeResult the result of transcoding the basis file to load from
  63310. */
  63311. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  63312. }
  63313. }
  63314. declare module BABYLON {
  63315. /**
  63316. * Loader for .basis file format
  63317. */
  63318. export class _BasisTextureLoader implements IInternalTextureLoader {
  63319. /**
  63320. * Defines whether the loader supports cascade loading the different faces.
  63321. */
  63322. readonly supportCascades: boolean;
  63323. /**
  63324. * This returns if the loader support the current file information.
  63325. * @param extension defines the file extension of the file being loaded
  63326. * @returns true if the loader can load the specified file
  63327. */
  63328. canLoad(extension: string): boolean;
  63329. /**
  63330. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  63331. * @param data contains the texture data
  63332. * @param texture defines the BabylonJS internal texture
  63333. * @param createPolynomials will be true if polynomials have been requested
  63334. * @param onLoad defines the callback to trigger once the texture is ready
  63335. * @param onError defines the callback to trigger in case of error
  63336. */
  63337. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  63338. /**
  63339. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  63340. * @param data contains the texture data
  63341. * @param texture defines the BabylonJS internal texture
  63342. * @param callback defines the method to call once ready to upload
  63343. */
  63344. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  63345. }
  63346. }
  63347. declare module BABYLON {
  63348. /**
  63349. * Defines the basic options interface of a TexturePacker Frame
  63350. */
  63351. export interface ITexturePackerFrame {
  63352. /**
  63353. * The frame ID
  63354. */
  63355. id: number;
  63356. /**
  63357. * The frames Scale
  63358. */
  63359. scale: Vector2;
  63360. /**
  63361. * The Frames offset
  63362. */
  63363. offset: Vector2;
  63364. }
  63365. /**
  63366. * This is a support class for frame Data on texture packer sets.
  63367. */
  63368. export class TexturePackerFrame implements ITexturePackerFrame {
  63369. /**
  63370. * The frame ID
  63371. */
  63372. id: number;
  63373. /**
  63374. * The frames Scale
  63375. */
  63376. scale: Vector2;
  63377. /**
  63378. * The Frames offset
  63379. */
  63380. offset: Vector2;
  63381. /**
  63382. * Initializes a texture package frame.
  63383. * @param id The numerical frame identifier
  63384. * @param scale Scalar Vector2 for UV frame
  63385. * @param offset Vector2 for the frame position in UV units.
  63386. * @returns TexturePackerFrame
  63387. */
  63388. constructor(id: number, scale: Vector2, offset: Vector2);
  63389. }
  63390. }
  63391. declare module BABYLON {
  63392. /**
  63393. * Defines the basic options interface of a TexturePacker
  63394. */
  63395. export interface ITexturePackerOptions {
  63396. /**
  63397. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  63398. */
  63399. map?: string[];
  63400. /**
  63401. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  63402. */
  63403. uvsIn?: string;
  63404. /**
  63405. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  63406. */
  63407. uvsOut?: string;
  63408. /**
  63409. * number representing the layout style. Defaults to LAYOUT_STRIP
  63410. */
  63411. layout?: number;
  63412. /**
  63413. * number of columns if using custom column count layout(2). This defaults to 4.
  63414. */
  63415. colnum?: number;
  63416. /**
  63417. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  63418. */
  63419. updateInputMeshes?: boolean;
  63420. /**
  63421. * boolean flag to dispose all the source textures. Defaults to true.
  63422. */
  63423. disposeSources?: boolean;
  63424. /**
  63425. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  63426. */
  63427. fillBlanks?: boolean;
  63428. /**
  63429. * string value representing the context fill style color. Defaults to 'black'.
  63430. */
  63431. customFillColor?: string;
  63432. /**
  63433. * Width and Height Value of each Frame in the TexturePacker Sets
  63434. */
  63435. frameSize?: number;
  63436. /**
  63437. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  63438. */
  63439. paddingRatio?: number;
  63440. /**
  63441. * Number that declares the fill method for the padding gutter.
  63442. */
  63443. paddingMode?: number;
  63444. /**
  63445. * If in SUBUV_COLOR padding mode what color to use.
  63446. */
  63447. paddingColor?: Color3 | Color4;
  63448. }
  63449. /**
  63450. * Defines the basic interface of a TexturePacker JSON File
  63451. */
  63452. export interface ITexturePackerJSON {
  63453. /**
  63454. * The frame ID
  63455. */
  63456. name: string;
  63457. /**
  63458. * The base64 channel data
  63459. */
  63460. sets: any;
  63461. /**
  63462. * The options of the Packer
  63463. */
  63464. options: ITexturePackerOptions;
  63465. /**
  63466. * The frame data of the Packer
  63467. */
  63468. frames: Array<number>;
  63469. }
  63470. /**
  63471. * This is a support class that generates a series of packed texture sets.
  63472. * @see https://doc.babylonjs.com/babylon101/materials
  63473. */
  63474. export class TexturePacker {
  63475. /** Packer Layout Constant 0 */
  63476. static readonly LAYOUT_STRIP: number;
  63477. /** Packer Layout Constant 1 */
  63478. static readonly LAYOUT_POWER2: number;
  63479. /** Packer Layout Constant 2 */
  63480. static readonly LAYOUT_COLNUM: number;
  63481. /** Packer Layout Constant 0 */
  63482. static readonly SUBUV_WRAP: number;
  63483. /** Packer Layout Constant 1 */
  63484. static readonly SUBUV_EXTEND: number;
  63485. /** Packer Layout Constant 2 */
  63486. static readonly SUBUV_COLOR: number;
  63487. /** The Name of the Texture Package */
  63488. name: string;
  63489. /** The scene scope of the TexturePacker */
  63490. scene: Scene;
  63491. /** The Meshes to target */
  63492. meshes: AbstractMesh[];
  63493. /** Arguments passed with the Constructor */
  63494. options: ITexturePackerOptions;
  63495. /** The promise that is started upon initialization */
  63496. promise: Nullable<Promise<TexturePacker | string>>;
  63497. /** The Container object for the channel sets that are generated */
  63498. sets: object;
  63499. /** The Container array for the frames that are generated */
  63500. frames: TexturePackerFrame[];
  63501. /** The expected number of textures the system is parsing. */
  63502. private _expecting;
  63503. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  63504. private _paddingValue;
  63505. /**
  63506. * Initializes a texture package series from an array of meshes or a single mesh.
  63507. * @param name The name of the package
  63508. * @param meshes The target meshes to compose the package from
  63509. * @param options The arguments that texture packer should follow while building.
  63510. * @param scene The scene which the textures are scoped to.
  63511. * @returns TexturePacker
  63512. */
  63513. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  63514. /**
  63515. * Starts the package process
  63516. * @param resolve The promises resolution function
  63517. * @returns TexturePacker
  63518. */
  63519. private _createFrames;
  63520. /**
  63521. * Calculates the Size of the Channel Sets
  63522. * @returns Vector2
  63523. */
  63524. private _calculateSize;
  63525. /**
  63526. * Calculates the UV data for the frames.
  63527. * @param baseSize the base frameSize
  63528. * @param padding the base frame padding
  63529. * @param dtSize size of the Dynamic Texture for that channel
  63530. * @param dtUnits is 1/dtSize
  63531. * @param update flag to update the input meshes
  63532. */
  63533. private _calculateMeshUVFrames;
  63534. /**
  63535. * Calculates the frames Offset.
  63536. * @param index of the frame
  63537. * @returns Vector2
  63538. */
  63539. private _getFrameOffset;
  63540. /**
  63541. * Updates a Mesh to the frame data
  63542. * @param mesh that is the target
  63543. * @param frameID or the frame index
  63544. */
  63545. private _updateMeshUV;
  63546. /**
  63547. * Updates a Meshes materials to use the texture packer channels
  63548. * @param m is the mesh to target
  63549. * @param force all channels on the packer to be set.
  63550. */
  63551. private _updateTextureReferences;
  63552. /**
  63553. * Public method to set a Mesh to a frame
  63554. * @param m that is the target
  63555. * @param frameID or the frame index
  63556. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  63557. */
  63558. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  63559. /**
  63560. * Starts the async promise to compile the texture packer.
  63561. * @returns Promise<void>
  63562. */
  63563. processAsync(): Promise<void>;
  63564. /**
  63565. * Disposes all textures associated with this packer
  63566. */
  63567. dispose(): void;
  63568. /**
  63569. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  63570. * @param imageType is the image type to use.
  63571. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  63572. */
  63573. download(imageType?: string, quality?: number): void;
  63574. /**
  63575. * Public method to load a texturePacker JSON file.
  63576. * @param data of the JSON file in string format.
  63577. */
  63578. updateFromJSON(data: string): void;
  63579. }
  63580. }
  63581. declare module BABYLON {
  63582. /**
  63583. * 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.
  63584. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  63585. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  63586. */
  63587. export class CustomProceduralTexture extends ProceduralTexture {
  63588. private _animate;
  63589. private _time;
  63590. private _config;
  63591. private _texturePath;
  63592. /**
  63593. * Instantiates a new Custom Procedural Texture.
  63594. * 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.
  63595. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  63596. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  63597. * @param name Define the name of the texture
  63598. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  63599. * @param size Define the size of the texture to create
  63600. * @param scene Define the scene the texture belongs to
  63601. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  63602. * @param generateMipMaps Define if the texture should creates mip maps or not
  63603. */
  63604. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  63605. private _loadJson;
  63606. /**
  63607. * Is the texture ready to be used ? (rendered at least once)
  63608. * @returns true if ready, otherwise, false.
  63609. */
  63610. isReady(): boolean;
  63611. /**
  63612. * Render the texture to its associated render target.
  63613. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  63614. */
  63615. render(useCameraPostProcess?: boolean): void;
  63616. /**
  63617. * Update the list of dependant textures samplers in the shader.
  63618. */
  63619. updateTextures(): void;
  63620. /**
  63621. * Update the uniform values of the procedural texture in the shader.
  63622. */
  63623. updateShaderUniforms(): void;
  63624. /**
  63625. * Define if the texture animates or not.
  63626. */
  63627. get animate(): boolean;
  63628. set animate(value: boolean);
  63629. }
  63630. }
  63631. declare module BABYLON {
  63632. /** @hidden */
  63633. export var noisePixelShader: {
  63634. name: string;
  63635. shader: string;
  63636. };
  63637. }
  63638. declare module BABYLON {
  63639. /**
  63640. * Class used to generate noise procedural textures
  63641. */
  63642. export class NoiseProceduralTexture extends ProceduralTexture {
  63643. /** Gets or sets the start time (default is 0) */
  63644. time: number;
  63645. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  63646. brightness: number;
  63647. /** Defines the number of octaves to process */
  63648. octaves: number;
  63649. /** Defines the level of persistence (0.8 by default) */
  63650. persistence: number;
  63651. /** Gets or sets animation speed factor (default is 1) */
  63652. animationSpeedFactor: number;
  63653. /**
  63654. * Creates a new NoiseProceduralTexture
  63655. * @param name defines the name fo the texture
  63656. * @param size defines the size of the texture (default is 256)
  63657. * @param scene defines the hosting scene
  63658. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  63659. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  63660. */
  63661. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  63662. private _updateShaderUniforms;
  63663. protected _getDefines(): string;
  63664. /** Generate the current state of the procedural texture */
  63665. render(useCameraPostProcess?: boolean): void;
  63666. /**
  63667. * Serializes this noise procedural texture
  63668. * @returns a serialized noise procedural texture object
  63669. */
  63670. serialize(): any;
  63671. /**
  63672. * Clone the texture.
  63673. * @returns the cloned texture
  63674. */
  63675. clone(): NoiseProceduralTexture;
  63676. /**
  63677. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  63678. * @param parsedTexture defines parsed texture data
  63679. * @param scene defines the current scene
  63680. * @param rootUrl defines the root URL containing noise procedural texture information
  63681. * @returns a parsed NoiseProceduralTexture
  63682. */
  63683. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  63684. }
  63685. }
  63686. declare module BABYLON {
  63687. /**
  63688. * Raw cube texture where the raw buffers are passed in
  63689. */
  63690. export class RawCubeTexture extends CubeTexture {
  63691. /**
  63692. * Creates a cube texture where the raw buffers are passed in.
  63693. * @param scene defines the scene the texture is attached to
  63694. * @param data defines the array of data to use to create each face
  63695. * @param size defines the size of the textures
  63696. * @param format defines the format of the data
  63697. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  63698. * @param generateMipMaps defines if the engine should generate the mip levels
  63699. * @param invertY defines if data must be stored with Y axis inverted
  63700. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  63701. * @param compression defines the compression used (null by default)
  63702. */
  63703. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  63704. /**
  63705. * Updates the raw cube texture.
  63706. * @param data defines the data to store
  63707. * @param format defines the data format
  63708. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  63709. * @param invertY defines if data must be stored with Y axis inverted
  63710. * @param compression defines the compression used (null by default)
  63711. * @param level defines which level of the texture to update
  63712. */
  63713. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  63714. /**
  63715. * Updates a raw cube texture with RGBD encoded data.
  63716. * @param data defines the array of data [mipmap][face] to use to create each face
  63717. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  63718. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  63719. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  63720. * @returns a promsie that resolves when the operation is complete
  63721. */
  63722. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  63723. /**
  63724. * Clones the raw cube texture.
  63725. * @return a new cube texture
  63726. */
  63727. clone(): CubeTexture;
  63728. /** @hidden */
  63729. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  63730. }
  63731. }
  63732. declare module BABYLON {
  63733. /**
  63734. * Class used to store 2D array textures containing user data
  63735. */
  63736. export class RawTexture2DArray extends Texture {
  63737. /** Gets or sets the texture format to use */
  63738. format: number;
  63739. /**
  63740. * Create a new RawTexture2DArray
  63741. * @param data defines the data of the texture
  63742. * @param width defines the width of the texture
  63743. * @param height defines the height of the texture
  63744. * @param depth defines the number of layers of the texture
  63745. * @param format defines the texture format to use
  63746. * @param scene defines the hosting scene
  63747. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  63748. * @param invertY defines if texture must be stored with Y axis inverted
  63749. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  63750. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  63751. */
  63752. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  63753. /** Gets or sets the texture format to use */
  63754. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  63755. /**
  63756. * Update the texture with new data
  63757. * @param data defines the data to store in the texture
  63758. */
  63759. update(data: ArrayBufferView): void;
  63760. }
  63761. }
  63762. declare module BABYLON {
  63763. /**
  63764. * Class used to store 3D textures containing user data
  63765. */
  63766. export class RawTexture3D extends Texture {
  63767. /** Gets or sets the texture format to use */
  63768. format: number;
  63769. /**
  63770. * Create a new RawTexture3D
  63771. * @param data defines the data of the texture
  63772. * @param width defines the width of the texture
  63773. * @param height defines the height of the texture
  63774. * @param depth defines the depth of the texture
  63775. * @param format defines the texture format to use
  63776. * @param scene defines the hosting scene
  63777. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  63778. * @param invertY defines if texture must be stored with Y axis inverted
  63779. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  63780. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  63781. */
  63782. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  63783. /** Gets or sets the texture format to use */
  63784. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  63785. /**
  63786. * Update the texture with new data
  63787. * @param data defines the data to store in the texture
  63788. */
  63789. update(data: ArrayBufferView): void;
  63790. }
  63791. }
  63792. declare module BABYLON {
  63793. /**
  63794. * Creates a refraction texture used by refraction channel of the standard material.
  63795. * It is like a mirror but to see through a material.
  63796. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  63797. */
  63798. export class RefractionTexture extends RenderTargetTexture {
  63799. /**
  63800. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  63801. * 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.
  63802. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  63803. */
  63804. refractionPlane: Plane;
  63805. /**
  63806. * Define how deep under the surface we should see.
  63807. */
  63808. depth: number;
  63809. /**
  63810. * Creates a refraction texture used by refraction channel of the standard material.
  63811. * It is like a mirror but to see through a material.
  63812. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  63813. * @param name Define the texture name
  63814. * @param size Define the size of the underlying texture
  63815. * @param scene Define the scene the refraction belongs to
  63816. * @param generateMipMaps Define if we need to generate mips level for the refraction
  63817. */
  63818. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  63819. /**
  63820. * Clone the refraction texture.
  63821. * @returns the cloned texture
  63822. */
  63823. clone(): RefractionTexture;
  63824. /**
  63825. * Serialize the texture to a JSON representation you could use in Parse later on
  63826. * @returns the serialized JSON representation
  63827. */
  63828. serialize(): any;
  63829. }
  63830. }
  63831. declare module BABYLON {
  63832. /**
  63833. * Block used to add support for vertex skinning (bones)
  63834. */
  63835. export class BonesBlock extends NodeMaterialBlock {
  63836. /**
  63837. * Creates a new BonesBlock
  63838. * @param name defines the block name
  63839. */
  63840. constructor(name: string);
  63841. /**
  63842. * Initialize the block and prepare the context for build
  63843. * @param state defines the state that will be used for the build
  63844. */
  63845. initialize(state: NodeMaterialBuildState): void;
  63846. /**
  63847. * Gets the current class name
  63848. * @returns the class name
  63849. */
  63850. getClassName(): string;
  63851. /**
  63852. * Gets the matrix indices input component
  63853. */
  63854. get matricesIndices(): NodeMaterialConnectionPoint;
  63855. /**
  63856. * Gets the matrix weights input component
  63857. */
  63858. get matricesWeights(): NodeMaterialConnectionPoint;
  63859. /**
  63860. * Gets the extra matrix indices input component
  63861. */
  63862. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  63863. /**
  63864. * Gets the extra matrix weights input component
  63865. */
  63866. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  63867. /**
  63868. * Gets the world input component
  63869. */
  63870. get world(): NodeMaterialConnectionPoint;
  63871. /**
  63872. * Gets the output component
  63873. */
  63874. get output(): NodeMaterialConnectionPoint;
  63875. autoConfigure(material: NodeMaterial): void;
  63876. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  63877. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  63878. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  63879. protected _buildBlock(state: NodeMaterialBuildState): this;
  63880. }
  63881. }
  63882. declare module BABYLON {
  63883. /**
  63884. * Block used to add support for instances
  63885. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  63886. */
  63887. export class InstancesBlock extends NodeMaterialBlock {
  63888. /**
  63889. * Creates a new InstancesBlock
  63890. * @param name defines the block name
  63891. */
  63892. constructor(name: string);
  63893. /**
  63894. * Gets the current class name
  63895. * @returns the class name
  63896. */
  63897. getClassName(): string;
  63898. /**
  63899. * Gets the first world row input component
  63900. */
  63901. get world0(): NodeMaterialConnectionPoint;
  63902. /**
  63903. * Gets the second world row input component
  63904. */
  63905. get world1(): NodeMaterialConnectionPoint;
  63906. /**
  63907. * Gets the third world row input component
  63908. */
  63909. get world2(): NodeMaterialConnectionPoint;
  63910. /**
  63911. * Gets the forth world row input component
  63912. */
  63913. get world3(): NodeMaterialConnectionPoint;
  63914. /**
  63915. * Gets the world input component
  63916. */
  63917. get world(): NodeMaterialConnectionPoint;
  63918. /**
  63919. * Gets the output component
  63920. */
  63921. get output(): NodeMaterialConnectionPoint;
  63922. /**
  63923. * Gets the isntanceID component
  63924. */
  63925. get instanceID(): NodeMaterialConnectionPoint;
  63926. autoConfigure(material: NodeMaterial): void;
  63927. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  63928. protected _buildBlock(state: NodeMaterialBuildState): this;
  63929. }
  63930. }
  63931. declare module BABYLON {
  63932. /**
  63933. * Block used to add morph targets support to vertex shader
  63934. */
  63935. export class MorphTargetsBlock extends NodeMaterialBlock {
  63936. private _repeatableContentAnchor;
  63937. /**
  63938. * Create a new MorphTargetsBlock
  63939. * @param name defines the block name
  63940. */
  63941. constructor(name: string);
  63942. /**
  63943. * Gets the current class name
  63944. * @returns the class name
  63945. */
  63946. getClassName(): string;
  63947. /**
  63948. * Gets the position input component
  63949. */
  63950. get position(): NodeMaterialConnectionPoint;
  63951. /**
  63952. * Gets the normal input component
  63953. */
  63954. get normal(): NodeMaterialConnectionPoint;
  63955. /**
  63956. * Gets the tangent input component
  63957. */
  63958. get tangent(): NodeMaterialConnectionPoint;
  63959. /**
  63960. * Gets the tangent input component
  63961. */
  63962. get uv(): NodeMaterialConnectionPoint;
  63963. /**
  63964. * Gets the position output component
  63965. */
  63966. get positionOutput(): NodeMaterialConnectionPoint;
  63967. /**
  63968. * Gets the normal output component
  63969. */
  63970. get normalOutput(): NodeMaterialConnectionPoint;
  63971. /**
  63972. * Gets the tangent output component
  63973. */
  63974. get tangentOutput(): NodeMaterialConnectionPoint;
  63975. /**
  63976. * Gets the tangent output component
  63977. */
  63978. get uvOutput(): NodeMaterialConnectionPoint;
  63979. initialize(state: NodeMaterialBuildState): void;
  63980. autoConfigure(material: NodeMaterial): void;
  63981. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  63982. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  63983. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  63984. protected _buildBlock(state: NodeMaterialBuildState): this;
  63985. }
  63986. }
  63987. declare module BABYLON {
  63988. /**
  63989. * Block used to get data information from a light
  63990. */
  63991. export class LightInformationBlock extends NodeMaterialBlock {
  63992. private _lightDataUniformName;
  63993. private _lightColorUniformName;
  63994. private _lightTypeDefineName;
  63995. /**
  63996. * Gets or sets the light associated with this block
  63997. */
  63998. light: Nullable<Light>;
  63999. /**
  64000. * Creates a new LightInformationBlock
  64001. * @param name defines the block name
  64002. */
  64003. constructor(name: string);
  64004. /**
  64005. * Gets the current class name
  64006. * @returns the class name
  64007. */
  64008. getClassName(): string;
  64009. /**
  64010. * Gets the world position input component
  64011. */
  64012. get worldPosition(): NodeMaterialConnectionPoint;
  64013. /**
  64014. * Gets the direction output component
  64015. */
  64016. get direction(): NodeMaterialConnectionPoint;
  64017. /**
  64018. * Gets the direction output component
  64019. */
  64020. get color(): NodeMaterialConnectionPoint;
  64021. /**
  64022. * Gets the direction output component
  64023. */
  64024. get intensity(): NodeMaterialConnectionPoint;
  64025. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64026. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64027. protected _buildBlock(state: NodeMaterialBuildState): this;
  64028. serialize(): any;
  64029. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  64030. }
  64031. }
  64032. declare module BABYLON {
  64033. /**
  64034. * Block used to add image processing support to fragment shader
  64035. */
  64036. export class ImageProcessingBlock extends NodeMaterialBlock {
  64037. /**
  64038. * Create a new ImageProcessingBlock
  64039. * @param name defines the block name
  64040. */
  64041. constructor(name: string);
  64042. /**
  64043. * Gets the current class name
  64044. * @returns the class name
  64045. */
  64046. getClassName(): string;
  64047. /**
  64048. * Gets the color input component
  64049. */
  64050. get color(): NodeMaterialConnectionPoint;
  64051. /**
  64052. * Gets the output component
  64053. */
  64054. get output(): NodeMaterialConnectionPoint;
  64055. /**
  64056. * Initialize the block and prepare the context for build
  64057. * @param state defines the state that will be used for the build
  64058. */
  64059. initialize(state: NodeMaterialBuildState): void;
  64060. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  64061. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64062. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64063. protected _buildBlock(state: NodeMaterialBuildState): this;
  64064. }
  64065. }
  64066. declare module BABYLON {
  64067. /**
  64068. * Block used to pertub normals based on a normal map
  64069. */
  64070. export class PerturbNormalBlock extends NodeMaterialBlock {
  64071. private _tangentSpaceParameterName;
  64072. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  64073. invertX: boolean;
  64074. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  64075. invertY: boolean;
  64076. /**
  64077. * Create a new PerturbNormalBlock
  64078. * @param name defines the block name
  64079. */
  64080. constructor(name: string);
  64081. /**
  64082. * Gets the current class name
  64083. * @returns the class name
  64084. */
  64085. getClassName(): string;
  64086. /**
  64087. * Gets the world position input component
  64088. */
  64089. get worldPosition(): NodeMaterialConnectionPoint;
  64090. /**
  64091. * Gets the world normal input component
  64092. */
  64093. get worldNormal(): NodeMaterialConnectionPoint;
  64094. /**
  64095. * Gets the world tangent input component
  64096. */
  64097. get worldTangent(): NodeMaterialConnectionPoint;
  64098. /**
  64099. * Gets the uv input component
  64100. */
  64101. get uv(): NodeMaterialConnectionPoint;
  64102. /**
  64103. * Gets the normal map color input component
  64104. */
  64105. get normalMapColor(): NodeMaterialConnectionPoint;
  64106. /**
  64107. * Gets the strength input component
  64108. */
  64109. get strength(): NodeMaterialConnectionPoint;
  64110. /**
  64111. * Gets the output component
  64112. */
  64113. get output(): NodeMaterialConnectionPoint;
  64114. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64115. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64116. autoConfigure(material: NodeMaterial): void;
  64117. protected _buildBlock(state: NodeMaterialBuildState): this;
  64118. protected _dumpPropertiesCode(): string;
  64119. serialize(): any;
  64120. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  64121. }
  64122. }
  64123. declare module BABYLON {
  64124. /**
  64125. * Block used to discard a pixel if a value is smaller than a cutoff
  64126. */
  64127. export class DiscardBlock extends NodeMaterialBlock {
  64128. /**
  64129. * Create a new DiscardBlock
  64130. * @param name defines the block name
  64131. */
  64132. constructor(name: string);
  64133. /**
  64134. * Gets the current class name
  64135. * @returns the class name
  64136. */
  64137. getClassName(): string;
  64138. /**
  64139. * Gets the color input component
  64140. */
  64141. get value(): NodeMaterialConnectionPoint;
  64142. /**
  64143. * Gets the cutoff input component
  64144. */
  64145. get cutoff(): NodeMaterialConnectionPoint;
  64146. protected _buildBlock(state: NodeMaterialBuildState): this;
  64147. }
  64148. }
  64149. declare module BABYLON {
  64150. /**
  64151. * Block used to test if the fragment shader is front facing
  64152. */
  64153. export class FrontFacingBlock extends NodeMaterialBlock {
  64154. /**
  64155. * Creates a new FrontFacingBlock
  64156. * @param name defines the block name
  64157. */
  64158. constructor(name: string);
  64159. /**
  64160. * Gets the current class name
  64161. * @returns the class name
  64162. */
  64163. getClassName(): string;
  64164. /**
  64165. * Gets the output component
  64166. */
  64167. get output(): NodeMaterialConnectionPoint;
  64168. protected _buildBlock(state: NodeMaterialBuildState): this;
  64169. }
  64170. }
  64171. declare module BABYLON {
  64172. /**
  64173. * Block used to get the derivative value on x and y of a given input
  64174. */
  64175. export class DerivativeBlock extends NodeMaterialBlock {
  64176. /**
  64177. * Create a new DerivativeBlock
  64178. * @param name defines the block name
  64179. */
  64180. constructor(name: string);
  64181. /**
  64182. * Gets the current class name
  64183. * @returns the class name
  64184. */
  64185. getClassName(): string;
  64186. /**
  64187. * Gets the input component
  64188. */
  64189. get input(): NodeMaterialConnectionPoint;
  64190. /**
  64191. * Gets the derivative output on x
  64192. */
  64193. get dx(): NodeMaterialConnectionPoint;
  64194. /**
  64195. * Gets the derivative output on y
  64196. */
  64197. get dy(): NodeMaterialConnectionPoint;
  64198. protected _buildBlock(state: NodeMaterialBuildState): this;
  64199. }
  64200. }
  64201. declare module BABYLON {
  64202. /**
  64203. * Block used to make gl_FragCoord available
  64204. */
  64205. export class FragCoordBlock extends NodeMaterialBlock {
  64206. /**
  64207. * Creates a new FragCoordBlock
  64208. * @param name defines the block name
  64209. */
  64210. constructor(name: string);
  64211. /**
  64212. * Gets the current class name
  64213. * @returns the class name
  64214. */
  64215. getClassName(): string;
  64216. /**
  64217. * Gets the xy component
  64218. */
  64219. get xy(): NodeMaterialConnectionPoint;
  64220. /**
  64221. * Gets the xyz component
  64222. */
  64223. get xyz(): NodeMaterialConnectionPoint;
  64224. /**
  64225. * Gets the xyzw component
  64226. */
  64227. get xyzw(): NodeMaterialConnectionPoint;
  64228. /**
  64229. * Gets the x component
  64230. */
  64231. get x(): NodeMaterialConnectionPoint;
  64232. /**
  64233. * Gets the y component
  64234. */
  64235. get y(): NodeMaterialConnectionPoint;
  64236. /**
  64237. * Gets the z component
  64238. */
  64239. get z(): NodeMaterialConnectionPoint;
  64240. /**
  64241. * Gets the w component
  64242. */
  64243. get output(): NodeMaterialConnectionPoint;
  64244. protected writeOutputs(state: NodeMaterialBuildState): string;
  64245. protected _buildBlock(state: NodeMaterialBuildState): this;
  64246. }
  64247. }
  64248. declare module BABYLON {
  64249. /**
  64250. * Block used to get the screen sizes
  64251. */
  64252. export class ScreenSizeBlock extends NodeMaterialBlock {
  64253. private _varName;
  64254. private _scene;
  64255. /**
  64256. * Creates a new ScreenSizeBlock
  64257. * @param name defines the block name
  64258. */
  64259. constructor(name: string);
  64260. /**
  64261. * Gets the current class name
  64262. * @returns the class name
  64263. */
  64264. getClassName(): string;
  64265. /**
  64266. * Gets the xy component
  64267. */
  64268. get xy(): NodeMaterialConnectionPoint;
  64269. /**
  64270. * Gets the x component
  64271. */
  64272. get x(): NodeMaterialConnectionPoint;
  64273. /**
  64274. * Gets the y component
  64275. */
  64276. get y(): NodeMaterialConnectionPoint;
  64277. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64278. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  64279. protected _buildBlock(state: NodeMaterialBuildState): this;
  64280. }
  64281. }
  64282. declare module BABYLON {
  64283. /**
  64284. * Block used to add support for scene fog
  64285. */
  64286. export class FogBlock extends NodeMaterialBlock {
  64287. private _fogDistanceName;
  64288. private _fogParameters;
  64289. /**
  64290. * Create a new FogBlock
  64291. * @param name defines the block name
  64292. */
  64293. constructor(name: string);
  64294. /**
  64295. * Gets the current class name
  64296. * @returns the class name
  64297. */
  64298. getClassName(): string;
  64299. /**
  64300. * Gets the world position input component
  64301. */
  64302. get worldPosition(): NodeMaterialConnectionPoint;
  64303. /**
  64304. * Gets the view input component
  64305. */
  64306. get view(): NodeMaterialConnectionPoint;
  64307. /**
  64308. * Gets the color input component
  64309. */
  64310. get input(): NodeMaterialConnectionPoint;
  64311. /**
  64312. * Gets the fog color input component
  64313. */
  64314. get fogColor(): NodeMaterialConnectionPoint;
  64315. /**
  64316. * Gets the output component
  64317. */
  64318. get output(): NodeMaterialConnectionPoint;
  64319. autoConfigure(material: NodeMaterial): void;
  64320. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64321. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64322. protected _buildBlock(state: NodeMaterialBuildState): this;
  64323. }
  64324. }
  64325. declare module BABYLON {
  64326. /**
  64327. * Block used to add light in the fragment shader
  64328. */
  64329. export class LightBlock extends NodeMaterialBlock {
  64330. private _lightId;
  64331. /**
  64332. * Gets or sets the light associated with this block
  64333. */
  64334. light: Nullable<Light>;
  64335. /**
  64336. * Create a new LightBlock
  64337. * @param name defines the block name
  64338. */
  64339. constructor(name: string);
  64340. /**
  64341. * Gets the current class name
  64342. * @returns the class name
  64343. */
  64344. getClassName(): string;
  64345. /**
  64346. * Gets the world position input component
  64347. */
  64348. get worldPosition(): NodeMaterialConnectionPoint;
  64349. /**
  64350. * Gets the world normal input component
  64351. */
  64352. get worldNormal(): NodeMaterialConnectionPoint;
  64353. /**
  64354. * Gets the camera (or eye) position component
  64355. */
  64356. get cameraPosition(): NodeMaterialConnectionPoint;
  64357. /**
  64358. * Gets the glossiness component
  64359. */
  64360. get glossiness(): NodeMaterialConnectionPoint;
  64361. /**
  64362. * Gets the glossinness power component
  64363. */
  64364. get glossPower(): NodeMaterialConnectionPoint;
  64365. /**
  64366. * Gets the diffuse color component
  64367. */
  64368. get diffuseColor(): NodeMaterialConnectionPoint;
  64369. /**
  64370. * Gets the specular color component
  64371. */
  64372. get specularColor(): NodeMaterialConnectionPoint;
  64373. /**
  64374. * Gets the view matrix component
  64375. */
  64376. get view(): NodeMaterialConnectionPoint;
  64377. /**
  64378. * Gets the diffuse output component
  64379. */
  64380. get diffuseOutput(): NodeMaterialConnectionPoint;
  64381. /**
  64382. * Gets the specular output component
  64383. */
  64384. get specularOutput(): NodeMaterialConnectionPoint;
  64385. /**
  64386. * Gets the shadow output component
  64387. */
  64388. get shadow(): NodeMaterialConnectionPoint;
  64389. autoConfigure(material: NodeMaterial): void;
  64390. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  64391. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  64392. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  64393. private _injectVertexCode;
  64394. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  64395. serialize(): any;
  64396. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  64397. }
  64398. }
  64399. declare module BABYLON {
  64400. /**
  64401. * Block used to read a reflection texture from a sampler
  64402. */
  64403. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  64404. /**
  64405. * Create a new ReflectionTextureBlock
  64406. * @param name defines the block name
  64407. */
  64408. constructor(name: string);
  64409. /**
  64410. * Gets the current class name
  64411. * @returns the class name
  64412. */
  64413. getClassName(): string;
  64414. /**
  64415. * Gets the world position input component
  64416. */
  64417. get position(): NodeMaterialConnectionPoint;
  64418. /**
  64419. * Gets the world position input component
  64420. */
  64421. get worldPosition(): NodeMaterialConnectionPoint;
  64422. /**
  64423. * Gets the world normal input component
  64424. */
  64425. get worldNormal(): NodeMaterialConnectionPoint;
  64426. /**
  64427. * Gets the world input component
  64428. */
  64429. get world(): NodeMaterialConnectionPoint;
  64430. /**
  64431. * Gets the camera (or eye) position component
  64432. */
  64433. get cameraPosition(): NodeMaterialConnectionPoint;
  64434. /**
  64435. * Gets the view input component
  64436. */
  64437. get view(): NodeMaterialConnectionPoint;
  64438. /**
  64439. * Gets the rgb output component
  64440. */
  64441. get rgb(): NodeMaterialConnectionPoint;
  64442. /**
  64443. * Gets the rgba output component
  64444. */
  64445. get rgba(): NodeMaterialConnectionPoint;
  64446. /**
  64447. * Gets the r output component
  64448. */
  64449. get r(): NodeMaterialConnectionPoint;
  64450. /**
  64451. * Gets the g output component
  64452. */
  64453. get g(): NodeMaterialConnectionPoint;
  64454. /**
  64455. * Gets the b output component
  64456. */
  64457. get b(): NodeMaterialConnectionPoint;
  64458. /**
  64459. * Gets the a output component
  64460. */
  64461. get a(): NodeMaterialConnectionPoint;
  64462. autoConfigure(material: NodeMaterial): void;
  64463. protected _buildBlock(state: NodeMaterialBuildState): this;
  64464. }
  64465. }
  64466. declare module BABYLON {
  64467. /**
  64468. * Block used to add 2 vectors
  64469. */
  64470. export class AddBlock extends NodeMaterialBlock {
  64471. /**
  64472. * Creates a new AddBlock
  64473. * @param name defines the block name
  64474. */
  64475. constructor(name: string);
  64476. /**
  64477. * Gets the current class name
  64478. * @returns the class name
  64479. */
  64480. getClassName(): string;
  64481. /**
  64482. * Gets the left operand input component
  64483. */
  64484. get left(): NodeMaterialConnectionPoint;
  64485. /**
  64486. * Gets the right operand input component
  64487. */
  64488. get right(): NodeMaterialConnectionPoint;
  64489. /**
  64490. * Gets the output component
  64491. */
  64492. get output(): NodeMaterialConnectionPoint;
  64493. protected _buildBlock(state: NodeMaterialBuildState): this;
  64494. }
  64495. }
  64496. declare module BABYLON {
  64497. /**
  64498. * Block used to scale a vector by a float
  64499. */
  64500. export class ScaleBlock extends NodeMaterialBlock {
  64501. /**
  64502. * Creates a new ScaleBlock
  64503. * @param name defines the block name
  64504. */
  64505. constructor(name: string);
  64506. /**
  64507. * Gets the current class name
  64508. * @returns the class name
  64509. */
  64510. getClassName(): string;
  64511. /**
  64512. * Gets the input component
  64513. */
  64514. get input(): NodeMaterialConnectionPoint;
  64515. /**
  64516. * Gets the factor input component
  64517. */
  64518. get factor(): NodeMaterialConnectionPoint;
  64519. /**
  64520. * Gets the output component
  64521. */
  64522. get output(): NodeMaterialConnectionPoint;
  64523. protected _buildBlock(state: NodeMaterialBuildState): this;
  64524. }
  64525. }
  64526. declare module BABYLON {
  64527. /**
  64528. * Block used to clamp a float
  64529. */
  64530. export class ClampBlock extends NodeMaterialBlock {
  64531. /** Gets or sets the minimum range */
  64532. minimum: number;
  64533. /** Gets or sets the maximum range */
  64534. maximum: number;
  64535. /**
  64536. * Creates a new ClampBlock
  64537. * @param name defines the block name
  64538. */
  64539. constructor(name: string);
  64540. /**
  64541. * Gets the current class name
  64542. * @returns the class name
  64543. */
  64544. getClassName(): string;
  64545. /**
  64546. * Gets the value input component
  64547. */
  64548. get value(): NodeMaterialConnectionPoint;
  64549. /**
  64550. * Gets the output component
  64551. */
  64552. get output(): NodeMaterialConnectionPoint;
  64553. protected _buildBlock(state: NodeMaterialBuildState): this;
  64554. protected _dumpPropertiesCode(): string;
  64555. serialize(): any;
  64556. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  64557. }
  64558. }
  64559. declare module BABYLON {
  64560. /**
  64561. * Block used to apply a cross product between 2 vectors
  64562. */
  64563. export class CrossBlock extends NodeMaterialBlock {
  64564. /**
  64565. * Creates a new CrossBlock
  64566. * @param name defines the block name
  64567. */
  64568. constructor(name: string);
  64569. /**
  64570. * Gets the current class name
  64571. * @returns the class name
  64572. */
  64573. getClassName(): string;
  64574. /**
  64575. * Gets the left operand input component
  64576. */
  64577. get left(): NodeMaterialConnectionPoint;
  64578. /**
  64579. * Gets the right operand input component
  64580. */
  64581. get right(): NodeMaterialConnectionPoint;
  64582. /**
  64583. * Gets the output component
  64584. */
  64585. get output(): NodeMaterialConnectionPoint;
  64586. protected _buildBlock(state: NodeMaterialBuildState): this;
  64587. }
  64588. }
  64589. declare module BABYLON {
  64590. /**
  64591. * Block used to apply a dot product between 2 vectors
  64592. */
  64593. export class DotBlock extends NodeMaterialBlock {
  64594. /**
  64595. * Creates a new DotBlock
  64596. * @param name defines the block name
  64597. */
  64598. constructor(name: string);
  64599. /**
  64600. * Gets the current class name
  64601. * @returns the class name
  64602. */
  64603. getClassName(): string;
  64604. /**
  64605. * Gets the left operand input component
  64606. */
  64607. get left(): NodeMaterialConnectionPoint;
  64608. /**
  64609. * Gets the right operand input component
  64610. */
  64611. get right(): NodeMaterialConnectionPoint;
  64612. /**
  64613. * Gets the output component
  64614. */
  64615. get output(): NodeMaterialConnectionPoint;
  64616. protected _buildBlock(state: NodeMaterialBuildState): this;
  64617. }
  64618. }
  64619. declare module BABYLON {
  64620. /**
  64621. * Block used to normalize a vector
  64622. */
  64623. export class NormalizeBlock extends NodeMaterialBlock {
  64624. /**
  64625. * Creates a new NormalizeBlock
  64626. * @param name defines the block name
  64627. */
  64628. constructor(name: string);
  64629. /**
  64630. * Gets the current class name
  64631. * @returns the class name
  64632. */
  64633. getClassName(): string;
  64634. /**
  64635. * Gets the input component
  64636. */
  64637. get input(): NodeMaterialConnectionPoint;
  64638. /**
  64639. * Gets the output component
  64640. */
  64641. get output(): NodeMaterialConnectionPoint;
  64642. protected _buildBlock(state: NodeMaterialBuildState): this;
  64643. }
  64644. }
  64645. declare module BABYLON {
  64646. /**
  64647. * Block used to create a Color3/4 out of individual inputs (one for each component)
  64648. */
  64649. export class ColorMergerBlock extends NodeMaterialBlock {
  64650. /**
  64651. * Create a new ColorMergerBlock
  64652. * @param name defines the block name
  64653. */
  64654. constructor(name: string);
  64655. /**
  64656. * Gets the current class name
  64657. * @returns the class name
  64658. */
  64659. getClassName(): string;
  64660. /**
  64661. * Gets the rgb component (input)
  64662. */
  64663. get rgbIn(): NodeMaterialConnectionPoint;
  64664. /**
  64665. * Gets the r component (input)
  64666. */
  64667. get r(): NodeMaterialConnectionPoint;
  64668. /**
  64669. * Gets the g component (input)
  64670. */
  64671. get g(): NodeMaterialConnectionPoint;
  64672. /**
  64673. * Gets the b component (input)
  64674. */
  64675. get b(): NodeMaterialConnectionPoint;
  64676. /**
  64677. * Gets the a component (input)
  64678. */
  64679. get a(): NodeMaterialConnectionPoint;
  64680. /**
  64681. * Gets the rgba component (output)
  64682. */
  64683. get rgba(): NodeMaterialConnectionPoint;
  64684. /**
  64685. * Gets the rgb component (output)
  64686. */
  64687. get rgbOut(): NodeMaterialConnectionPoint;
  64688. /**
  64689. * Gets the rgb component (output)
  64690. * @deprecated Please use rgbOut instead.
  64691. */
  64692. get rgb(): NodeMaterialConnectionPoint;
  64693. protected _buildBlock(state: NodeMaterialBuildState): this;
  64694. }
  64695. }
  64696. declare module BABYLON {
  64697. /**
  64698. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  64699. */
  64700. export class VectorSplitterBlock extends NodeMaterialBlock {
  64701. /**
  64702. * Create a new VectorSplitterBlock
  64703. * @param name defines the block name
  64704. */
  64705. constructor(name: string);
  64706. /**
  64707. * Gets the current class name
  64708. * @returns the class name
  64709. */
  64710. getClassName(): string;
  64711. /**
  64712. * Gets the xyzw component (input)
  64713. */
  64714. get xyzw(): NodeMaterialConnectionPoint;
  64715. /**
  64716. * Gets the xyz component (input)
  64717. */
  64718. get xyzIn(): NodeMaterialConnectionPoint;
  64719. /**
  64720. * Gets the xy component (input)
  64721. */
  64722. get xyIn(): NodeMaterialConnectionPoint;
  64723. /**
  64724. * Gets the xyz component (output)
  64725. */
  64726. get xyzOut(): NodeMaterialConnectionPoint;
  64727. /**
  64728. * Gets the xy component (output)
  64729. */
  64730. get xyOut(): NodeMaterialConnectionPoint;
  64731. /**
  64732. * Gets the x component (output)
  64733. */
  64734. get x(): NodeMaterialConnectionPoint;
  64735. /**
  64736. * Gets the y component (output)
  64737. */
  64738. get y(): NodeMaterialConnectionPoint;
  64739. /**
  64740. * Gets the z component (output)
  64741. */
  64742. get z(): NodeMaterialConnectionPoint;
  64743. /**
  64744. * Gets the w component (output)
  64745. */
  64746. get w(): NodeMaterialConnectionPoint;
  64747. protected _inputRename(name: string): string;
  64748. protected _outputRename(name: string): string;
  64749. protected _buildBlock(state: NodeMaterialBuildState): this;
  64750. }
  64751. }
  64752. declare module BABYLON {
  64753. /**
  64754. * Block used to lerp between 2 values
  64755. */
  64756. export class LerpBlock extends NodeMaterialBlock {
  64757. /**
  64758. * Creates a new LerpBlock
  64759. * @param name defines the block name
  64760. */
  64761. constructor(name: string);
  64762. /**
  64763. * Gets the current class name
  64764. * @returns the class name
  64765. */
  64766. getClassName(): string;
  64767. /**
  64768. * Gets the left operand input component
  64769. */
  64770. get left(): NodeMaterialConnectionPoint;
  64771. /**
  64772. * Gets the right operand input component
  64773. */
  64774. get right(): NodeMaterialConnectionPoint;
  64775. /**
  64776. * Gets the gradient operand input component
  64777. */
  64778. get gradient(): NodeMaterialConnectionPoint;
  64779. /**
  64780. * Gets the output component
  64781. */
  64782. get output(): NodeMaterialConnectionPoint;
  64783. protected _buildBlock(state: NodeMaterialBuildState): this;
  64784. }
  64785. }
  64786. declare module BABYLON {
  64787. /**
  64788. * Block used to divide 2 vectors
  64789. */
  64790. export class DivideBlock extends NodeMaterialBlock {
  64791. /**
  64792. * Creates a new DivideBlock
  64793. * @param name defines the block name
  64794. */
  64795. constructor(name: string);
  64796. /**
  64797. * Gets the current class name
  64798. * @returns the class name
  64799. */
  64800. getClassName(): string;
  64801. /**
  64802. * Gets the left operand input component
  64803. */
  64804. get left(): NodeMaterialConnectionPoint;
  64805. /**
  64806. * Gets the right operand input component
  64807. */
  64808. get right(): NodeMaterialConnectionPoint;
  64809. /**
  64810. * Gets the output component
  64811. */
  64812. get output(): NodeMaterialConnectionPoint;
  64813. protected _buildBlock(state: NodeMaterialBuildState): this;
  64814. }
  64815. }
  64816. declare module BABYLON {
  64817. /**
  64818. * Block used to subtract 2 vectors
  64819. */
  64820. export class SubtractBlock extends NodeMaterialBlock {
  64821. /**
  64822. * Creates a new SubtractBlock
  64823. * @param name defines the block name
  64824. */
  64825. constructor(name: string);
  64826. /**
  64827. * Gets the current class name
  64828. * @returns the class name
  64829. */
  64830. getClassName(): string;
  64831. /**
  64832. * Gets the left operand input component
  64833. */
  64834. get left(): NodeMaterialConnectionPoint;
  64835. /**
  64836. * Gets the right operand input component
  64837. */
  64838. get right(): NodeMaterialConnectionPoint;
  64839. /**
  64840. * Gets the output component
  64841. */
  64842. get output(): NodeMaterialConnectionPoint;
  64843. protected _buildBlock(state: NodeMaterialBuildState): this;
  64844. }
  64845. }
  64846. declare module BABYLON {
  64847. /**
  64848. * Block used to step a value
  64849. */
  64850. export class StepBlock extends NodeMaterialBlock {
  64851. /**
  64852. * Creates a new StepBlock
  64853. * @param name defines the block name
  64854. */
  64855. constructor(name: string);
  64856. /**
  64857. * Gets the current class name
  64858. * @returns the class name
  64859. */
  64860. getClassName(): string;
  64861. /**
  64862. * Gets the value operand input component
  64863. */
  64864. get value(): NodeMaterialConnectionPoint;
  64865. /**
  64866. * Gets the edge operand input component
  64867. */
  64868. get edge(): NodeMaterialConnectionPoint;
  64869. /**
  64870. * Gets the output component
  64871. */
  64872. get output(): NodeMaterialConnectionPoint;
  64873. protected _buildBlock(state: NodeMaterialBuildState): this;
  64874. }
  64875. }
  64876. declare module BABYLON {
  64877. /**
  64878. * Block used to get the opposite (1 - x) of a value
  64879. */
  64880. export class OneMinusBlock extends NodeMaterialBlock {
  64881. /**
  64882. * Creates a new OneMinusBlock
  64883. * @param name defines the block name
  64884. */
  64885. constructor(name: string);
  64886. /**
  64887. * Gets the current class name
  64888. * @returns the class name
  64889. */
  64890. getClassName(): string;
  64891. /**
  64892. * Gets the input component
  64893. */
  64894. get input(): NodeMaterialConnectionPoint;
  64895. /**
  64896. * Gets the output component
  64897. */
  64898. get output(): NodeMaterialConnectionPoint;
  64899. protected _buildBlock(state: NodeMaterialBuildState): this;
  64900. }
  64901. }
  64902. declare module BABYLON {
  64903. /**
  64904. * Block used to get the view direction
  64905. */
  64906. export class ViewDirectionBlock extends NodeMaterialBlock {
  64907. /**
  64908. * Creates a new ViewDirectionBlock
  64909. * @param name defines the block name
  64910. */
  64911. constructor(name: string);
  64912. /**
  64913. * Gets the current class name
  64914. * @returns the class name
  64915. */
  64916. getClassName(): string;
  64917. /**
  64918. * Gets the world position component
  64919. */
  64920. get worldPosition(): NodeMaterialConnectionPoint;
  64921. /**
  64922. * Gets the camera position component
  64923. */
  64924. get cameraPosition(): NodeMaterialConnectionPoint;
  64925. /**
  64926. * Gets the output component
  64927. */
  64928. get output(): NodeMaterialConnectionPoint;
  64929. autoConfigure(material: NodeMaterial): void;
  64930. protected _buildBlock(state: NodeMaterialBuildState): this;
  64931. }
  64932. }
  64933. declare module BABYLON {
  64934. /**
  64935. * Block used to compute fresnel value
  64936. */
  64937. export class FresnelBlock extends NodeMaterialBlock {
  64938. /**
  64939. * Create a new FresnelBlock
  64940. * @param name defines the block name
  64941. */
  64942. constructor(name: string);
  64943. /**
  64944. * Gets the current class name
  64945. * @returns the class name
  64946. */
  64947. getClassName(): string;
  64948. /**
  64949. * Gets the world normal input component
  64950. */
  64951. get worldNormal(): NodeMaterialConnectionPoint;
  64952. /**
  64953. * Gets the view direction input component
  64954. */
  64955. get viewDirection(): NodeMaterialConnectionPoint;
  64956. /**
  64957. * Gets the bias input component
  64958. */
  64959. get bias(): NodeMaterialConnectionPoint;
  64960. /**
  64961. * Gets the camera (or eye) position component
  64962. */
  64963. get power(): NodeMaterialConnectionPoint;
  64964. /**
  64965. * Gets the fresnel output component
  64966. */
  64967. get fresnel(): NodeMaterialConnectionPoint;
  64968. autoConfigure(material: NodeMaterial): void;
  64969. protected _buildBlock(state: NodeMaterialBuildState): this;
  64970. }
  64971. }
  64972. declare module BABYLON {
  64973. /**
  64974. * Block used to get the max of 2 values
  64975. */
  64976. export class MaxBlock extends NodeMaterialBlock {
  64977. /**
  64978. * Creates a new MaxBlock
  64979. * @param name defines the block name
  64980. */
  64981. constructor(name: string);
  64982. /**
  64983. * Gets the current class name
  64984. * @returns the class name
  64985. */
  64986. getClassName(): string;
  64987. /**
  64988. * Gets the left operand input component
  64989. */
  64990. get left(): NodeMaterialConnectionPoint;
  64991. /**
  64992. * Gets the right operand input component
  64993. */
  64994. get right(): NodeMaterialConnectionPoint;
  64995. /**
  64996. * Gets the output component
  64997. */
  64998. get output(): NodeMaterialConnectionPoint;
  64999. protected _buildBlock(state: NodeMaterialBuildState): this;
  65000. }
  65001. }
  65002. declare module BABYLON {
  65003. /**
  65004. * Block used to get the min of 2 values
  65005. */
  65006. export class MinBlock extends NodeMaterialBlock {
  65007. /**
  65008. * Creates a new MinBlock
  65009. * @param name defines the block name
  65010. */
  65011. constructor(name: string);
  65012. /**
  65013. * Gets the current class name
  65014. * @returns the class name
  65015. */
  65016. getClassName(): string;
  65017. /**
  65018. * Gets the left operand input component
  65019. */
  65020. get left(): NodeMaterialConnectionPoint;
  65021. /**
  65022. * Gets the right operand input component
  65023. */
  65024. get right(): NodeMaterialConnectionPoint;
  65025. /**
  65026. * Gets the output component
  65027. */
  65028. get output(): NodeMaterialConnectionPoint;
  65029. protected _buildBlock(state: NodeMaterialBuildState): this;
  65030. }
  65031. }
  65032. declare module BABYLON {
  65033. /**
  65034. * Block used to get the distance between 2 values
  65035. */
  65036. export class DistanceBlock extends NodeMaterialBlock {
  65037. /**
  65038. * Creates a new DistanceBlock
  65039. * @param name defines the block name
  65040. */
  65041. constructor(name: string);
  65042. /**
  65043. * Gets the current class name
  65044. * @returns the class name
  65045. */
  65046. getClassName(): string;
  65047. /**
  65048. * Gets the left operand input component
  65049. */
  65050. get left(): NodeMaterialConnectionPoint;
  65051. /**
  65052. * Gets the right operand input component
  65053. */
  65054. get right(): NodeMaterialConnectionPoint;
  65055. /**
  65056. * Gets the output component
  65057. */
  65058. get output(): NodeMaterialConnectionPoint;
  65059. protected _buildBlock(state: NodeMaterialBuildState): this;
  65060. }
  65061. }
  65062. declare module BABYLON {
  65063. /**
  65064. * Block used to get the length of a vector
  65065. */
  65066. export class LengthBlock extends NodeMaterialBlock {
  65067. /**
  65068. * Creates a new LengthBlock
  65069. * @param name defines the block name
  65070. */
  65071. constructor(name: string);
  65072. /**
  65073. * Gets the current class name
  65074. * @returns the class name
  65075. */
  65076. getClassName(): string;
  65077. /**
  65078. * Gets the value input component
  65079. */
  65080. get value(): NodeMaterialConnectionPoint;
  65081. /**
  65082. * Gets the output component
  65083. */
  65084. get output(): NodeMaterialConnectionPoint;
  65085. protected _buildBlock(state: NodeMaterialBuildState): this;
  65086. }
  65087. }
  65088. declare module BABYLON {
  65089. /**
  65090. * Block used to get negative version of a value (i.e. x * -1)
  65091. */
  65092. export class NegateBlock extends NodeMaterialBlock {
  65093. /**
  65094. * Creates a new NegateBlock
  65095. * @param name defines the block name
  65096. */
  65097. constructor(name: string);
  65098. /**
  65099. * Gets the current class name
  65100. * @returns the class name
  65101. */
  65102. getClassName(): string;
  65103. /**
  65104. * Gets the value input component
  65105. */
  65106. get value(): NodeMaterialConnectionPoint;
  65107. /**
  65108. * Gets the output component
  65109. */
  65110. get output(): NodeMaterialConnectionPoint;
  65111. protected _buildBlock(state: NodeMaterialBuildState): this;
  65112. }
  65113. }
  65114. declare module BABYLON {
  65115. /**
  65116. * Block used to get the value of the first parameter raised to the power of the second
  65117. */
  65118. export class PowBlock extends NodeMaterialBlock {
  65119. /**
  65120. * Creates a new PowBlock
  65121. * @param name defines the block name
  65122. */
  65123. constructor(name: string);
  65124. /**
  65125. * Gets the current class name
  65126. * @returns the class name
  65127. */
  65128. getClassName(): string;
  65129. /**
  65130. * Gets the value operand input component
  65131. */
  65132. get value(): NodeMaterialConnectionPoint;
  65133. /**
  65134. * Gets the power operand input component
  65135. */
  65136. get power(): NodeMaterialConnectionPoint;
  65137. /**
  65138. * Gets the output component
  65139. */
  65140. get output(): NodeMaterialConnectionPoint;
  65141. protected _buildBlock(state: NodeMaterialBuildState): this;
  65142. }
  65143. }
  65144. declare module BABYLON {
  65145. /**
  65146. * Block used to get a random number
  65147. */
  65148. export class RandomNumberBlock extends NodeMaterialBlock {
  65149. /**
  65150. * Creates a new RandomNumberBlock
  65151. * @param name defines the block name
  65152. */
  65153. constructor(name: string);
  65154. /**
  65155. * Gets the current class name
  65156. * @returns the class name
  65157. */
  65158. getClassName(): string;
  65159. /**
  65160. * Gets the seed input component
  65161. */
  65162. get seed(): NodeMaterialConnectionPoint;
  65163. /**
  65164. * Gets the output component
  65165. */
  65166. get output(): NodeMaterialConnectionPoint;
  65167. protected _buildBlock(state: NodeMaterialBuildState): this;
  65168. }
  65169. }
  65170. declare module BABYLON {
  65171. /**
  65172. * Block used to compute arc tangent of 2 values
  65173. */
  65174. export class ArcTan2Block extends NodeMaterialBlock {
  65175. /**
  65176. * Creates a new ArcTan2Block
  65177. * @param name defines the block name
  65178. */
  65179. constructor(name: string);
  65180. /**
  65181. * Gets the current class name
  65182. * @returns the class name
  65183. */
  65184. getClassName(): string;
  65185. /**
  65186. * Gets the x operand input component
  65187. */
  65188. get x(): NodeMaterialConnectionPoint;
  65189. /**
  65190. * Gets the y operand input component
  65191. */
  65192. get y(): NodeMaterialConnectionPoint;
  65193. /**
  65194. * Gets the output component
  65195. */
  65196. get output(): NodeMaterialConnectionPoint;
  65197. protected _buildBlock(state: NodeMaterialBuildState): this;
  65198. }
  65199. }
  65200. declare module BABYLON {
  65201. /**
  65202. * Block used to smooth step a value
  65203. */
  65204. export class SmoothStepBlock extends NodeMaterialBlock {
  65205. /**
  65206. * Creates a new SmoothStepBlock
  65207. * @param name defines the block name
  65208. */
  65209. constructor(name: string);
  65210. /**
  65211. * Gets the current class name
  65212. * @returns the class name
  65213. */
  65214. getClassName(): string;
  65215. /**
  65216. * Gets the value operand input component
  65217. */
  65218. get value(): NodeMaterialConnectionPoint;
  65219. /**
  65220. * Gets the first edge operand input component
  65221. */
  65222. get edge0(): NodeMaterialConnectionPoint;
  65223. /**
  65224. * Gets the second edge operand input component
  65225. */
  65226. get edge1(): NodeMaterialConnectionPoint;
  65227. /**
  65228. * Gets the output component
  65229. */
  65230. get output(): NodeMaterialConnectionPoint;
  65231. protected _buildBlock(state: NodeMaterialBuildState): this;
  65232. }
  65233. }
  65234. declare module BABYLON {
  65235. /**
  65236. * Block used to get the reciprocal (1 / x) of a value
  65237. */
  65238. export class ReciprocalBlock extends NodeMaterialBlock {
  65239. /**
  65240. * Creates a new ReciprocalBlock
  65241. * @param name defines the block name
  65242. */
  65243. constructor(name: string);
  65244. /**
  65245. * Gets the current class name
  65246. * @returns the class name
  65247. */
  65248. getClassName(): string;
  65249. /**
  65250. * Gets the input component
  65251. */
  65252. get input(): NodeMaterialConnectionPoint;
  65253. /**
  65254. * Gets the output component
  65255. */
  65256. get output(): NodeMaterialConnectionPoint;
  65257. protected _buildBlock(state: NodeMaterialBuildState): this;
  65258. }
  65259. }
  65260. declare module BABYLON {
  65261. /**
  65262. * Block used to replace a color by another one
  65263. */
  65264. export class ReplaceColorBlock extends NodeMaterialBlock {
  65265. /**
  65266. * Creates a new ReplaceColorBlock
  65267. * @param name defines the block name
  65268. */
  65269. constructor(name: string);
  65270. /**
  65271. * Gets the current class name
  65272. * @returns the class name
  65273. */
  65274. getClassName(): string;
  65275. /**
  65276. * Gets the value input component
  65277. */
  65278. get value(): NodeMaterialConnectionPoint;
  65279. /**
  65280. * Gets the reference input component
  65281. */
  65282. get reference(): NodeMaterialConnectionPoint;
  65283. /**
  65284. * Gets the distance input component
  65285. */
  65286. get distance(): NodeMaterialConnectionPoint;
  65287. /**
  65288. * Gets the replacement input component
  65289. */
  65290. get replacement(): NodeMaterialConnectionPoint;
  65291. /**
  65292. * Gets the output component
  65293. */
  65294. get output(): NodeMaterialConnectionPoint;
  65295. protected _buildBlock(state: NodeMaterialBuildState): this;
  65296. }
  65297. }
  65298. declare module BABYLON {
  65299. /**
  65300. * Block used to posterize a value
  65301. * @see https://en.wikipedia.org/wiki/Posterization
  65302. */
  65303. export class PosterizeBlock extends NodeMaterialBlock {
  65304. /**
  65305. * Creates a new PosterizeBlock
  65306. * @param name defines the block name
  65307. */
  65308. constructor(name: string);
  65309. /**
  65310. * Gets the current class name
  65311. * @returns the class name
  65312. */
  65313. getClassName(): string;
  65314. /**
  65315. * Gets the value input component
  65316. */
  65317. get value(): NodeMaterialConnectionPoint;
  65318. /**
  65319. * Gets the steps input component
  65320. */
  65321. get steps(): NodeMaterialConnectionPoint;
  65322. /**
  65323. * Gets the output component
  65324. */
  65325. get output(): NodeMaterialConnectionPoint;
  65326. protected _buildBlock(state: NodeMaterialBuildState): this;
  65327. }
  65328. }
  65329. declare module BABYLON {
  65330. /**
  65331. * Operations supported by the Wave block
  65332. */
  65333. export enum WaveBlockKind {
  65334. /** SawTooth */
  65335. SawTooth = 0,
  65336. /** Square */
  65337. Square = 1,
  65338. /** Triangle */
  65339. Triangle = 2
  65340. }
  65341. /**
  65342. * Block used to apply wave operation to floats
  65343. */
  65344. export class WaveBlock extends NodeMaterialBlock {
  65345. /**
  65346. * Gets or sets the kibnd of wave to be applied by the block
  65347. */
  65348. kind: WaveBlockKind;
  65349. /**
  65350. * Creates a new WaveBlock
  65351. * @param name defines the block name
  65352. */
  65353. constructor(name: string);
  65354. /**
  65355. * Gets the current class name
  65356. * @returns the class name
  65357. */
  65358. getClassName(): string;
  65359. /**
  65360. * Gets the input component
  65361. */
  65362. get input(): NodeMaterialConnectionPoint;
  65363. /**
  65364. * Gets the output component
  65365. */
  65366. get output(): NodeMaterialConnectionPoint;
  65367. protected _buildBlock(state: NodeMaterialBuildState): this;
  65368. serialize(): any;
  65369. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65370. }
  65371. }
  65372. declare module BABYLON {
  65373. /**
  65374. * Class used to store a color step for the GradientBlock
  65375. */
  65376. export class GradientBlockColorStep {
  65377. private _step;
  65378. /**
  65379. * Gets value indicating which step this color is associated with (between 0 and 1)
  65380. */
  65381. get step(): number;
  65382. /**
  65383. * Sets a value indicating which step this color is associated with (between 0 and 1)
  65384. */
  65385. set step(val: number);
  65386. private _color;
  65387. /**
  65388. * Gets the color associated with this step
  65389. */
  65390. get color(): Color3;
  65391. /**
  65392. * Sets the color associated with this step
  65393. */
  65394. set color(val: Color3);
  65395. /**
  65396. * Creates a new GradientBlockColorStep
  65397. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  65398. * @param color defines the color associated with this step
  65399. */
  65400. constructor(step: number, color: Color3);
  65401. }
  65402. /**
  65403. * Block used to return a color from a gradient based on an input value between 0 and 1
  65404. */
  65405. export class GradientBlock extends NodeMaterialBlock {
  65406. /**
  65407. * Gets or sets the list of color steps
  65408. */
  65409. colorSteps: GradientBlockColorStep[];
  65410. /** Gets an observable raised when the value is changed */
  65411. onValueChangedObservable: Observable<GradientBlock>;
  65412. /** calls observable when the value is changed*/
  65413. colorStepsUpdated(): void;
  65414. /**
  65415. * Creates a new GradientBlock
  65416. * @param name defines the block name
  65417. */
  65418. constructor(name: string);
  65419. /**
  65420. * Gets the current class name
  65421. * @returns the class name
  65422. */
  65423. getClassName(): string;
  65424. /**
  65425. * Gets the gradient input component
  65426. */
  65427. get gradient(): NodeMaterialConnectionPoint;
  65428. /**
  65429. * Gets the output component
  65430. */
  65431. get output(): NodeMaterialConnectionPoint;
  65432. private _writeColorConstant;
  65433. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65434. serialize(): any;
  65435. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65436. protected _dumpPropertiesCode(): string;
  65437. }
  65438. }
  65439. declare module BABYLON {
  65440. /**
  65441. * Block used to normalize lerp between 2 values
  65442. */
  65443. export class NLerpBlock extends NodeMaterialBlock {
  65444. /**
  65445. * Creates a new NLerpBlock
  65446. * @param name defines the block name
  65447. */
  65448. constructor(name: string);
  65449. /**
  65450. * Gets the current class name
  65451. * @returns the class name
  65452. */
  65453. getClassName(): string;
  65454. /**
  65455. * Gets the left operand input component
  65456. */
  65457. get left(): NodeMaterialConnectionPoint;
  65458. /**
  65459. * Gets the right operand input component
  65460. */
  65461. get right(): NodeMaterialConnectionPoint;
  65462. /**
  65463. * Gets the gradient operand input component
  65464. */
  65465. get gradient(): NodeMaterialConnectionPoint;
  65466. /**
  65467. * Gets the output component
  65468. */
  65469. get output(): NodeMaterialConnectionPoint;
  65470. protected _buildBlock(state: NodeMaterialBuildState): this;
  65471. }
  65472. }
  65473. declare module BABYLON {
  65474. /**
  65475. * block used to Generate a Worley Noise 3D Noise Pattern
  65476. */
  65477. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  65478. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  65479. manhattanDistance: boolean;
  65480. /**
  65481. * Creates a new WorleyNoise3DBlock
  65482. * @param name defines the block name
  65483. */
  65484. constructor(name: string);
  65485. /**
  65486. * Gets the current class name
  65487. * @returns the class name
  65488. */
  65489. getClassName(): string;
  65490. /**
  65491. * Gets the seed input component
  65492. */
  65493. get seed(): NodeMaterialConnectionPoint;
  65494. /**
  65495. * Gets the jitter input component
  65496. */
  65497. get jitter(): NodeMaterialConnectionPoint;
  65498. /**
  65499. * Gets the output component
  65500. */
  65501. get output(): NodeMaterialConnectionPoint;
  65502. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65503. /**
  65504. * Exposes the properties to the UI?
  65505. */
  65506. protected _dumpPropertiesCode(): string;
  65507. /**
  65508. * Exposes the properties to the Seralize?
  65509. */
  65510. serialize(): any;
  65511. /**
  65512. * Exposes the properties to the deseralize?
  65513. */
  65514. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65515. }
  65516. }
  65517. declare module BABYLON {
  65518. /**
  65519. * block used to Generate a Simplex Perlin 3d Noise Pattern
  65520. */
  65521. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  65522. /**
  65523. * Creates a new SimplexPerlin3DBlock
  65524. * @param name defines the block name
  65525. */
  65526. constructor(name: string);
  65527. /**
  65528. * Gets the current class name
  65529. * @returns the class name
  65530. */
  65531. getClassName(): string;
  65532. /**
  65533. * Gets the seed operand input component
  65534. */
  65535. get seed(): NodeMaterialConnectionPoint;
  65536. /**
  65537. * Gets the output component
  65538. */
  65539. get output(): NodeMaterialConnectionPoint;
  65540. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65541. }
  65542. }
  65543. declare module BABYLON {
  65544. /**
  65545. * Block used to blend normals
  65546. */
  65547. export class NormalBlendBlock extends NodeMaterialBlock {
  65548. /**
  65549. * Creates a new NormalBlendBlock
  65550. * @param name defines the block name
  65551. */
  65552. constructor(name: string);
  65553. /**
  65554. * Gets the current class name
  65555. * @returns the class name
  65556. */
  65557. getClassName(): string;
  65558. /**
  65559. * Gets the first input component
  65560. */
  65561. get normalMap0(): NodeMaterialConnectionPoint;
  65562. /**
  65563. * Gets the second input component
  65564. */
  65565. get normalMap1(): NodeMaterialConnectionPoint;
  65566. /**
  65567. * Gets the output component
  65568. */
  65569. get output(): NodeMaterialConnectionPoint;
  65570. protected _buildBlock(state: NodeMaterialBuildState): this;
  65571. }
  65572. }
  65573. declare module BABYLON {
  65574. /**
  65575. * Block used to rotate a 2d vector by a given angle
  65576. */
  65577. export class Rotate2dBlock extends NodeMaterialBlock {
  65578. /**
  65579. * Creates a new Rotate2dBlock
  65580. * @param name defines the block name
  65581. */
  65582. constructor(name: string);
  65583. /**
  65584. * Gets the current class name
  65585. * @returns the class name
  65586. */
  65587. getClassName(): string;
  65588. /**
  65589. * Gets the input vector
  65590. */
  65591. get input(): NodeMaterialConnectionPoint;
  65592. /**
  65593. * Gets the input angle
  65594. */
  65595. get angle(): NodeMaterialConnectionPoint;
  65596. /**
  65597. * Gets the output component
  65598. */
  65599. get output(): NodeMaterialConnectionPoint;
  65600. autoConfigure(material: NodeMaterial): void;
  65601. protected _buildBlock(state: NodeMaterialBuildState): this;
  65602. }
  65603. }
  65604. declare module BABYLON {
  65605. /**
  65606. * Block used to get the reflected vector from a direction and a normal
  65607. */
  65608. export class ReflectBlock extends NodeMaterialBlock {
  65609. /**
  65610. * Creates a new ReflectBlock
  65611. * @param name defines the block name
  65612. */
  65613. constructor(name: string);
  65614. /**
  65615. * Gets the current class name
  65616. * @returns the class name
  65617. */
  65618. getClassName(): string;
  65619. /**
  65620. * Gets the incident component
  65621. */
  65622. get incident(): NodeMaterialConnectionPoint;
  65623. /**
  65624. * Gets the normal component
  65625. */
  65626. get normal(): NodeMaterialConnectionPoint;
  65627. /**
  65628. * Gets the output component
  65629. */
  65630. get output(): NodeMaterialConnectionPoint;
  65631. protected _buildBlock(state: NodeMaterialBuildState): this;
  65632. }
  65633. }
  65634. declare module BABYLON {
  65635. /**
  65636. * Block used to get the refracted vector from a direction and a normal
  65637. */
  65638. export class RefractBlock extends NodeMaterialBlock {
  65639. /**
  65640. * Creates a new RefractBlock
  65641. * @param name defines the block name
  65642. */
  65643. constructor(name: string);
  65644. /**
  65645. * Gets the current class name
  65646. * @returns the class name
  65647. */
  65648. getClassName(): string;
  65649. /**
  65650. * Gets the incident component
  65651. */
  65652. get incident(): NodeMaterialConnectionPoint;
  65653. /**
  65654. * Gets the normal component
  65655. */
  65656. get normal(): NodeMaterialConnectionPoint;
  65657. /**
  65658. * Gets the index of refraction component
  65659. */
  65660. get ior(): NodeMaterialConnectionPoint;
  65661. /**
  65662. * Gets the output component
  65663. */
  65664. get output(): NodeMaterialConnectionPoint;
  65665. protected _buildBlock(state: NodeMaterialBuildState): this;
  65666. }
  65667. }
  65668. declare module BABYLON {
  65669. /**
  65670. * Block used to desaturate a color
  65671. */
  65672. export class DesaturateBlock extends NodeMaterialBlock {
  65673. /**
  65674. * Creates a new DesaturateBlock
  65675. * @param name defines the block name
  65676. */
  65677. constructor(name: string);
  65678. /**
  65679. * Gets the current class name
  65680. * @returns the class name
  65681. */
  65682. getClassName(): string;
  65683. /**
  65684. * Gets the color operand input component
  65685. */
  65686. get color(): NodeMaterialConnectionPoint;
  65687. /**
  65688. * Gets the level operand input component
  65689. */
  65690. get level(): NodeMaterialConnectionPoint;
  65691. /**
  65692. * Gets the output component
  65693. */
  65694. get output(): NodeMaterialConnectionPoint;
  65695. protected _buildBlock(state: NodeMaterialBuildState): this;
  65696. }
  65697. }
  65698. declare module BABYLON {
  65699. /**
  65700. * Block used to implement the reflection module of the PBR material
  65701. */
  65702. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  65703. /** @hidden */
  65704. _defineLODReflectionAlpha: string;
  65705. /** @hidden */
  65706. _defineLinearSpecularReflection: string;
  65707. private _vEnvironmentIrradianceName;
  65708. /** @hidden */
  65709. _vReflectionMicrosurfaceInfosName: string;
  65710. /** @hidden */
  65711. _vReflectionInfosName: string;
  65712. /** @hidden */
  65713. _vReflectionFilteringInfoName: string;
  65714. private _scene;
  65715. /**
  65716. * The properties below are set by the main PBR block prior to calling methods of this class.
  65717. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  65718. * It's less burden on the user side in the editor part.
  65719. */
  65720. /** @hidden */
  65721. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  65722. /** @hidden */
  65723. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  65724. /** @hidden */
  65725. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  65726. /** @hidden */
  65727. viewConnectionPoint: NodeMaterialConnectionPoint;
  65728. /**
  65729. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  65730. * diffuse part of the IBL.
  65731. */
  65732. useSphericalHarmonics: boolean;
  65733. /**
  65734. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  65735. */
  65736. forceIrradianceInFragment: boolean;
  65737. /**
  65738. * Create a new ReflectionBlock
  65739. * @param name defines the block name
  65740. */
  65741. constructor(name: string);
  65742. /**
  65743. * Gets the current class name
  65744. * @returns the class name
  65745. */
  65746. getClassName(): string;
  65747. /**
  65748. * Gets the position input component
  65749. */
  65750. get position(): NodeMaterialConnectionPoint;
  65751. /**
  65752. * Gets the world position input component
  65753. */
  65754. get worldPosition(): NodeMaterialConnectionPoint;
  65755. /**
  65756. * Gets the world normal input component
  65757. */
  65758. get worldNormal(): NodeMaterialConnectionPoint;
  65759. /**
  65760. * Gets the world input component
  65761. */
  65762. get world(): NodeMaterialConnectionPoint;
  65763. /**
  65764. * Gets the camera (or eye) position component
  65765. */
  65766. get cameraPosition(): NodeMaterialConnectionPoint;
  65767. /**
  65768. * Gets the view input component
  65769. */
  65770. get view(): NodeMaterialConnectionPoint;
  65771. /**
  65772. * Gets the color input component
  65773. */
  65774. get color(): NodeMaterialConnectionPoint;
  65775. /**
  65776. * Gets the reflection object output component
  65777. */
  65778. get reflection(): NodeMaterialConnectionPoint;
  65779. /**
  65780. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  65781. */
  65782. get hasTexture(): boolean;
  65783. /**
  65784. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  65785. */
  65786. get reflectionColor(): string;
  65787. protected _getTexture(): Nullable<BaseTexture>;
  65788. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65789. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  65790. /**
  65791. * Gets the code to inject in the vertex shader
  65792. * @param state current state of the node material building
  65793. * @returns the shader code
  65794. */
  65795. handleVertexSide(state: NodeMaterialBuildState): string;
  65796. /**
  65797. * Gets the main code of the block (fragment side)
  65798. * @param state current state of the node material building
  65799. * @param normalVarName name of the existing variable corresponding to the normal
  65800. * @returns the shader code
  65801. */
  65802. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  65803. protected _buildBlock(state: NodeMaterialBuildState): this;
  65804. protected _dumpPropertiesCode(): string;
  65805. serialize(): any;
  65806. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65807. }
  65808. }
  65809. declare module BABYLON {
  65810. /**
  65811. * Block used to implement the sheen module of the PBR material
  65812. */
  65813. export class SheenBlock extends NodeMaterialBlock {
  65814. /**
  65815. * Create a new SheenBlock
  65816. * @param name defines the block name
  65817. */
  65818. constructor(name: string);
  65819. /**
  65820. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  65821. * It allows the strength of the sheen effect to not depend on the base color of the material,
  65822. * making it easier to setup and tweak the effect
  65823. */
  65824. albedoScaling: boolean;
  65825. /**
  65826. * Defines if the sheen is linked to the sheen color.
  65827. */
  65828. linkSheenWithAlbedo: boolean;
  65829. /**
  65830. * Initialize the block and prepare the context for build
  65831. * @param state defines the state that will be used for the build
  65832. */
  65833. initialize(state: NodeMaterialBuildState): void;
  65834. /**
  65835. * Gets the current class name
  65836. * @returns the class name
  65837. */
  65838. getClassName(): string;
  65839. /**
  65840. * Gets the intensity input component
  65841. */
  65842. get intensity(): NodeMaterialConnectionPoint;
  65843. /**
  65844. * Gets the color input component
  65845. */
  65846. get color(): NodeMaterialConnectionPoint;
  65847. /**
  65848. * Gets the roughness input component
  65849. */
  65850. get roughness(): NodeMaterialConnectionPoint;
  65851. /**
  65852. * Gets the sheen object output component
  65853. */
  65854. get sheen(): NodeMaterialConnectionPoint;
  65855. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65856. /**
  65857. * Gets the main code of the block (fragment side)
  65858. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  65859. * @returns the shader code
  65860. */
  65861. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  65862. protected _buildBlock(state: NodeMaterialBuildState): this;
  65863. protected _dumpPropertiesCode(): string;
  65864. serialize(): any;
  65865. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65866. }
  65867. }
  65868. declare module BABYLON {
  65869. /**
  65870. * Block used to implement the anisotropy module of the PBR material
  65871. */
  65872. export class AnisotropyBlock extends NodeMaterialBlock {
  65873. /**
  65874. * The two properties below are set by the main PBR block prior to calling methods of this class.
  65875. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  65876. * It's less burden on the user side in the editor part.
  65877. */
  65878. /** @hidden */
  65879. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  65880. /** @hidden */
  65881. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  65882. /**
  65883. * Create a new AnisotropyBlock
  65884. * @param name defines the block name
  65885. */
  65886. constructor(name: string);
  65887. /**
  65888. * Initialize the block and prepare the context for build
  65889. * @param state defines the state that will be used for the build
  65890. */
  65891. initialize(state: NodeMaterialBuildState): void;
  65892. /**
  65893. * Gets the current class name
  65894. * @returns the class name
  65895. */
  65896. getClassName(): string;
  65897. /**
  65898. * Gets the intensity input component
  65899. */
  65900. get intensity(): NodeMaterialConnectionPoint;
  65901. /**
  65902. * Gets the direction input component
  65903. */
  65904. get direction(): NodeMaterialConnectionPoint;
  65905. /**
  65906. * Gets the uv input component
  65907. */
  65908. get uv(): NodeMaterialConnectionPoint;
  65909. /**
  65910. * Gets the worldTangent input component
  65911. */
  65912. get worldTangent(): NodeMaterialConnectionPoint;
  65913. /**
  65914. * Gets the anisotropy object output component
  65915. */
  65916. get anisotropy(): NodeMaterialConnectionPoint;
  65917. private _generateTBNSpace;
  65918. /**
  65919. * Gets the main code of the block (fragment side)
  65920. * @param state current state of the node material building
  65921. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  65922. * @returns the shader code
  65923. */
  65924. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  65925. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65926. protected _buildBlock(state: NodeMaterialBuildState): this;
  65927. }
  65928. }
  65929. declare module BABYLON {
  65930. /**
  65931. * Block used to implement the clear coat module of the PBR material
  65932. */
  65933. export class ClearCoatBlock extends NodeMaterialBlock {
  65934. private _scene;
  65935. /**
  65936. * Create a new ClearCoatBlock
  65937. * @param name defines the block name
  65938. */
  65939. constructor(name: string);
  65940. /**
  65941. * Defines if the F0 value should be remapped to account for the interface change in the material.
  65942. */
  65943. remapF0OnInterfaceChange: boolean;
  65944. /**
  65945. * Initialize the block and prepare the context for build
  65946. * @param state defines the state that will be used for the build
  65947. */
  65948. initialize(state: NodeMaterialBuildState): void;
  65949. /**
  65950. * Gets the current class name
  65951. * @returns the class name
  65952. */
  65953. getClassName(): string;
  65954. /**
  65955. * Gets the intensity input component
  65956. */
  65957. get intensity(): NodeMaterialConnectionPoint;
  65958. /**
  65959. * Gets the roughness input component
  65960. */
  65961. get roughness(): NodeMaterialConnectionPoint;
  65962. /**
  65963. * Gets the ior input component
  65964. */
  65965. get indexOfRefraction(): NodeMaterialConnectionPoint;
  65966. /**
  65967. * Gets the bump texture input component
  65968. */
  65969. get normalMapColor(): NodeMaterialConnectionPoint;
  65970. /**
  65971. * Gets the uv input component
  65972. */
  65973. get uv(): NodeMaterialConnectionPoint;
  65974. /**
  65975. * Gets the tint color input component
  65976. */
  65977. get tintColor(): NodeMaterialConnectionPoint;
  65978. /**
  65979. * Gets the tint "at distance" input component
  65980. */
  65981. get tintAtDistance(): NodeMaterialConnectionPoint;
  65982. /**
  65983. * Gets the tint thickness input component
  65984. */
  65985. get tintThickness(): NodeMaterialConnectionPoint;
  65986. /**
  65987. * Gets the world tangent input component
  65988. */
  65989. get worldTangent(): NodeMaterialConnectionPoint;
  65990. /**
  65991. * Gets the clear coat object output component
  65992. */
  65993. get clearcoat(): NodeMaterialConnectionPoint;
  65994. autoConfigure(material: NodeMaterial): void;
  65995. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65996. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  65997. private _generateTBNSpace;
  65998. /**
  65999. * Gets the main code of the block (fragment side)
  66000. * @param state current state of the node material building
  66001. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  66002. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  66003. * @param worldPosVarName name of the variable holding the world position
  66004. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  66005. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  66006. * @param worldNormalVarName name of the variable holding the world normal
  66007. * @returns the shader code
  66008. */
  66009. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  66010. protected _buildBlock(state: NodeMaterialBuildState): this;
  66011. protected _dumpPropertiesCode(): string;
  66012. serialize(): any;
  66013. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66014. }
  66015. }
  66016. declare module BABYLON {
  66017. /**
  66018. * Block used to implement the sub surface module of the PBR material
  66019. */
  66020. export class SubSurfaceBlock extends NodeMaterialBlock {
  66021. /**
  66022. * Create a new SubSurfaceBlock
  66023. * @param name defines the block name
  66024. */
  66025. constructor(name: string);
  66026. /**
  66027. * Initialize the block and prepare the context for build
  66028. * @param state defines the state that will be used for the build
  66029. */
  66030. initialize(state: NodeMaterialBuildState): void;
  66031. /**
  66032. * Gets the current class name
  66033. * @returns the class name
  66034. */
  66035. getClassName(): string;
  66036. /**
  66037. * Gets the thickness component
  66038. */
  66039. get thickness(): NodeMaterialConnectionPoint;
  66040. /**
  66041. * Gets the tint color input component
  66042. */
  66043. get tintColor(): NodeMaterialConnectionPoint;
  66044. /**
  66045. * Gets the translucency intensity input component
  66046. */
  66047. get translucencyIntensity(): NodeMaterialConnectionPoint;
  66048. /**
  66049. * Gets the translucency diffusion distance input component
  66050. */
  66051. get translucencyDiffusionDist(): NodeMaterialConnectionPoint;
  66052. /**
  66053. * Gets the refraction object parameters
  66054. */
  66055. get refraction(): NodeMaterialConnectionPoint;
  66056. /**
  66057. * Gets the sub surface object output component
  66058. */
  66059. get subsurface(): NodeMaterialConnectionPoint;
  66060. autoConfigure(material: NodeMaterial): void;
  66061. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66062. /**
  66063. * Gets the main code of the block (fragment side)
  66064. * @param state current state of the node material building
  66065. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  66066. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  66067. * @param worldPosVarName name of the variable holding the world position
  66068. * @returns the shader code
  66069. */
  66070. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  66071. protected _buildBlock(state: NodeMaterialBuildState): this;
  66072. }
  66073. }
  66074. declare module BABYLON {
  66075. /**
  66076. * Block used to implement the PBR metallic/roughness model
  66077. */
  66078. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  66079. /**
  66080. * Gets or sets the light associated with this block
  66081. */
  66082. light: Nullable<Light>;
  66083. private _lightId;
  66084. private _scene;
  66085. private _environmentBRDFTexture;
  66086. private _environmentBrdfSamplerName;
  66087. private _vNormalWName;
  66088. private _invertNormalName;
  66089. private _metallicReflectanceColor;
  66090. private _metallicF0Factor;
  66091. private _vMetallicReflectanceFactorsName;
  66092. /**
  66093. * Create a new ReflectionBlock
  66094. * @param name defines the block name
  66095. */
  66096. constructor(name: string);
  66097. /**
  66098. * Intensity of the direct lights e.g. the four lights available in your scene.
  66099. * This impacts both the direct diffuse and specular highlights.
  66100. */
  66101. directIntensity: number;
  66102. /**
  66103. * Intensity of the environment e.g. how much the environment will light the object
  66104. * either through harmonics for rough material or through the refelction for shiny ones.
  66105. */
  66106. environmentIntensity: number;
  66107. /**
  66108. * This is a special control allowing the reduction of the specular highlights coming from the
  66109. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  66110. */
  66111. specularIntensity: number;
  66112. /**
  66113. * Defines the falloff type used in this material.
  66114. * It by default is Physical.
  66115. */
  66116. lightFalloff: number;
  66117. /**
  66118. * Specifies that alpha test should be used
  66119. */
  66120. useAlphaTest: boolean;
  66121. /**
  66122. * Defines the alpha limits in alpha test mode.
  66123. */
  66124. alphaTestCutoff: number;
  66125. /**
  66126. * Specifies that alpha blending should be used
  66127. */
  66128. useAlphaBlending: boolean;
  66129. /**
  66130. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  66131. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  66132. */
  66133. useRadianceOverAlpha: boolean;
  66134. /**
  66135. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  66136. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  66137. */
  66138. useSpecularOverAlpha: boolean;
  66139. /**
  66140. * Enables specular anti aliasing in the PBR shader.
  66141. * It will both interacts on the Geometry for analytical and IBL lighting.
  66142. * It also prefilter the roughness map based on the bump values.
  66143. */
  66144. enableSpecularAntiAliasing: boolean;
  66145. /**
  66146. * Enables realtime filtering on the texture.
  66147. */
  66148. realTimeFiltering: boolean;
  66149. /**
  66150. * Quality switch for realtime filtering
  66151. */
  66152. realTimeFilteringQuality: number;
  66153. /**
  66154. * Defines if the material uses energy conservation.
  66155. */
  66156. useEnergyConservation: boolean;
  66157. /**
  66158. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  66159. * too much the area relying on ambient texture to define their ambient occlusion.
  66160. */
  66161. useRadianceOcclusion: boolean;
  66162. /**
  66163. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  66164. * makes the reflect vector face the model (under horizon).
  66165. */
  66166. useHorizonOcclusion: boolean;
  66167. /**
  66168. * If set to true, no lighting calculations will be applied.
  66169. */
  66170. unlit: boolean;
  66171. /**
  66172. * Force normal to face away from face.
  66173. */
  66174. forceNormalForward: boolean;
  66175. /**
  66176. * Defines the material debug mode.
  66177. * It helps seeing only some components of the material while troubleshooting.
  66178. */
  66179. debugMode: number;
  66180. /**
  66181. * Specify from where on screen the debug mode should start.
  66182. * The value goes from -1 (full screen) to 1 (not visible)
  66183. * It helps with side by side comparison against the final render
  66184. * This defaults to 0
  66185. */
  66186. debugLimit: number;
  66187. /**
  66188. * As the default viewing range might not be enough (if the ambient is really small for instance)
  66189. * You can use the factor to better multiply the final value.
  66190. */
  66191. debugFactor: number;
  66192. /**
  66193. * Initialize the block and prepare the context for build
  66194. * @param state defines the state that will be used for the build
  66195. */
  66196. initialize(state: NodeMaterialBuildState): void;
  66197. /**
  66198. * Gets the current class name
  66199. * @returns the class name
  66200. */
  66201. getClassName(): string;
  66202. /**
  66203. * Gets the world position input component
  66204. */
  66205. get worldPosition(): NodeMaterialConnectionPoint;
  66206. /**
  66207. * Gets the world normal input component
  66208. */
  66209. get worldNormal(): NodeMaterialConnectionPoint;
  66210. /**
  66211. * Gets the view matrix parameter
  66212. */
  66213. get view(): NodeMaterialConnectionPoint;
  66214. /**
  66215. * Gets the camera position input component
  66216. */
  66217. get cameraPosition(): NodeMaterialConnectionPoint;
  66218. /**
  66219. * Gets the perturbed normal input component
  66220. */
  66221. get perturbedNormal(): NodeMaterialConnectionPoint;
  66222. /**
  66223. * Gets the base color input component
  66224. */
  66225. get baseColor(): NodeMaterialConnectionPoint;
  66226. /**
  66227. * Gets the metallic input component
  66228. */
  66229. get metallic(): NodeMaterialConnectionPoint;
  66230. /**
  66231. * Gets the roughness input component
  66232. */
  66233. get roughness(): NodeMaterialConnectionPoint;
  66234. /**
  66235. * Gets the ambient occlusion input component
  66236. */
  66237. get ambientOcc(): NodeMaterialConnectionPoint;
  66238. /**
  66239. * Gets the opacity input component
  66240. */
  66241. get opacity(): NodeMaterialConnectionPoint;
  66242. /**
  66243. * Gets the index of refraction input component
  66244. */
  66245. get indexOfRefraction(): NodeMaterialConnectionPoint;
  66246. /**
  66247. * Gets the ambient color input component
  66248. */
  66249. get ambientColor(): NodeMaterialConnectionPoint;
  66250. /**
  66251. * Gets the reflection object parameters
  66252. */
  66253. get reflection(): NodeMaterialConnectionPoint;
  66254. /**
  66255. * Gets the clear coat object parameters
  66256. */
  66257. get clearcoat(): NodeMaterialConnectionPoint;
  66258. /**
  66259. * Gets the sheen object parameters
  66260. */
  66261. get sheen(): NodeMaterialConnectionPoint;
  66262. /**
  66263. * Gets the sub surface object parameters
  66264. */
  66265. get subsurface(): NodeMaterialConnectionPoint;
  66266. /**
  66267. * Gets the anisotropy object parameters
  66268. */
  66269. get anisotropy(): NodeMaterialConnectionPoint;
  66270. /**
  66271. * Gets the ambient output component
  66272. */
  66273. get ambientClr(): NodeMaterialConnectionPoint;
  66274. /**
  66275. * Gets the diffuse output component
  66276. */
  66277. get diffuseDir(): NodeMaterialConnectionPoint;
  66278. /**
  66279. * Gets the specular output component
  66280. */
  66281. get specularDir(): NodeMaterialConnectionPoint;
  66282. /**
  66283. * Gets the clear coat output component
  66284. */
  66285. get clearcoatDir(): NodeMaterialConnectionPoint;
  66286. /**
  66287. * Gets the sheen output component
  66288. */
  66289. get sheenDir(): NodeMaterialConnectionPoint;
  66290. /**
  66291. * Gets the indirect diffuse output component
  66292. */
  66293. get diffuseIndirect(): NodeMaterialConnectionPoint;
  66294. /**
  66295. * Gets the indirect specular output component
  66296. */
  66297. get specularIndirect(): NodeMaterialConnectionPoint;
  66298. /**
  66299. * Gets the indirect clear coat output component
  66300. */
  66301. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  66302. /**
  66303. * Gets the indirect sheen output component
  66304. */
  66305. get sheenIndirect(): NodeMaterialConnectionPoint;
  66306. /**
  66307. * Gets the refraction output component
  66308. */
  66309. get refraction(): NodeMaterialConnectionPoint;
  66310. /**
  66311. * Gets the global lighting output component
  66312. */
  66313. get lighting(): NodeMaterialConnectionPoint;
  66314. /**
  66315. * Gets the shadow output component
  66316. */
  66317. get shadow(): NodeMaterialConnectionPoint;
  66318. /**
  66319. * Gets the alpha output component
  66320. */
  66321. get alpha(): NodeMaterialConnectionPoint;
  66322. autoConfigure(material: NodeMaterial): void;
  66323. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  66324. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  66325. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  66326. private _injectVertexCode;
  66327. private _getAlbedoOpacityCode;
  66328. private _getAmbientOcclusionCode;
  66329. private _getReflectivityCode;
  66330. protected _buildBlock(state: NodeMaterialBuildState): this;
  66331. protected _dumpPropertiesCode(): string;
  66332. serialize(): any;
  66333. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66334. }
  66335. }
  66336. declare module BABYLON {
  66337. /**
  66338. * Block used to compute value of one parameter modulo another
  66339. */
  66340. export class ModBlock extends NodeMaterialBlock {
  66341. /**
  66342. * Creates a new ModBlock
  66343. * @param name defines the block name
  66344. */
  66345. constructor(name: string);
  66346. /**
  66347. * Gets the current class name
  66348. * @returns the class name
  66349. */
  66350. getClassName(): string;
  66351. /**
  66352. * Gets the left operand input component
  66353. */
  66354. get left(): NodeMaterialConnectionPoint;
  66355. /**
  66356. * Gets the right operand input component
  66357. */
  66358. get right(): NodeMaterialConnectionPoint;
  66359. /**
  66360. * Gets the output component
  66361. */
  66362. get output(): NodeMaterialConnectionPoint;
  66363. protected _buildBlock(state: NodeMaterialBuildState): this;
  66364. }
  66365. }
  66366. declare module BABYLON {
  66367. /**
  66368. * Configuration for Draco compression
  66369. */
  66370. export interface IDracoCompressionConfiguration {
  66371. /**
  66372. * Configuration for the decoder.
  66373. */
  66374. decoder: {
  66375. /**
  66376. * The url to the WebAssembly module.
  66377. */
  66378. wasmUrl?: string;
  66379. /**
  66380. * The url to the WebAssembly binary.
  66381. */
  66382. wasmBinaryUrl?: string;
  66383. /**
  66384. * The url to the fallback JavaScript module.
  66385. */
  66386. fallbackUrl?: string;
  66387. };
  66388. }
  66389. /**
  66390. * Draco compression (https://google.github.io/draco/)
  66391. *
  66392. * This class wraps the Draco module.
  66393. *
  66394. * **Encoder**
  66395. *
  66396. * The encoder is not currently implemented.
  66397. *
  66398. * **Decoder**
  66399. *
  66400. * 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.
  66401. *
  66402. * To update the configuration, use the following code:
  66403. * ```javascript
  66404. * DracoCompression.Configuration = {
  66405. * decoder: {
  66406. * wasmUrl: "<url to the WebAssembly library>",
  66407. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  66408. * fallbackUrl: "<url to the fallback JavaScript library>",
  66409. * }
  66410. * };
  66411. * ```
  66412. *
  66413. * 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.
  66414. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  66415. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  66416. *
  66417. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  66418. * ```javascript
  66419. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  66420. * ```
  66421. *
  66422. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  66423. */
  66424. export class DracoCompression implements IDisposable {
  66425. private _workerPoolPromise?;
  66426. private _decoderModulePromise?;
  66427. /**
  66428. * The configuration. Defaults to the following urls:
  66429. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  66430. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  66431. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  66432. */
  66433. static Configuration: IDracoCompressionConfiguration;
  66434. /**
  66435. * Returns true if the decoder configuration is available.
  66436. */
  66437. static get DecoderAvailable(): boolean;
  66438. /**
  66439. * Default number of workers to create when creating the draco compression object.
  66440. */
  66441. static DefaultNumWorkers: number;
  66442. private static GetDefaultNumWorkers;
  66443. private static _Default;
  66444. /**
  66445. * Default instance for the draco compression object.
  66446. */
  66447. static get Default(): DracoCompression;
  66448. /**
  66449. * Constructor
  66450. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  66451. */
  66452. constructor(numWorkers?: number);
  66453. /**
  66454. * Stop all async operations and release resources.
  66455. */
  66456. dispose(): void;
  66457. /**
  66458. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  66459. * @returns a promise that resolves when ready
  66460. */
  66461. whenReadyAsync(): Promise<void>;
  66462. /**
  66463. * Decode Draco compressed mesh data to vertex data.
  66464. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  66465. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  66466. * @returns A promise that resolves with the decoded vertex data
  66467. */
  66468. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  66469. [kind: string]: number;
  66470. }): Promise<VertexData>;
  66471. }
  66472. }
  66473. declare module BABYLON {
  66474. /**
  66475. * Class for building Constructive Solid Geometry
  66476. */
  66477. export class CSG {
  66478. private polygons;
  66479. /**
  66480. * The world matrix
  66481. */
  66482. matrix: Matrix;
  66483. /**
  66484. * Stores the position
  66485. */
  66486. position: Vector3;
  66487. /**
  66488. * Stores the rotation
  66489. */
  66490. rotation: Vector3;
  66491. /**
  66492. * Stores the rotation quaternion
  66493. */
  66494. rotationQuaternion: Nullable<Quaternion>;
  66495. /**
  66496. * Stores the scaling vector
  66497. */
  66498. scaling: Vector3;
  66499. /**
  66500. * Convert the Mesh to CSG
  66501. * @param mesh The Mesh to convert to CSG
  66502. * @returns A new CSG from the Mesh
  66503. */
  66504. static FromMesh(mesh: Mesh): CSG;
  66505. /**
  66506. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  66507. * @param polygons Polygons used to construct a CSG solid
  66508. */
  66509. private static FromPolygons;
  66510. /**
  66511. * Clones, or makes a deep copy, of the CSG
  66512. * @returns A new CSG
  66513. */
  66514. clone(): CSG;
  66515. /**
  66516. * Unions this CSG with another CSG
  66517. * @param csg The CSG to union against this CSG
  66518. * @returns The unioned CSG
  66519. */
  66520. union(csg: CSG): CSG;
  66521. /**
  66522. * Unions this CSG with another CSG in place
  66523. * @param csg The CSG to union against this CSG
  66524. */
  66525. unionInPlace(csg: CSG): void;
  66526. /**
  66527. * Subtracts this CSG with another CSG
  66528. * @param csg The CSG to subtract against this CSG
  66529. * @returns A new CSG
  66530. */
  66531. subtract(csg: CSG): CSG;
  66532. /**
  66533. * Subtracts this CSG with another CSG in place
  66534. * @param csg The CSG to subtact against this CSG
  66535. */
  66536. subtractInPlace(csg: CSG): void;
  66537. /**
  66538. * Intersect this CSG with another CSG
  66539. * @param csg The CSG to intersect against this CSG
  66540. * @returns A new CSG
  66541. */
  66542. intersect(csg: CSG): CSG;
  66543. /**
  66544. * Intersects this CSG with another CSG in place
  66545. * @param csg The CSG to intersect against this CSG
  66546. */
  66547. intersectInPlace(csg: CSG): void;
  66548. /**
  66549. * Return a new CSG solid with solid and empty space switched. This solid is
  66550. * not modified.
  66551. * @returns A new CSG solid with solid and empty space switched
  66552. */
  66553. inverse(): CSG;
  66554. /**
  66555. * Inverses the CSG in place
  66556. */
  66557. inverseInPlace(): void;
  66558. /**
  66559. * This is used to keep meshes transformations so they can be restored
  66560. * when we build back a Babylon Mesh
  66561. * NB : All CSG operations are performed in world coordinates
  66562. * @param csg The CSG to copy the transform attributes from
  66563. * @returns This CSG
  66564. */
  66565. copyTransformAttributes(csg: CSG): CSG;
  66566. /**
  66567. * Build Raw mesh from CSG
  66568. * Coordinates here are in world space
  66569. * @param name The name of the mesh geometry
  66570. * @param scene The Scene
  66571. * @param keepSubMeshes Specifies if the submeshes should be kept
  66572. * @returns A new Mesh
  66573. */
  66574. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  66575. /**
  66576. * Build Mesh from CSG taking material and transforms into account
  66577. * @param name The name of the Mesh
  66578. * @param material The material of the Mesh
  66579. * @param scene The Scene
  66580. * @param keepSubMeshes Specifies if submeshes should be kept
  66581. * @returns The new Mesh
  66582. */
  66583. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  66584. }
  66585. }
  66586. declare module BABYLON {
  66587. /**
  66588. * Class used to create a trail following a mesh
  66589. */
  66590. export class TrailMesh extends Mesh {
  66591. private _generator;
  66592. private _autoStart;
  66593. private _running;
  66594. private _diameter;
  66595. private _length;
  66596. private _sectionPolygonPointsCount;
  66597. private _sectionVectors;
  66598. private _sectionNormalVectors;
  66599. private _beforeRenderObserver;
  66600. /**
  66601. * @constructor
  66602. * @param name The value used by scene.getMeshByName() to do a lookup.
  66603. * @param generator The mesh or transform node to generate a trail.
  66604. * @param scene The scene to add this mesh to.
  66605. * @param diameter Diameter of trailing mesh. Default is 1.
  66606. * @param length Length of trailing mesh. Default is 60.
  66607. * @param autoStart Automatically start trailing mesh. Default true.
  66608. */
  66609. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  66610. /**
  66611. * "TrailMesh"
  66612. * @returns "TrailMesh"
  66613. */
  66614. getClassName(): string;
  66615. private _createMesh;
  66616. /**
  66617. * Start trailing mesh.
  66618. */
  66619. start(): void;
  66620. /**
  66621. * Stop trailing mesh.
  66622. */
  66623. stop(): void;
  66624. /**
  66625. * Update trailing mesh geometry.
  66626. */
  66627. update(): void;
  66628. /**
  66629. * Returns a new TrailMesh object.
  66630. * @param name is a string, the name given to the new mesh
  66631. * @param newGenerator use new generator object for cloned trail mesh
  66632. * @returns a new mesh
  66633. */
  66634. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  66635. /**
  66636. * Serializes this trail mesh
  66637. * @param serializationObject object to write serialization to
  66638. */
  66639. serialize(serializationObject: any): void;
  66640. /**
  66641. * Parses a serialized trail mesh
  66642. * @param parsedMesh the serialized mesh
  66643. * @param scene the scene to create the trail mesh in
  66644. * @returns the created trail mesh
  66645. */
  66646. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  66647. }
  66648. }
  66649. declare module BABYLON {
  66650. /**
  66651. * Class containing static functions to help procedurally build meshes
  66652. */
  66653. export class TiledBoxBuilder {
  66654. /**
  66655. * Creates a box mesh
  66656. * 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)
  66657. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  66658. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  66659. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  66660. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  66661. * @param name defines the name of the mesh
  66662. * @param options defines the options used to create the mesh
  66663. * @param scene defines the hosting scene
  66664. * @returns the box mesh
  66665. */
  66666. static CreateTiledBox(name: string, options: {
  66667. pattern?: number;
  66668. width?: number;
  66669. height?: number;
  66670. depth?: number;
  66671. tileSize?: number;
  66672. tileWidth?: number;
  66673. tileHeight?: number;
  66674. alignHorizontal?: number;
  66675. alignVertical?: number;
  66676. faceUV?: Vector4[];
  66677. faceColors?: Color4[];
  66678. sideOrientation?: number;
  66679. updatable?: boolean;
  66680. }, scene?: Nullable<Scene>): Mesh;
  66681. }
  66682. }
  66683. declare module BABYLON {
  66684. /**
  66685. * Class containing static functions to help procedurally build meshes
  66686. */
  66687. export class TorusKnotBuilder {
  66688. /**
  66689. * Creates a torus knot mesh
  66690. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  66691. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  66692. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  66693. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  66694. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  66695. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  66696. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  66697. * @param name defines the name of the mesh
  66698. * @param options defines the options used to create the mesh
  66699. * @param scene defines the hosting scene
  66700. * @returns the torus knot mesh
  66701. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  66702. */
  66703. static CreateTorusKnot(name: string, options: {
  66704. radius?: number;
  66705. tube?: number;
  66706. radialSegments?: number;
  66707. tubularSegments?: number;
  66708. p?: number;
  66709. q?: number;
  66710. updatable?: boolean;
  66711. sideOrientation?: number;
  66712. frontUVs?: Vector4;
  66713. backUVs?: Vector4;
  66714. }, scene: any): Mesh;
  66715. }
  66716. }
  66717. declare module BABYLON {
  66718. /**
  66719. * Polygon
  66720. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  66721. */
  66722. export class Polygon {
  66723. /**
  66724. * Creates a rectangle
  66725. * @param xmin bottom X coord
  66726. * @param ymin bottom Y coord
  66727. * @param xmax top X coord
  66728. * @param ymax top Y coord
  66729. * @returns points that make the resulting rectation
  66730. */
  66731. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  66732. /**
  66733. * Creates a circle
  66734. * @param radius radius of circle
  66735. * @param cx scale in x
  66736. * @param cy scale in y
  66737. * @param numberOfSides number of sides that make up the circle
  66738. * @returns points that make the resulting circle
  66739. */
  66740. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  66741. /**
  66742. * Creates a polygon from input string
  66743. * @param input Input polygon data
  66744. * @returns the parsed points
  66745. */
  66746. static Parse(input: string): Vector2[];
  66747. /**
  66748. * Starts building a polygon from x and y coordinates
  66749. * @param x x coordinate
  66750. * @param y y coordinate
  66751. * @returns the started path2
  66752. */
  66753. static StartingAt(x: number, y: number): Path2;
  66754. }
  66755. /**
  66756. * Builds a polygon
  66757. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  66758. */
  66759. export class PolygonMeshBuilder {
  66760. private _points;
  66761. private _outlinepoints;
  66762. private _holes;
  66763. private _name;
  66764. private _scene;
  66765. private _epoints;
  66766. private _eholes;
  66767. private _addToepoint;
  66768. /**
  66769. * Babylon reference to the earcut plugin.
  66770. */
  66771. bjsEarcut: any;
  66772. /**
  66773. * Creates a PolygonMeshBuilder
  66774. * @param name name of the builder
  66775. * @param contours Path of the polygon
  66776. * @param scene scene to add to when creating the mesh
  66777. * @param earcutInjection can be used to inject your own earcut reference
  66778. */
  66779. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  66780. /**
  66781. * Adds a whole within the polygon
  66782. * @param hole Array of points defining the hole
  66783. * @returns this
  66784. */
  66785. addHole(hole: Vector2[]): PolygonMeshBuilder;
  66786. /**
  66787. * Creates the polygon
  66788. * @param updatable If the mesh should be updatable
  66789. * @param depth The depth of the mesh created
  66790. * @returns the created mesh
  66791. */
  66792. build(updatable?: boolean, depth?: number): Mesh;
  66793. /**
  66794. * Creates the polygon
  66795. * @param depth The depth of the mesh created
  66796. * @returns the created VertexData
  66797. */
  66798. buildVertexData(depth?: number): VertexData;
  66799. /**
  66800. * Adds a side to the polygon
  66801. * @param positions points that make the polygon
  66802. * @param normals normals of the polygon
  66803. * @param uvs uvs of the polygon
  66804. * @param indices indices of the polygon
  66805. * @param bounds bounds of the polygon
  66806. * @param points points of the polygon
  66807. * @param depth depth of the polygon
  66808. * @param flip flip of the polygon
  66809. */
  66810. private addSide;
  66811. }
  66812. }
  66813. declare module BABYLON {
  66814. /**
  66815. * Class containing static functions to help procedurally build meshes
  66816. */
  66817. export class PolygonBuilder {
  66818. /**
  66819. * Creates a polygon mesh
  66820. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  66821. * * 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
  66822. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  66823. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  66824. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  66825. * * Remember you can only change the shape positions, not their number when updating a polygon
  66826. * @param name defines the name of the mesh
  66827. * @param options defines the options used to create the mesh
  66828. * @param scene defines the hosting scene
  66829. * @param earcutInjection can be used to inject your own earcut reference
  66830. * @returns the polygon mesh
  66831. */
  66832. static CreatePolygon(name: string, options: {
  66833. shape: Vector3[];
  66834. holes?: Vector3[][];
  66835. depth?: number;
  66836. faceUV?: Vector4[];
  66837. faceColors?: Color4[];
  66838. updatable?: boolean;
  66839. sideOrientation?: number;
  66840. frontUVs?: Vector4;
  66841. backUVs?: Vector4;
  66842. wrap?: boolean;
  66843. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  66844. /**
  66845. * Creates an extruded polygon mesh, with depth in the Y direction.
  66846. * * 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)
  66847. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  66848. * @param name defines the name of the mesh
  66849. * @param options defines the options used to create the mesh
  66850. * @param scene defines the hosting scene
  66851. * @param earcutInjection can be used to inject your own earcut reference
  66852. * @returns the polygon mesh
  66853. */
  66854. static ExtrudePolygon(name: string, options: {
  66855. shape: Vector3[];
  66856. holes?: Vector3[][];
  66857. depth?: number;
  66858. faceUV?: Vector4[];
  66859. faceColors?: Color4[];
  66860. updatable?: boolean;
  66861. sideOrientation?: number;
  66862. frontUVs?: Vector4;
  66863. backUVs?: Vector4;
  66864. wrap?: boolean;
  66865. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  66866. }
  66867. }
  66868. declare module BABYLON {
  66869. /**
  66870. * Class containing static functions to help procedurally build meshes
  66871. */
  66872. export class LatheBuilder {
  66873. /**
  66874. * Creates lathe mesh.
  66875. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  66876. * * 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
  66877. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  66878. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  66879. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  66880. * * 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
  66881. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  66882. * * 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
  66883. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  66884. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  66885. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  66886. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  66887. * @param name defines the name of the mesh
  66888. * @param options defines the options used to create the mesh
  66889. * @param scene defines the hosting scene
  66890. * @returns the lathe mesh
  66891. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  66892. */
  66893. static CreateLathe(name: string, options: {
  66894. shape: Vector3[];
  66895. radius?: number;
  66896. tessellation?: number;
  66897. clip?: number;
  66898. arc?: number;
  66899. closed?: boolean;
  66900. updatable?: boolean;
  66901. sideOrientation?: number;
  66902. frontUVs?: Vector4;
  66903. backUVs?: Vector4;
  66904. cap?: number;
  66905. invertUV?: boolean;
  66906. }, scene?: Nullable<Scene>): Mesh;
  66907. }
  66908. }
  66909. declare module BABYLON {
  66910. /**
  66911. * Class containing static functions to help procedurally build meshes
  66912. */
  66913. export class TiledPlaneBuilder {
  66914. /**
  66915. * Creates a tiled plane mesh
  66916. * * The parameter `pattern` will, depending on value, do nothing or
  66917. * * * flip (reflect about central vertical) alternate tiles across and up
  66918. * * * flip every tile on alternate rows
  66919. * * * rotate (180 degs) alternate tiles across and up
  66920. * * * rotate every tile on alternate rows
  66921. * * * flip and rotate alternate tiles across and up
  66922. * * * flip and rotate every tile on alternate rows
  66923. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  66924. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  66925. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  66926. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  66927. * * 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)
  66928. * * 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)
  66929. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  66930. * @param name defines the name of the mesh
  66931. * @param options defines the options used to create the mesh
  66932. * @param scene defines the hosting scene
  66933. * @returns the box mesh
  66934. */
  66935. static CreateTiledPlane(name: string, options: {
  66936. pattern?: number;
  66937. tileSize?: number;
  66938. tileWidth?: number;
  66939. tileHeight?: number;
  66940. size?: number;
  66941. width?: number;
  66942. height?: number;
  66943. alignHorizontal?: number;
  66944. alignVertical?: number;
  66945. sideOrientation?: number;
  66946. frontUVs?: Vector4;
  66947. backUVs?: Vector4;
  66948. updatable?: boolean;
  66949. }, scene?: Nullable<Scene>): Mesh;
  66950. }
  66951. }
  66952. declare module BABYLON {
  66953. /**
  66954. * Class containing static functions to help procedurally build meshes
  66955. */
  66956. export class TubeBuilder {
  66957. /**
  66958. * Creates a tube mesh.
  66959. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  66960. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  66961. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  66962. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  66963. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  66964. * * 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)
  66965. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  66966. * * 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
  66967. * * 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
  66968. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  66969. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  66970. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  66971. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  66972. * @param name defines the name of the mesh
  66973. * @param options defines the options used to create the mesh
  66974. * @param scene defines the hosting scene
  66975. * @returns the tube mesh
  66976. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  66977. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  66978. */
  66979. static CreateTube(name: string, options: {
  66980. path: Vector3[];
  66981. radius?: number;
  66982. tessellation?: number;
  66983. radiusFunction?: {
  66984. (i: number, distance: number): number;
  66985. };
  66986. cap?: number;
  66987. arc?: number;
  66988. updatable?: boolean;
  66989. sideOrientation?: number;
  66990. frontUVs?: Vector4;
  66991. backUVs?: Vector4;
  66992. instance?: Mesh;
  66993. invertUV?: boolean;
  66994. }, scene?: Nullable<Scene>): Mesh;
  66995. }
  66996. }
  66997. declare module BABYLON {
  66998. /**
  66999. * Class containing static functions to help procedurally build meshes
  67000. */
  67001. export class IcoSphereBuilder {
  67002. /**
  67003. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  67004. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  67005. * * 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`)
  67006. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  67007. * * 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
  67008. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67009. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67010. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67011. * @param name defines the name of the mesh
  67012. * @param options defines the options used to create the mesh
  67013. * @param scene defines the hosting scene
  67014. * @returns the icosahedron mesh
  67015. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  67016. */
  67017. static CreateIcoSphere(name: string, options: {
  67018. radius?: number;
  67019. radiusX?: number;
  67020. radiusY?: number;
  67021. radiusZ?: number;
  67022. flat?: boolean;
  67023. subdivisions?: number;
  67024. sideOrientation?: number;
  67025. frontUVs?: Vector4;
  67026. backUVs?: Vector4;
  67027. updatable?: boolean;
  67028. }, scene?: Nullable<Scene>): Mesh;
  67029. }
  67030. }
  67031. declare module BABYLON {
  67032. /**
  67033. * Class containing static functions to help procedurally build meshes
  67034. */
  67035. export class DecalBuilder {
  67036. /**
  67037. * Creates a decal mesh.
  67038. * 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
  67039. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  67040. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  67041. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  67042. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  67043. * @param name defines the name of the mesh
  67044. * @param sourceMesh defines the mesh where the decal must be applied
  67045. * @param options defines the options used to create the mesh
  67046. * @param scene defines the hosting scene
  67047. * @returns the decal mesh
  67048. * @see https://doc.babylonjs.com/how_to/decals
  67049. */
  67050. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  67051. position?: Vector3;
  67052. normal?: Vector3;
  67053. size?: Vector3;
  67054. angle?: number;
  67055. }): Mesh;
  67056. }
  67057. }
  67058. declare module BABYLON {
  67059. /**
  67060. * Class containing static functions to help procedurally build meshes
  67061. */
  67062. export class MeshBuilder {
  67063. /**
  67064. * Creates a box mesh
  67065. * * The parameter `size` sets the size (float) of each box side (default 1)
  67066. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  67067. * * 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)
  67068. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  67069. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67070. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67071. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67072. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  67073. * @param name defines the name of the mesh
  67074. * @param options defines the options used to create the mesh
  67075. * @param scene defines the hosting scene
  67076. * @returns the box mesh
  67077. */
  67078. static CreateBox(name: string, options: {
  67079. size?: number;
  67080. width?: number;
  67081. height?: number;
  67082. depth?: number;
  67083. faceUV?: Vector4[];
  67084. faceColors?: Color4[];
  67085. sideOrientation?: number;
  67086. frontUVs?: Vector4;
  67087. backUVs?: Vector4;
  67088. wrap?: boolean;
  67089. topBaseAt?: number;
  67090. bottomBaseAt?: number;
  67091. updatable?: boolean;
  67092. }, scene?: Nullable<Scene>): Mesh;
  67093. /**
  67094. * Creates a tiled box mesh
  67095. * * faceTiles sets the pattern, tile size and number of tiles for a face
  67096. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67097. * @param name defines the name of the mesh
  67098. * @param options defines the options used to create the mesh
  67099. * @param scene defines the hosting scene
  67100. * @returns the tiled box mesh
  67101. */
  67102. static CreateTiledBox(name: string, options: {
  67103. pattern?: number;
  67104. size?: number;
  67105. width?: number;
  67106. height?: number;
  67107. depth: number;
  67108. tileSize?: number;
  67109. tileWidth?: number;
  67110. tileHeight?: number;
  67111. faceUV?: Vector4[];
  67112. faceColors?: Color4[];
  67113. alignHorizontal?: number;
  67114. alignVertical?: number;
  67115. sideOrientation?: number;
  67116. updatable?: boolean;
  67117. }, scene?: Nullable<Scene>): Mesh;
  67118. /**
  67119. * Creates a sphere mesh
  67120. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  67121. * * 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`)
  67122. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  67123. * * 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
  67124. * * 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)
  67125. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67126. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67127. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67128. * @param name defines the name of the mesh
  67129. * @param options defines the options used to create the mesh
  67130. * @param scene defines the hosting scene
  67131. * @returns the sphere mesh
  67132. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  67133. */
  67134. static CreateSphere(name: string, options: {
  67135. segments?: number;
  67136. diameter?: number;
  67137. diameterX?: number;
  67138. diameterY?: number;
  67139. diameterZ?: number;
  67140. arc?: number;
  67141. slice?: number;
  67142. sideOrientation?: number;
  67143. frontUVs?: Vector4;
  67144. backUVs?: Vector4;
  67145. updatable?: boolean;
  67146. }, scene?: Nullable<Scene>): Mesh;
  67147. /**
  67148. * Creates a plane polygonal mesh. By default, this is a disc
  67149. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  67150. * * 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
  67151. * * 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
  67152. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67153. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67154. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67155. * @param name defines the name of the mesh
  67156. * @param options defines the options used to create the mesh
  67157. * @param scene defines the hosting scene
  67158. * @returns the plane polygonal mesh
  67159. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  67160. */
  67161. static CreateDisc(name: string, options: {
  67162. radius?: number;
  67163. tessellation?: number;
  67164. arc?: number;
  67165. updatable?: boolean;
  67166. sideOrientation?: number;
  67167. frontUVs?: Vector4;
  67168. backUVs?: Vector4;
  67169. }, scene?: Nullable<Scene>): Mesh;
  67170. /**
  67171. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  67172. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  67173. * * 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`)
  67174. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  67175. * * 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
  67176. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67177. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67178. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67179. * @param name defines the name of the mesh
  67180. * @param options defines the options used to create the mesh
  67181. * @param scene defines the hosting scene
  67182. * @returns the icosahedron mesh
  67183. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  67184. */
  67185. static CreateIcoSphere(name: string, options: {
  67186. radius?: number;
  67187. radiusX?: number;
  67188. radiusY?: number;
  67189. radiusZ?: number;
  67190. flat?: boolean;
  67191. subdivisions?: number;
  67192. sideOrientation?: number;
  67193. frontUVs?: Vector4;
  67194. backUVs?: Vector4;
  67195. updatable?: boolean;
  67196. }, scene?: Nullable<Scene>): Mesh;
  67197. /**
  67198. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  67199. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  67200. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  67201. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  67202. * * 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
  67203. * * 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
  67204. * * 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
  67205. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67206. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67207. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  67208. * * 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
  67209. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  67210. * * 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
  67211. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  67212. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67213. * @param name defines the name of the mesh
  67214. * @param options defines the options used to create the mesh
  67215. * @param scene defines the hosting scene
  67216. * @returns the ribbon mesh
  67217. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  67218. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  67219. */
  67220. static CreateRibbon(name: string, options: {
  67221. pathArray: Vector3[][];
  67222. closeArray?: boolean;
  67223. closePath?: boolean;
  67224. offset?: number;
  67225. updatable?: boolean;
  67226. sideOrientation?: number;
  67227. frontUVs?: Vector4;
  67228. backUVs?: Vector4;
  67229. instance?: Mesh;
  67230. invertUV?: boolean;
  67231. uvs?: Vector2[];
  67232. colors?: Color4[];
  67233. }, scene?: Nullable<Scene>): Mesh;
  67234. /**
  67235. * Creates a cylinder or a cone mesh
  67236. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  67237. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  67238. * * 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.
  67239. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  67240. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  67241. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  67242. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  67243. * * 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).
  67244. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  67245. * * 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).
  67246. * * 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
  67247. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  67248. * * 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
  67249. * * 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.
  67250. * * If `enclose` is false, a ring surface is one element.
  67251. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  67252. * * 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
  67253. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67254. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67255. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  67256. * @param name defines the name of the mesh
  67257. * @param options defines the options used to create the mesh
  67258. * @param scene defines the hosting scene
  67259. * @returns the cylinder mesh
  67260. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  67261. */
  67262. static CreateCylinder(name: string, options: {
  67263. height?: number;
  67264. diameterTop?: number;
  67265. diameterBottom?: number;
  67266. diameter?: number;
  67267. tessellation?: number;
  67268. subdivisions?: number;
  67269. arc?: number;
  67270. faceColors?: Color4[];
  67271. faceUV?: Vector4[];
  67272. updatable?: boolean;
  67273. hasRings?: boolean;
  67274. enclose?: boolean;
  67275. cap?: number;
  67276. sideOrientation?: number;
  67277. frontUVs?: Vector4;
  67278. backUVs?: Vector4;
  67279. }, scene?: Nullable<Scene>): Mesh;
  67280. /**
  67281. * Creates a torus mesh
  67282. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  67283. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  67284. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  67285. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67286. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67287. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  67288. * @param name defines the name of the mesh
  67289. * @param options defines the options used to create the mesh
  67290. * @param scene defines the hosting scene
  67291. * @returns the torus mesh
  67292. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  67293. */
  67294. static CreateTorus(name: string, options: {
  67295. diameter?: number;
  67296. thickness?: number;
  67297. tessellation?: number;
  67298. updatable?: boolean;
  67299. sideOrientation?: number;
  67300. frontUVs?: Vector4;
  67301. backUVs?: Vector4;
  67302. }, scene?: Nullable<Scene>): Mesh;
  67303. /**
  67304. * Creates a torus knot mesh
  67305. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  67306. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  67307. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  67308. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  67309. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67310. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67311. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  67312. * @param name defines the name of the mesh
  67313. * @param options defines the options used to create the mesh
  67314. * @param scene defines the hosting scene
  67315. * @returns the torus knot mesh
  67316. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  67317. */
  67318. static CreateTorusKnot(name: string, options: {
  67319. radius?: number;
  67320. tube?: number;
  67321. radialSegments?: number;
  67322. tubularSegments?: number;
  67323. p?: number;
  67324. q?: number;
  67325. updatable?: boolean;
  67326. sideOrientation?: number;
  67327. frontUVs?: Vector4;
  67328. backUVs?: Vector4;
  67329. }, scene?: Nullable<Scene>): Mesh;
  67330. /**
  67331. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  67332. * * 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
  67333. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  67334. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  67335. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  67336. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  67337. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  67338. * * 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
  67339. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  67340. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67341. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  67342. * @param name defines the name of the new line system
  67343. * @param options defines the options used to create the line system
  67344. * @param scene defines the hosting scene
  67345. * @returns a new line system mesh
  67346. */
  67347. static CreateLineSystem(name: string, options: {
  67348. lines: Vector3[][];
  67349. updatable?: boolean;
  67350. instance?: Nullable<LinesMesh>;
  67351. colors?: Nullable<Color4[][]>;
  67352. useVertexAlpha?: boolean;
  67353. }, scene: Nullable<Scene>): LinesMesh;
  67354. /**
  67355. * Creates a line mesh
  67356. * 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
  67357. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  67358. * * The parameter `points` is an array successive Vector3
  67359. * * 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
  67360. * * The optional parameter `colors` is an array of successive Color4, one per line point
  67361. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  67362. * * When updating an instance, remember that only point positions can change, not the number of points
  67363. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67364. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  67365. * @param name defines the name of the new line system
  67366. * @param options defines the options used to create the line system
  67367. * @param scene defines the hosting scene
  67368. * @returns a new line mesh
  67369. */
  67370. static CreateLines(name: string, options: {
  67371. points: Vector3[];
  67372. updatable?: boolean;
  67373. instance?: Nullable<LinesMesh>;
  67374. colors?: Color4[];
  67375. useVertexAlpha?: boolean;
  67376. }, scene?: Nullable<Scene>): LinesMesh;
  67377. /**
  67378. * Creates a dashed line mesh
  67379. * * 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
  67380. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  67381. * * The parameter `points` is an array successive Vector3
  67382. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  67383. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  67384. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  67385. * * 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
  67386. * * When updating an instance, remember that only point positions can change, not the number of points
  67387. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67388. * @param name defines the name of the mesh
  67389. * @param options defines the options used to create the mesh
  67390. * @param scene defines the hosting scene
  67391. * @returns the dashed line mesh
  67392. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  67393. */
  67394. static CreateDashedLines(name: string, options: {
  67395. points: Vector3[];
  67396. dashSize?: number;
  67397. gapSize?: number;
  67398. dashNb?: number;
  67399. updatable?: boolean;
  67400. instance?: LinesMesh;
  67401. }, scene?: Nullable<Scene>): LinesMesh;
  67402. /**
  67403. * 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.
  67404. * * 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.
  67405. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  67406. * * 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.
  67407. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  67408. * * 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
  67409. * * 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
  67410. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  67411. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67412. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67413. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  67414. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  67415. * @param name defines the name of the mesh
  67416. * @param options defines the options used to create the mesh
  67417. * @param scene defines the hosting scene
  67418. * @returns the extruded shape mesh
  67419. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  67420. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  67421. */
  67422. static ExtrudeShape(name: string, options: {
  67423. shape: Vector3[];
  67424. path: Vector3[];
  67425. scale?: number;
  67426. rotation?: number;
  67427. cap?: number;
  67428. updatable?: boolean;
  67429. sideOrientation?: number;
  67430. frontUVs?: Vector4;
  67431. backUVs?: Vector4;
  67432. instance?: Mesh;
  67433. invertUV?: boolean;
  67434. }, scene?: Nullable<Scene>): Mesh;
  67435. /**
  67436. * Creates an custom extruded shape mesh.
  67437. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  67438. * * 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.
  67439. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  67440. * * 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
  67441. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  67442. * * 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
  67443. * * It must returns a float value that will be the scale value applied to the shape on each path point
  67444. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  67445. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  67446. * * 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
  67447. * * 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
  67448. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  67449. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67450. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67451. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  67452. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67453. * @param name defines the name of the mesh
  67454. * @param options defines the options used to create the mesh
  67455. * @param scene defines the hosting scene
  67456. * @returns the custom extruded shape mesh
  67457. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  67458. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  67459. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  67460. */
  67461. static ExtrudeShapeCustom(name: string, options: {
  67462. shape: Vector3[];
  67463. path: Vector3[];
  67464. scaleFunction?: any;
  67465. rotationFunction?: any;
  67466. ribbonCloseArray?: boolean;
  67467. ribbonClosePath?: boolean;
  67468. cap?: number;
  67469. updatable?: boolean;
  67470. sideOrientation?: number;
  67471. frontUVs?: Vector4;
  67472. backUVs?: Vector4;
  67473. instance?: Mesh;
  67474. invertUV?: boolean;
  67475. }, scene?: Nullable<Scene>): Mesh;
  67476. /**
  67477. * Creates lathe mesh.
  67478. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  67479. * * 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
  67480. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  67481. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  67482. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  67483. * * 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
  67484. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  67485. * * 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
  67486. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67487. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67488. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  67489. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67490. * @param name defines the name of the mesh
  67491. * @param options defines the options used to create the mesh
  67492. * @param scene defines the hosting scene
  67493. * @returns the lathe mesh
  67494. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  67495. */
  67496. static CreateLathe(name: string, options: {
  67497. shape: Vector3[];
  67498. radius?: number;
  67499. tessellation?: number;
  67500. clip?: number;
  67501. arc?: number;
  67502. closed?: boolean;
  67503. updatable?: boolean;
  67504. sideOrientation?: number;
  67505. frontUVs?: Vector4;
  67506. backUVs?: Vector4;
  67507. cap?: number;
  67508. invertUV?: boolean;
  67509. }, scene?: Nullable<Scene>): Mesh;
  67510. /**
  67511. * Creates a tiled plane mesh
  67512. * * You can set a limited pattern arrangement with the tiles
  67513. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67514. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67515. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67516. * @param name defines the name of the mesh
  67517. * @param options defines the options used to create the mesh
  67518. * @param scene defines the hosting scene
  67519. * @returns the plane mesh
  67520. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  67521. */
  67522. static CreateTiledPlane(name: string, options: {
  67523. pattern?: number;
  67524. tileSize?: number;
  67525. tileWidth?: number;
  67526. tileHeight?: number;
  67527. size?: number;
  67528. width?: number;
  67529. height?: number;
  67530. alignHorizontal?: number;
  67531. alignVertical?: number;
  67532. sideOrientation?: number;
  67533. frontUVs?: Vector4;
  67534. backUVs?: Vector4;
  67535. updatable?: boolean;
  67536. }, scene?: Nullable<Scene>): Mesh;
  67537. /**
  67538. * Creates a plane mesh
  67539. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  67540. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  67541. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  67542. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67543. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67544. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67545. * @param name defines the name of the mesh
  67546. * @param options defines the options used to create the mesh
  67547. * @param scene defines the hosting scene
  67548. * @returns the plane mesh
  67549. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  67550. */
  67551. static CreatePlane(name: string, options: {
  67552. size?: number;
  67553. width?: number;
  67554. height?: number;
  67555. sideOrientation?: number;
  67556. frontUVs?: Vector4;
  67557. backUVs?: Vector4;
  67558. updatable?: boolean;
  67559. sourcePlane?: Plane;
  67560. }, scene?: Nullable<Scene>): Mesh;
  67561. /**
  67562. * Creates a ground mesh
  67563. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  67564. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  67565. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67566. * @param name defines the name of the mesh
  67567. * @param options defines the options used to create the mesh
  67568. * @param scene defines the hosting scene
  67569. * @returns the ground mesh
  67570. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  67571. */
  67572. static CreateGround(name: string, options: {
  67573. width?: number;
  67574. height?: number;
  67575. subdivisions?: number;
  67576. subdivisionsX?: number;
  67577. subdivisionsY?: number;
  67578. updatable?: boolean;
  67579. }, scene?: Nullable<Scene>): Mesh;
  67580. /**
  67581. * Creates a tiled ground mesh
  67582. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  67583. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  67584. * * 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
  67585. * * 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
  67586. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  67587. * @param name defines the name of the mesh
  67588. * @param options defines the options used to create the mesh
  67589. * @param scene defines the hosting scene
  67590. * @returns the tiled ground mesh
  67591. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  67592. */
  67593. static CreateTiledGround(name: string, options: {
  67594. xmin: number;
  67595. zmin: number;
  67596. xmax: number;
  67597. zmax: number;
  67598. subdivisions?: {
  67599. w: number;
  67600. h: number;
  67601. };
  67602. precision?: {
  67603. w: number;
  67604. h: number;
  67605. };
  67606. updatable?: boolean;
  67607. }, scene?: Nullable<Scene>): Mesh;
  67608. /**
  67609. * Creates a ground mesh from a height map
  67610. * * The parameter `url` sets the URL of the height map image resource.
  67611. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  67612. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  67613. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  67614. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  67615. * * 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.
  67616. * * 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).
  67617. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  67618. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  67619. * @param name defines the name of the mesh
  67620. * @param url defines the url to the height map
  67621. * @param options defines the options used to create the mesh
  67622. * @param scene defines the hosting scene
  67623. * @returns the ground mesh
  67624. * @see https://doc.babylonjs.com/babylon101/height_map
  67625. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  67626. */
  67627. static CreateGroundFromHeightMap(name: string, url: string, options: {
  67628. width?: number;
  67629. height?: number;
  67630. subdivisions?: number;
  67631. minHeight?: number;
  67632. maxHeight?: number;
  67633. colorFilter?: Color3;
  67634. alphaFilter?: number;
  67635. updatable?: boolean;
  67636. onReady?: (mesh: GroundMesh) => void;
  67637. }, scene?: Nullable<Scene>): GroundMesh;
  67638. /**
  67639. * Creates a polygon mesh
  67640. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  67641. * * 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
  67642. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  67643. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67644. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  67645. * * Remember you can only change the shape positions, not their number when updating a polygon
  67646. * @param name defines the name of the mesh
  67647. * @param options defines the options used to create the mesh
  67648. * @param scene defines the hosting scene
  67649. * @param earcutInjection can be used to inject your own earcut reference
  67650. * @returns the polygon mesh
  67651. */
  67652. static CreatePolygon(name: string, options: {
  67653. shape: Vector3[];
  67654. holes?: Vector3[][];
  67655. depth?: number;
  67656. faceUV?: Vector4[];
  67657. faceColors?: Color4[];
  67658. updatable?: boolean;
  67659. sideOrientation?: number;
  67660. frontUVs?: Vector4;
  67661. backUVs?: Vector4;
  67662. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  67663. /**
  67664. * Creates an extruded polygon mesh, with depth in the Y direction.
  67665. * * 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)
  67666. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  67667. * @param name defines the name of the mesh
  67668. * @param options defines the options used to create the mesh
  67669. * @param scene defines the hosting scene
  67670. * @param earcutInjection can be used to inject your own earcut reference
  67671. * @returns the polygon mesh
  67672. */
  67673. static ExtrudePolygon(name: string, options: {
  67674. shape: Vector3[];
  67675. holes?: Vector3[][];
  67676. depth?: number;
  67677. faceUV?: Vector4[];
  67678. faceColors?: Color4[];
  67679. updatable?: boolean;
  67680. sideOrientation?: number;
  67681. frontUVs?: Vector4;
  67682. backUVs?: Vector4;
  67683. wrap?: boolean;
  67684. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  67685. /**
  67686. * Creates a tube mesh.
  67687. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  67688. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  67689. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  67690. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  67691. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  67692. * * 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)
  67693. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  67694. * * 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
  67695. * * 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
  67696. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67697. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67698. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  67699. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67700. * @param name defines the name of the mesh
  67701. * @param options defines the options used to create the mesh
  67702. * @param scene defines the hosting scene
  67703. * @returns the tube mesh
  67704. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  67705. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  67706. */
  67707. static CreateTube(name: string, options: {
  67708. path: Vector3[];
  67709. radius?: number;
  67710. tessellation?: number;
  67711. radiusFunction?: {
  67712. (i: number, distance: number): number;
  67713. };
  67714. cap?: number;
  67715. arc?: number;
  67716. updatable?: boolean;
  67717. sideOrientation?: number;
  67718. frontUVs?: Vector4;
  67719. backUVs?: Vector4;
  67720. instance?: Mesh;
  67721. invertUV?: boolean;
  67722. }, scene?: Nullable<Scene>): Mesh;
  67723. /**
  67724. * Creates a polyhedron mesh
  67725. * * 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
  67726. * * The parameter `size` (positive float, default 1) sets the polygon size
  67727. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  67728. * * 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`
  67729. * * 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
  67730. * * 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)`)
  67731. * * 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
  67732. * * 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
  67733. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  67734. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  67735. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  67736. * @param name defines the name of the mesh
  67737. * @param options defines the options used to create the mesh
  67738. * @param scene defines the hosting scene
  67739. * @returns the polyhedron mesh
  67740. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  67741. */
  67742. static CreatePolyhedron(name: string, options: {
  67743. type?: number;
  67744. size?: number;
  67745. sizeX?: number;
  67746. sizeY?: number;
  67747. sizeZ?: number;
  67748. custom?: any;
  67749. faceUV?: Vector4[];
  67750. faceColors?: Color4[];
  67751. flat?: boolean;
  67752. updatable?: boolean;
  67753. sideOrientation?: number;
  67754. frontUVs?: Vector4;
  67755. backUVs?: Vector4;
  67756. }, scene?: Nullable<Scene>): Mesh;
  67757. /**
  67758. * Creates a decal mesh.
  67759. * 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
  67760. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  67761. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  67762. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  67763. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  67764. * @param name defines the name of the mesh
  67765. * @param sourceMesh defines the mesh where the decal must be applied
  67766. * @param options defines the options used to create the mesh
  67767. * @param scene defines the hosting scene
  67768. * @returns the decal mesh
  67769. * @see https://doc.babylonjs.com/how_to/decals
  67770. */
  67771. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  67772. position?: Vector3;
  67773. normal?: Vector3;
  67774. size?: Vector3;
  67775. angle?: number;
  67776. }): Mesh;
  67777. /**
  67778. * Creates a Capsule Mesh
  67779. * @param name defines the name of the mesh.
  67780. * @param options the constructors options used to shape the mesh.
  67781. * @param scene defines the scene the mesh is scoped to.
  67782. * @returns the capsule mesh
  67783. * @see https://doc.babylonjs.com/how_to/capsule_shape
  67784. */
  67785. static CreateCapsule(name: string, options?: ICreateCapsuleOptions, scene?: Nullable<Scene>): Mesh;
  67786. }
  67787. }
  67788. declare module BABYLON {
  67789. /**
  67790. * A simplifier interface for future simplification implementations
  67791. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  67792. */
  67793. export interface ISimplifier {
  67794. /**
  67795. * Simplification of a given mesh according to the given settings.
  67796. * Since this requires computation, it is assumed that the function runs async.
  67797. * @param settings The settings of the simplification, including quality and distance
  67798. * @param successCallback A callback that will be called after the mesh was simplified.
  67799. * @param errorCallback in case of an error, this callback will be called. optional.
  67800. */
  67801. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  67802. }
  67803. /**
  67804. * Expected simplification settings.
  67805. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  67806. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  67807. */
  67808. export interface ISimplificationSettings {
  67809. /**
  67810. * Gets or sets the expected quality
  67811. */
  67812. quality: number;
  67813. /**
  67814. * Gets or sets the distance when this optimized version should be used
  67815. */
  67816. distance: number;
  67817. /**
  67818. * Gets an already optimized mesh
  67819. */
  67820. optimizeMesh?: boolean;
  67821. }
  67822. /**
  67823. * Class used to specify simplification options
  67824. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  67825. */
  67826. export class SimplificationSettings implements ISimplificationSettings {
  67827. /** expected quality */
  67828. quality: number;
  67829. /** distance when this optimized version should be used */
  67830. distance: number;
  67831. /** already optimized mesh */
  67832. optimizeMesh?: boolean | undefined;
  67833. /**
  67834. * Creates a SimplificationSettings
  67835. * @param quality expected quality
  67836. * @param distance distance when this optimized version should be used
  67837. * @param optimizeMesh already optimized mesh
  67838. */
  67839. constructor(
  67840. /** expected quality */
  67841. quality: number,
  67842. /** distance when this optimized version should be used */
  67843. distance: number,
  67844. /** already optimized mesh */
  67845. optimizeMesh?: boolean | undefined);
  67846. }
  67847. /**
  67848. * Interface used to define a simplification task
  67849. */
  67850. export interface ISimplificationTask {
  67851. /**
  67852. * Array of settings
  67853. */
  67854. settings: Array<ISimplificationSettings>;
  67855. /**
  67856. * Simplification type
  67857. */
  67858. simplificationType: SimplificationType;
  67859. /**
  67860. * Mesh to simplify
  67861. */
  67862. mesh: Mesh;
  67863. /**
  67864. * Callback called on success
  67865. */
  67866. successCallback?: () => void;
  67867. /**
  67868. * Defines if parallel processing can be used
  67869. */
  67870. parallelProcessing: boolean;
  67871. }
  67872. /**
  67873. * Queue used to order the simplification tasks
  67874. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  67875. */
  67876. export class SimplificationQueue {
  67877. private _simplificationArray;
  67878. /**
  67879. * Gets a boolean indicating that the process is still running
  67880. */
  67881. running: boolean;
  67882. /**
  67883. * Creates a new queue
  67884. */
  67885. constructor();
  67886. /**
  67887. * Adds a new simplification task
  67888. * @param task defines a task to add
  67889. */
  67890. addTask(task: ISimplificationTask): void;
  67891. /**
  67892. * Execute next task
  67893. */
  67894. executeNext(): void;
  67895. /**
  67896. * Execute a simplification task
  67897. * @param task defines the task to run
  67898. */
  67899. runSimplification(task: ISimplificationTask): void;
  67900. private getSimplifier;
  67901. }
  67902. /**
  67903. * The implemented types of simplification
  67904. * At the moment only Quadratic Error Decimation is implemented
  67905. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  67906. */
  67907. export enum SimplificationType {
  67908. /** Quadratic error decimation */
  67909. QUADRATIC = 0
  67910. }
  67911. /**
  67912. * An implementation of the Quadratic Error simplification algorithm.
  67913. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  67914. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  67915. * @author RaananW
  67916. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  67917. */
  67918. export class QuadraticErrorSimplification implements ISimplifier {
  67919. private _mesh;
  67920. private triangles;
  67921. private vertices;
  67922. private references;
  67923. private _reconstructedMesh;
  67924. /** Gets or sets the number pf sync interations */
  67925. syncIterations: number;
  67926. /** Gets or sets the aggressiveness of the simplifier */
  67927. aggressiveness: number;
  67928. /** Gets or sets the number of allowed iterations for decimation */
  67929. decimationIterations: number;
  67930. /** Gets or sets the espilon to use for bounding box computation */
  67931. boundingBoxEpsilon: number;
  67932. /**
  67933. * Creates a new QuadraticErrorSimplification
  67934. * @param _mesh defines the target mesh
  67935. */
  67936. constructor(_mesh: Mesh);
  67937. /**
  67938. * Simplification of a given mesh according to the given settings.
  67939. * Since this requires computation, it is assumed that the function runs async.
  67940. * @param settings The settings of the simplification, including quality and distance
  67941. * @param successCallback A callback that will be called after the mesh was simplified.
  67942. */
  67943. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  67944. private runDecimation;
  67945. private initWithMesh;
  67946. private init;
  67947. private reconstructMesh;
  67948. private initDecimatedMesh;
  67949. private isFlipped;
  67950. private updateTriangles;
  67951. private identifyBorder;
  67952. private updateMesh;
  67953. private vertexError;
  67954. private calculateError;
  67955. }
  67956. }
  67957. declare module BABYLON {
  67958. interface Scene {
  67959. /** @hidden (Backing field) */
  67960. _simplificationQueue: SimplificationQueue;
  67961. /**
  67962. * Gets or sets the simplification queue attached to the scene
  67963. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  67964. */
  67965. simplificationQueue: SimplificationQueue;
  67966. }
  67967. interface Mesh {
  67968. /**
  67969. * Simplify the mesh according to the given array of settings.
  67970. * Function will return immediately and will simplify async
  67971. * @param settings a collection of simplification settings
  67972. * @param parallelProcessing should all levels calculate parallel or one after the other
  67973. * @param simplificationType the type of simplification to run
  67974. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  67975. * @returns the current mesh
  67976. */
  67977. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  67978. }
  67979. /**
  67980. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  67981. * created in a scene
  67982. */
  67983. export class SimplicationQueueSceneComponent implements ISceneComponent {
  67984. /**
  67985. * The component name helpfull to identify the component in the list of scene components.
  67986. */
  67987. readonly name: string;
  67988. /**
  67989. * The scene the component belongs to.
  67990. */
  67991. scene: Scene;
  67992. /**
  67993. * Creates a new instance of the component for the given scene
  67994. * @param scene Defines the scene to register the component in
  67995. */
  67996. constructor(scene: Scene);
  67997. /**
  67998. * Registers the component in a given scene
  67999. */
  68000. register(): void;
  68001. /**
  68002. * Rebuilds the elements related to this component in case of
  68003. * context lost for instance.
  68004. */
  68005. rebuild(): void;
  68006. /**
  68007. * Disposes the component and the associated ressources
  68008. */
  68009. dispose(): void;
  68010. private _beforeCameraUpdate;
  68011. }
  68012. }
  68013. declare module BABYLON {
  68014. interface Mesh {
  68015. /**
  68016. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  68017. */
  68018. thinInstanceEnablePicking: boolean;
  68019. /**
  68020. * Creates a new thin instance
  68021. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  68022. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  68023. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  68024. */
  68025. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  68026. /**
  68027. * Adds the transformation (matrix) of the current mesh as a thin instance
  68028. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  68029. * @returns the thin instance index number
  68030. */
  68031. thinInstanceAddSelf(refresh: boolean): number;
  68032. /**
  68033. * Registers a custom attribute to be used with thin instances
  68034. * @param kind name of the attribute
  68035. * @param stride size in floats of the attribute
  68036. */
  68037. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  68038. /**
  68039. * Sets the matrix of a thin instance
  68040. * @param index index of the thin instance
  68041. * @param matrix matrix to set
  68042. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  68043. */
  68044. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  68045. /**
  68046. * Sets the value of a custom attribute for a thin instance
  68047. * @param kind name of the attribute
  68048. * @param index index of the thin instance
  68049. * @param value value to set
  68050. * @param refresh true to refresh the underlying gpu buffer (default: true). If you do multiple calls to this method in a row, set refresh to true only for the last call to save performance
  68051. */
  68052. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  68053. /**
  68054. * Gets / sets the number of thin instances to display. Note that you can't set a number higher than what the underlying buffer can handle.
  68055. */
  68056. thinInstanceCount: number;
  68057. /**
  68058. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  68059. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  68060. * @param buffer buffer to set
  68061. * @param stride size in floats of each value of the buffer
  68062. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  68063. */
  68064. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  68065. /**
  68066. * Gets the list of world matrices
  68067. * @return an array containing all the world matrices from the thin instances
  68068. */
  68069. thinInstanceGetWorldMatrices(): Matrix[];
  68070. /**
  68071. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  68072. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  68073. */
  68074. thinInstanceBufferUpdated(kind: string): void;
  68075. /**
  68076. * Applies a partial update to a buffer directly on the GPU
  68077. * Note that the buffer located on the CPU is NOT updated! It's up to you to update it (or not) with the same data you pass to this method
  68078. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  68079. * @param data the data to set in the GPU buffer
  68080. * @param offset the offset in the GPU buffer where to update the data
  68081. */
  68082. thinInstancePartialBufferUpdate(kind: string, data: Float32Array, offset: number): void;
  68083. /**
  68084. * Refreshes the bounding info, taking into account all the thin instances defined
  68085. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  68086. */
  68087. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  68088. /** @hidden */
  68089. _thinInstanceInitializeUserStorage(): void;
  68090. /** @hidden */
  68091. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  68092. /** @hidden */
  68093. _userThinInstanceBuffersStorage: {
  68094. data: {
  68095. [key: string]: Float32Array;
  68096. };
  68097. sizes: {
  68098. [key: string]: number;
  68099. };
  68100. vertexBuffers: {
  68101. [key: string]: Nullable<VertexBuffer>;
  68102. };
  68103. strides: {
  68104. [key: string]: number;
  68105. };
  68106. };
  68107. }
  68108. }
  68109. declare module BABYLON {
  68110. /**
  68111. * Navigation plugin interface to add navigation constrained by a navigation mesh
  68112. */
  68113. export interface INavigationEnginePlugin {
  68114. /**
  68115. * plugin name
  68116. */
  68117. name: string;
  68118. /**
  68119. * Creates a navigation mesh
  68120. * @param meshes array of all the geometry used to compute the navigatio mesh
  68121. * @param parameters bunch of parameters used to filter geometry
  68122. */
  68123. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  68124. /**
  68125. * Create a navigation mesh debug mesh
  68126. * @param scene is where the mesh will be added
  68127. * @returns debug display mesh
  68128. */
  68129. createDebugNavMesh(scene: Scene): Mesh;
  68130. /**
  68131. * Get a navigation mesh constrained position, closest to the parameter position
  68132. * @param position world position
  68133. * @returns the closest point to position constrained by the navigation mesh
  68134. */
  68135. getClosestPoint(position: Vector3): Vector3;
  68136. /**
  68137. * Get a navigation mesh constrained position, closest to the parameter position
  68138. * @param position world position
  68139. * @param result output the closest point to position constrained by the navigation mesh
  68140. */
  68141. getClosestPointToRef(position: Vector3, result: Vector3): void;
  68142. /**
  68143. * Get a navigation mesh constrained position, within a particular radius
  68144. * @param position world position
  68145. * @param maxRadius the maximum distance to the constrained world position
  68146. * @returns the closest point to position constrained by the navigation mesh
  68147. */
  68148. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  68149. /**
  68150. * Get a navigation mesh constrained position, within a particular radius
  68151. * @param position world position
  68152. * @param maxRadius the maximum distance to the constrained world position
  68153. * @param result output the closest point to position constrained by the navigation mesh
  68154. */
  68155. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  68156. /**
  68157. * Compute the final position from a segment made of destination-position
  68158. * @param position world position
  68159. * @param destination world position
  68160. * @returns the resulting point along the navmesh
  68161. */
  68162. moveAlong(position: Vector3, destination: Vector3): Vector3;
  68163. /**
  68164. * Compute the final position from a segment made of destination-position
  68165. * @param position world position
  68166. * @param destination world position
  68167. * @param result output the resulting point along the navmesh
  68168. */
  68169. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  68170. /**
  68171. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  68172. * @param start world position
  68173. * @param end world position
  68174. * @returns array containing world position composing the path
  68175. */
  68176. computePath(start: Vector3, end: Vector3): Vector3[];
  68177. /**
  68178. * If this plugin is supported
  68179. * @returns true if plugin is supported
  68180. */
  68181. isSupported(): boolean;
  68182. /**
  68183. * Create a new Crowd so you can add agents
  68184. * @param maxAgents the maximum agent count in the crowd
  68185. * @param maxAgentRadius the maximum radius an agent can have
  68186. * @param scene to attach the crowd to
  68187. * @returns the crowd you can add agents to
  68188. */
  68189. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  68190. /**
  68191. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  68192. * The queries will try to find a solution within those bounds
  68193. * default is (1,1,1)
  68194. * @param extent x,y,z value that define the extent around the queries point of reference
  68195. */
  68196. setDefaultQueryExtent(extent: Vector3): void;
  68197. /**
  68198. * Get the Bounding box extent specified by setDefaultQueryExtent
  68199. * @returns the box extent values
  68200. */
  68201. getDefaultQueryExtent(): Vector3;
  68202. /**
  68203. * build the navmesh from a previously saved state using getNavmeshData
  68204. * @param data the Uint8Array returned by getNavmeshData
  68205. */
  68206. buildFromNavmeshData(data: Uint8Array): void;
  68207. /**
  68208. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  68209. * @returns data the Uint8Array that can be saved and reused
  68210. */
  68211. getNavmeshData(): Uint8Array;
  68212. /**
  68213. * Get the Bounding box extent result specified by setDefaultQueryExtent
  68214. * @param result output the box extent values
  68215. */
  68216. getDefaultQueryExtentToRef(result: Vector3): void;
  68217. /**
  68218. * Release all resources
  68219. */
  68220. dispose(): void;
  68221. }
  68222. /**
  68223. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  68224. */
  68225. export interface ICrowd {
  68226. /**
  68227. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  68228. * You can attach anything to that node. The node position is updated in the scene update tick.
  68229. * @param pos world position that will be constrained by the navigation mesh
  68230. * @param parameters agent parameters
  68231. * @param transform hooked to the agent that will be update by the scene
  68232. * @returns agent index
  68233. */
  68234. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  68235. /**
  68236. * Returns the agent position in world space
  68237. * @param index agent index returned by addAgent
  68238. * @returns world space position
  68239. */
  68240. getAgentPosition(index: number): Vector3;
  68241. /**
  68242. * Gets the agent position result in world space
  68243. * @param index agent index returned by addAgent
  68244. * @param result output world space position
  68245. */
  68246. getAgentPositionToRef(index: number, result: Vector3): void;
  68247. /**
  68248. * Gets the agent velocity in world space
  68249. * @param index agent index returned by addAgent
  68250. * @returns world space velocity
  68251. */
  68252. getAgentVelocity(index: number): Vector3;
  68253. /**
  68254. * Gets the agent velocity result in world space
  68255. * @param index agent index returned by addAgent
  68256. * @param result output world space velocity
  68257. */
  68258. getAgentVelocityToRef(index: number, result: Vector3): void;
  68259. /**
  68260. * Gets the agent next target point on the path
  68261. * @param index agent index returned by addAgent
  68262. * @returns world space position
  68263. */
  68264. getAgentNextTargetPath(index: number): Vector3;
  68265. /**
  68266. * Gets the agent state
  68267. * @param index agent index returned by addAgent
  68268. * @returns agent state
  68269. */
  68270. getAgentState(index: number): number;
  68271. /**
  68272. * returns true if the agent in over an off mesh link connection
  68273. * @param index agent index returned by addAgent
  68274. * @returns true if over an off mesh link connection
  68275. */
  68276. overOffmeshConnection(index: number): boolean;
  68277. /**
  68278. * Gets the agent next target point on the path
  68279. * @param index agent index returned by addAgent
  68280. * @param result output world space position
  68281. */
  68282. getAgentNextTargetPathToRef(index: number, result: Vector3): void;
  68283. /**
  68284. * remove a particular agent previously created
  68285. * @param index agent index returned by addAgent
  68286. */
  68287. removeAgent(index: number): void;
  68288. /**
  68289. * get the list of all agents attached to this crowd
  68290. * @returns list of agent indices
  68291. */
  68292. getAgents(): number[];
  68293. /**
  68294. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  68295. * @param deltaTime in seconds
  68296. */
  68297. update(deltaTime: number): void;
  68298. /**
  68299. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  68300. * @param index agent index returned by addAgent
  68301. * @param destination targeted world position
  68302. */
  68303. agentGoto(index: number, destination: Vector3): void;
  68304. /**
  68305. * Teleport the agent to a new position
  68306. * @param index agent index returned by addAgent
  68307. * @param destination targeted world position
  68308. */
  68309. agentTeleport(index: number, destination: Vector3): void;
  68310. /**
  68311. * Update agent parameters
  68312. * @param index agent index returned by addAgent
  68313. * @param parameters agent parameters
  68314. */
  68315. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  68316. /**
  68317. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  68318. * The queries will try to find a solution within those bounds
  68319. * default is (1,1,1)
  68320. * @param extent x,y,z value that define the extent around the queries point of reference
  68321. */
  68322. setDefaultQueryExtent(extent: Vector3): void;
  68323. /**
  68324. * Get the Bounding box extent specified by setDefaultQueryExtent
  68325. * @returns the box extent values
  68326. */
  68327. getDefaultQueryExtent(): Vector3;
  68328. /**
  68329. * Get the Bounding box extent result specified by setDefaultQueryExtent
  68330. * @param result output the box extent values
  68331. */
  68332. getDefaultQueryExtentToRef(result: Vector3): void;
  68333. /**
  68334. * Release all resources
  68335. */
  68336. dispose(): void;
  68337. }
  68338. /**
  68339. * Configures an agent
  68340. */
  68341. export interface IAgentParameters {
  68342. /**
  68343. * Agent radius. [Limit: >= 0]
  68344. */
  68345. radius: number;
  68346. /**
  68347. * Agent height. [Limit: > 0]
  68348. */
  68349. height: number;
  68350. /**
  68351. * Maximum allowed acceleration. [Limit: >= 0]
  68352. */
  68353. maxAcceleration: number;
  68354. /**
  68355. * Maximum allowed speed. [Limit: >= 0]
  68356. */
  68357. maxSpeed: number;
  68358. /**
  68359. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  68360. */
  68361. collisionQueryRange: number;
  68362. /**
  68363. * The path visibility optimization range. [Limit: > 0]
  68364. */
  68365. pathOptimizationRange: number;
  68366. /**
  68367. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  68368. */
  68369. separationWeight: number;
  68370. }
  68371. /**
  68372. * Configures the navigation mesh creation
  68373. */
  68374. export interface INavMeshParameters {
  68375. /**
  68376. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  68377. */
  68378. cs: number;
  68379. /**
  68380. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  68381. */
  68382. ch: number;
  68383. /**
  68384. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  68385. */
  68386. walkableSlopeAngle: number;
  68387. /**
  68388. * Minimum floor to 'ceiling' height that will still allow the floor area to
  68389. * be considered walkable. [Limit: >= 3] [Units: vx]
  68390. */
  68391. walkableHeight: number;
  68392. /**
  68393. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  68394. */
  68395. walkableClimb: number;
  68396. /**
  68397. * The distance to erode/shrink the walkable area of the heightfield away from
  68398. * obstructions. [Limit: >=0] [Units: vx]
  68399. */
  68400. walkableRadius: number;
  68401. /**
  68402. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  68403. */
  68404. maxEdgeLen: number;
  68405. /**
  68406. * The maximum distance a simplfied contour's border edges should deviate
  68407. * the original raw contour. [Limit: >=0] [Units: vx]
  68408. */
  68409. maxSimplificationError: number;
  68410. /**
  68411. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  68412. */
  68413. minRegionArea: number;
  68414. /**
  68415. * Any regions with a span count smaller than this value will, if possible,
  68416. * be merged with larger regions. [Limit: >=0] [Units: vx]
  68417. */
  68418. mergeRegionArea: number;
  68419. /**
  68420. * The maximum number of vertices allowed for polygons generated during the
  68421. * contour to polygon conversion process. [Limit: >= 3]
  68422. */
  68423. maxVertsPerPoly: number;
  68424. /**
  68425. * Sets the sampling distance to use when generating the detail mesh.
  68426. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  68427. */
  68428. detailSampleDist: number;
  68429. /**
  68430. * The maximum distance the detail mesh surface should deviate from heightfield
  68431. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  68432. */
  68433. detailSampleMaxError: number;
  68434. }
  68435. }
  68436. declare module BABYLON {
  68437. /**
  68438. * RecastJS navigation plugin
  68439. */
  68440. export class RecastJSPlugin implements INavigationEnginePlugin {
  68441. /**
  68442. * Reference to the Recast library
  68443. */
  68444. bjsRECAST: any;
  68445. /**
  68446. * plugin name
  68447. */
  68448. name: string;
  68449. /**
  68450. * the first navmesh created. We might extend this to support multiple navmeshes
  68451. */
  68452. navMesh: any;
  68453. /**
  68454. * Initializes the recastJS plugin
  68455. * @param recastInjection can be used to inject your own recast reference
  68456. */
  68457. constructor(recastInjection?: any);
  68458. /**
  68459. * Creates a navigation mesh
  68460. * @param meshes array of all the geometry used to compute the navigatio mesh
  68461. * @param parameters bunch of parameters used to filter geometry
  68462. */
  68463. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  68464. /**
  68465. * Create a navigation mesh debug mesh
  68466. * @param scene is where the mesh will be added
  68467. * @returns debug display mesh
  68468. */
  68469. createDebugNavMesh(scene: Scene): Mesh;
  68470. /**
  68471. * Get a navigation mesh constrained position, closest to the parameter position
  68472. * @param position world position
  68473. * @returns the closest point to position constrained by the navigation mesh
  68474. */
  68475. getClosestPoint(position: Vector3): Vector3;
  68476. /**
  68477. * Get a navigation mesh constrained position, closest to the parameter position
  68478. * @param position world position
  68479. * @param result output the closest point to position constrained by the navigation mesh
  68480. */
  68481. getClosestPointToRef(position: Vector3, result: Vector3): void;
  68482. /**
  68483. * Get a navigation mesh constrained position, within a particular radius
  68484. * @param position world position
  68485. * @param maxRadius the maximum distance to the constrained world position
  68486. * @returns the closest point to position constrained by the navigation mesh
  68487. */
  68488. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  68489. /**
  68490. * Get a navigation mesh constrained position, within a particular radius
  68491. * @param position world position
  68492. * @param maxRadius the maximum distance to the constrained world position
  68493. * @param result output the closest point to position constrained by the navigation mesh
  68494. */
  68495. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  68496. /**
  68497. * Compute the final position from a segment made of destination-position
  68498. * @param position world position
  68499. * @param destination world position
  68500. * @returns the resulting point along the navmesh
  68501. */
  68502. moveAlong(position: Vector3, destination: Vector3): Vector3;
  68503. /**
  68504. * Compute the final position from a segment made of destination-position
  68505. * @param position world position
  68506. * @param destination world position
  68507. * @param result output the resulting point along the navmesh
  68508. */
  68509. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  68510. /**
  68511. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  68512. * @param start world position
  68513. * @param end world position
  68514. * @returns array containing world position composing the path
  68515. */
  68516. computePath(start: Vector3, end: Vector3): Vector3[];
  68517. /**
  68518. * Create a new Crowd so you can add agents
  68519. * @param maxAgents the maximum agent count in the crowd
  68520. * @param maxAgentRadius the maximum radius an agent can have
  68521. * @param scene to attach the crowd to
  68522. * @returns the crowd you can add agents to
  68523. */
  68524. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  68525. /**
  68526. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  68527. * The queries will try to find a solution within those bounds
  68528. * default is (1,1,1)
  68529. * @param extent x,y,z value that define the extent around the queries point of reference
  68530. */
  68531. setDefaultQueryExtent(extent: Vector3): void;
  68532. /**
  68533. * Get the Bounding box extent specified by setDefaultQueryExtent
  68534. * @returns the box extent values
  68535. */
  68536. getDefaultQueryExtent(): Vector3;
  68537. /**
  68538. * build the navmesh from a previously saved state using getNavmeshData
  68539. * @param data the Uint8Array returned by getNavmeshData
  68540. */
  68541. buildFromNavmeshData(data: Uint8Array): void;
  68542. /**
  68543. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  68544. * @returns data the Uint8Array that can be saved and reused
  68545. */
  68546. getNavmeshData(): Uint8Array;
  68547. /**
  68548. * Get the Bounding box extent result specified by setDefaultQueryExtent
  68549. * @param result output the box extent values
  68550. */
  68551. getDefaultQueryExtentToRef(result: Vector3): void;
  68552. /**
  68553. * Disposes
  68554. */
  68555. dispose(): void;
  68556. /**
  68557. * If this plugin is supported
  68558. * @returns true if plugin is supported
  68559. */
  68560. isSupported(): boolean;
  68561. }
  68562. /**
  68563. * Recast detour crowd implementation
  68564. */
  68565. export class RecastJSCrowd implements ICrowd {
  68566. /**
  68567. * Recast/detour plugin
  68568. */
  68569. bjsRECASTPlugin: RecastJSPlugin;
  68570. /**
  68571. * Link to the detour crowd
  68572. */
  68573. recastCrowd: any;
  68574. /**
  68575. * One transform per agent
  68576. */
  68577. transforms: TransformNode[];
  68578. /**
  68579. * All agents created
  68580. */
  68581. agents: number[];
  68582. /**
  68583. * Link to the scene is kept to unregister the crowd from the scene
  68584. */
  68585. private _scene;
  68586. /**
  68587. * Observer for crowd updates
  68588. */
  68589. private _onBeforeAnimationsObserver;
  68590. /**
  68591. * Constructor
  68592. * @param plugin recastJS plugin
  68593. * @param maxAgents the maximum agent count in the crowd
  68594. * @param maxAgentRadius the maximum radius an agent can have
  68595. * @param scene to attach the crowd to
  68596. * @returns the crowd you can add agents to
  68597. */
  68598. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  68599. /**
  68600. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  68601. * You can attach anything to that node. The node position is updated in the scene update tick.
  68602. * @param pos world position that will be constrained by the navigation mesh
  68603. * @param parameters agent parameters
  68604. * @param transform hooked to the agent that will be update by the scene
  68605. * @returns agent index
  68606. */
  68607. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  68608. /**
  68609. * Returns the agent position in world space
  68610. * @param index agent index returned by addAgent
  68611. * @returns world space position
  68612. */
  68613. getAgentPosition(index: number): Vector3;
  68614. /**
  68615. * Returns the agent position result in world space
  68616. * @param index agent index returned by addAgent
  68617. * @param result output world space position
  68618. */
  68619. getAgentPositionToRef(index: number, result: Vector3): void;
  68620. /**
  68621. * Returns the agent velocity in world space
  68622. * @param index agent index returned by addAgent
  68623. * @returns world space velocity
  68624. */
  68625. getAgentVelocity(index: number): Vector3;
  68626. /**
  68627. * Returns the agent velocity result in world space
  68628. * @param index agent index returned by addAgent
  68629. * @param result output world space velocity
  68630. */
  68631. getAgentVelocityToRef(index: number, result: Vector3): void;
  68632. /**
  68633. * Returns the agent next target point on the path
  68634. * @param index agent index returned by addAgent
  68635. * @returns world space position
  68636. */
  68637. getAgentNextTargetPath(index: number): Vector3;
  68638. /**
  68639. * Returns the agent next target point on the path
  68640. * @param index agent index returned by addAgent
  68641. * @param result output world space position
  68642. */
  68643. getAgentNextTargetPathToRef(index: number, result: Vector3): void;
  68644. /**
  68645. * Gets the agent state
  68646. * @param index agent index returned by addAgent
  68647. * @returns agent state
  68648. */
  68649. getAgentState(index: number): number;
  68650. /**
  68651. * returns true if the agent in over an off mesh link connection
  68652. * @param index agent index returned by addAgent
  68653. * @returns true if over an off mesh link connection
  68654. */
  68655. overOffmeshConnection(index: number): boolean;
  68656. /**
  68657. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  68658. * @param index agent index returned by addAgent
  68659. * @param destination targeted world position
  68660. */
  68661. agentGoto(index: number, destination: Vector3): void;
  68662. /**
  68663. * Teleport the agent to a new position
  68664. * @param index agent index returned by addAgent
  68665. * @param destination targeted world position
  68666. */
  68667. agentTeleport(index: number, destination: Vector3): void;
  68668. /**
  68669. * Update agent parameters
  68670. * @param index agent index returned by addAgent
  68671. * @param parameters agent parameters
  68672. */
  68673. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  68674. /**
  68675. * remove a particular agent previously created
  68676. * @param index agent index returned by addAgent
  68677. */
  68678. removeAgent(index: number): void;
  68679. /**
  68680. * get the list of all agents attached to this crowd
  68681. * @returns list of agent indices
  68682. */
  68683. getAgents(): number[];
  68684. /**
  68685. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  68686. * @param deltaTime in seconds
  68687. */
  68688. update(deltaTime: number): void;
  68689. /**
  68690. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  68691. * The queries will try to find a solution within those bounds
  68692. * default is (1,1,1)
  68693. * @param extent x,y,z value that define the extent around the queries point of reference
  68694. */
  68695. setDefaultQueryExtent(extent: Vector3): void;
  68696. /**
  68697. * Get the Bounding box extent specified by setDefaultQueryExtent
  68698. * @returns the box extent values
  68699. */
  68700. getDefaultQueryExtent(): Vector3;
  68701. /**
  68702. * Get the Bounding box extent result specified by setDefaultQueryExtent
  68703. * @param result output the box extent values
  68704. */
  68705. getDefaultQueryExtentToRef(result: Vector3): void;
  68706. /**
  68707. * Release all resources
  68708. */
  68709. dispose(): void;
  68710. }
  68711. }
  68712. declare module BABYLON {
  68713. /**
  68714. * Class used to enable access to IndexedDB
  68715. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  68716. */
  68717. export class Database implements IOfflineProvider {
  68718. private _callbackManifestChecked;
  68719. private _currentSceneUrl;
  68720. private _db;
  68721. private _enableSceneOffline;
  68722. private _enableTexturesOffline;
  68723. private _manifestVersionFound;
  68724. private _mustUpdateRessources;
  68725. private _hasReachedQuota;
  68726. private _isSupported;
  68727. private _idbFactory;
  68728. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  68729. private static IsUASupportingBlobStorage;
  68730. /**
  68731. * Gets a boolean indicating if Database storate is enabled (off by default)
  68732. */
  68733. static IDBStorageEnabled: boolean;
  68734. /**
  68735. * Gets a boolean indicating if scene must be saved in the database
  68736. */
  68737. get enableSceneOffline(): boolean;
  68738. /**
  68739. * Gets a boolean indicating if textures must be saved in the database
  68740. */
  68741. get enableTexturesOffline(): boolean;
  68742. /**
  68743. * Creates a new Database
  68744. * @param urlToScene defines the url to load the scene
  68745. * @param callbackManifestChecked defines the callback to use when manifest is checked
  68746. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  68747. */
  68748. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  68749. private static _ParseURL;
  68750. private static _ReturnFullUrlLocation;
  68751. private _checkManifestFile;
  68752. /**
  68753. * Open the database and make it available
  68754. * @param successCallback defines the callback to call on success
  68755. * @param errorCallback defines the callback to call on error
  68756. */
  68757. open(successCallback: () => void, errorCallback: () => void): void;
  68758. /**
  68759. * Loads an image from the database
  68760. * @param url defines the url to load from
  68761. * @param image defines the target DOM image
  68762. */
  68763. loadImage(url: string, image: HTMLImageElement): void;
  68764. private _loadImageFromDBAsync;
  68765. private _saveImageIntoDBAsync;
  68766. private _checkVersionFromDB;
  68767. private _loadVersionFromDBAsync;
  68768. private _saveVersionIntoDBAsync;
  68769. /**
  68770. * Loads a file from database
  68771. * @param url defines the URL to load from
  68772. * @param sceneLoaded defines a callback to call on success
  68773. * @param progressCallBack defines a callback to call when progress changed
  68774. * @param errorCallback defines a callback to call on error
  68775. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  68776. */
  68777. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  68778. private _loadFileAsync;
  68779. private _saveFileAsync;
  68780. /**
  68781. * Validates if xhr data is correct
  68782. * @param xhr defines the request to validate
  68783. * @param dataType defines the expected data type
  68784. * @returns true if data is correct
  68785. */
  68786. private static _ValidateXHRData;
  68787. }
  68788. }
  68789. declare module BABYLON {
  68790. /** @hidden */
  68791. export var gpuUpdateParticlesPixelShader: {
  68792. name: string;
  68793. shader: string;
  68794. };
  68795. }
  68796. declare module BABYLON {
  68797. /** @hidden */
  68798. export var gpuUpdateParticlesVertexShader: {
  68799. name: string;
  68800. shader: string;
  68801. };
  68802. }
  68803. declare module BABYLON {
  68804. /** @hidden */
  68805. export var clipPlaneFragmentDeclaration2: {
  68806. name: string;
  68807. shader: string;
  68808. };
  68809. }
  68810. declare module BABYLON {
  68811. /** @hidden */
  68812. export var gpuRenderParticlesPixelShader: {
  68813. name: string;
  68814. shader: string;
  68815. };
  68816. }
  68817. declare module BABYLON {
  68818. /** @hidden */
  68819. export var clipPlaneVertexDeclaration2: {
  68820. name: string;
  68821. shader: string;
  68822. };
  68823. }
  68824. declare module BABYLON {
  68825. /** @hidden */
  68826. export var gpuRenderParticlesVertexShader: {
  68827. name: string;
  68828. shader: string;
  68829. };
  68830. }
  68831. declare module BABYLON {
  68832. /**
  68833. * This represents a GPU particle system in Babylon
  68834. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  68835. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  68836. */
  68837. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  68838. /**
  68839. * The layer mask we are rendering the particles through.
  68840. */
  68841. layerMask: number;
  68842. private _capacity;
  68843. private _activeCount;
  68844. private _currentActiveCount;
  68845. private _accumulatedCount;
  68846. private _renderEffect;
  68847. private _updateEffect;
  68848. private _buffer0;
  68849. private _buffer1;
  68850. private _spriteBuffer;
  68851. private _updateVAO;
  68852. private _renderVAO;
  68853. private _targetIndex;
  68854. private _sourceBuffer;
  68855. private _targetBuffer;
  68856. private _currentRenderId;
  68857. private _started;
  68858. private _stopped;
  68859. private _timeDelta;
  68860. private _randomTexture;
  68861. private _randomTexture2;
  68862. private _attributesStrideSize;
  68863. private _updateEffectOptions;
  68864. private _randomTextureSize;
  68865. private _actualFrame;
  68866. private _customEffect;
  68867. private readonly _rawTextureWidth;
  68868. /**
  68869. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  68870. */
  68871. static get IsSupported(): boolean;
  68872. /**
  68873. * An event triggered when the system is disposed.
  68874. */
  68875. onDisposeObservable: Observable<IParticleSystem>;
  68876. /**
  68877. * An event triggered when the system is stopped
  68878. */
  68879. onStoppedObservable: Observable<IParticleSystem>;
  68880. /**
  68881. * Gets the maximum number of particles active at the same time.
  68882. * @returns The max number of active particles.
  68883. */
  68884. getCapacity(): number;
  68885. /**
  68886. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  68887. * to override the particles.
  68888. */
  68889. forceDepthWrite: boolean;
  68890. /**
  68891. * Gets or set the number of active particles
  68892. */
  68893. get activeParticleCount(): number;
  68894. set activeParticleCount(value: number);
  68895. private _preWarmDone;
  68896. /**
  68897. * Specifies if the particles are updated in emitter local space or world space.
  68898. */
  68899. isLocal: boolean;
  68900. /** Gets or sets a matrix to use to compute projection */
  68901. defaultProjectionMatrix: Matrix;
  68902. /**
  68903. * Is this system ready to be used/rendered
  68904. * @return true if the system is ready
  68905. */
  68906. isReady(): boolean;
  68907. /**
  68908. * Gets if the system has been started. (Note: this will still be true after stop is called)
  68909. * @returns True if it has been started, otherwise false.
  68910. */
  68911. isStarted(): boolean;
  68912. /**
  68913. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  68914. * @returns True if it has been stopped, otherwise false.
  68915. */
  68916. isStopped(): boolean;
  68917. /**
  68918. * Gets a boolean indicating that the system is stopping
  68919. * @returns true if the system is currently stopping
  68920. */
  68921. isStopping(): boolean;
  68922. /**
  68923. * Gets the number of particles active at the same time.
  68924. * @returns The number of active particles.
  68925. */
  68926. getActiveCount(): number;
  68927. /**
  68928. * Starts the particle system and begins to emit
  68929. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  68930. */
  68931. start(delay?: number): void;
  68932. /**
  68933. * Stops the particle system.
  68934. */
  68935. stop(): void;
  68936. /**
  68937. * Remove all active particles
  68938. */
  68939. reset(): void;
  68940. /**
  68941. * Returns the string "GPUParticleSystem"
  68942. * @returns a string containing the class name
  68943. */
  68944. getClassName(): string;
  68945. /**
  68946. * Gets the custom effect used to render the particles
  68947. * @param blendMode Blend mode for which the effect should be retrieved
  68948. * @returns The effect
  68949. */
  68950. getCustomEffect(blendMode?: number): Nullable<Effect>;
  68951. /**
  68952. * Sets the custom effect used to render the particles
  68953. * @param effect The effect to set
  68954. * @param blendMode Blend mode for which the effect should be set
  68955. */
  68956. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  68957. /** @hidden */
  68958. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  68959. /**
  68960. * Observable that will be called just before the particles are drawn
  68961. */
  68962. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  68963. /**
  68964. * Gets the name of the particle vertex shader
  68965. */
  68966. get vertexShaderName(): string;
  68967. private _colorGradientsTexture;
  68968. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  68969. /**
  68970. * Adds a new color gradient
  68971. * @param gradient defines the gradient to use (between 0 and 1)
  68972. * @param color1 defines the color to affect to the specified gradient
  68973. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  68974. * @returns the current particle system
  68975. */
  68976. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  68977. private _refreshColorGradient;
  68978. /** Force the system to rebuild all gradients that need to be resync */
  68979. forceRefreshGradients(): void;
  68980. /**
  68981. * Remove a specific color gradient
  68982. * @param gradient defines the gradient to remove
  68983. * @returns the current particle system
  68984. */
  68985. removeColorGradient(gradient: number): GPUParticleSystem;
  68986. private _angularSpeedGradientsTexture;
  68987. private _sizeGradientsTexture;
  68988. private _velocityGradientsTexture;
  68989. private _limitVelocityGradientsTexture;
  68990. private _dragGradientsTexture;
  68991. private _addFactorGradient;
  68992. /**
  68993. * Adds a new size gradient
  68994. * @param gradient defines the gradient to use (between 0 and 1)
  68995. * @param factor defines the size factor to affect to the specified gradient
  68996. * @returns the current particle system
  68997. */
  68998. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  68999. /**
  69000. * Remove a specific size gradient
  69001. * @param gradient defines the gradient to remove
  69002. * @returns the current particle system
  69003. */
  69004. removeSizeGradient(gradient: number): GPUParticleSystem;
  69005. private _refreshFactorGradient;
  69006. /**
  69007. * Adds a new angular speed gradient
  69008. * @param gradient defines the gradient to use (between 0 and 1)
  69009. * @param factor defines the angular speed to affect to the specified gradient
  69010. * @returns the current particle system
  69011. */
  69012. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  69013. /**
  69014. * Remove a specific angular speed gradient
  69015. * @param gradient defines the gradient to remove
  69016. * @returns the current particle system
  69017. */
  69018. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  69019. /**
  69020. * Adds a new velocity gradient
  69021. * @param gradient defines the gradient to use (between 0 and 1)
  69022. * @param factor defines the velocity to affect to the specified gradient
  69023. * @returns the current particle system
  69024. */
  69025. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  69026. /**
  69027. * Remove a specific velocity gradient
  69028. * @param gradient defines the gradient to remove
  69029. * @returns the current particle system
  69030. */
  69031. removeVelocityGradient(gradient: number): GPUParticleSystem;
  69032. /**
  69033. * Adds a new limit velocity gradient
  69034. * @param gradient defines the gradient to use (between 0 and 1)
  69035. * @param factor defines the limit velocity value to affect to the specified gradient
  69036. * @returns the current particle system
  69037. */
  69038. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  69039. /**
  69040. * Remove a specific limit velocity gradient
  69041. * @param gradient defines the gradient to remove
  69042. * @returns the current particle system
  69043. */
  69044. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  69045. /**
  69046. * Adds a new drag gradient
  69047. * @param gradient defines the gradient to use (between 0 and 1)
  69048. * @param factor defines the drag value to affect to the specified gradient
  69049. * @returns the current particle system
  69050. */
  69051. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  69052. /**
  69053. * Remove a specific drag gradient
  69054. * @param gradient defines the gradient to remove
  69055. * @returns the current particle system
  69056. */
  69057. removeDragGradient(gradient: number): GPUParticleSystem;
  69058. /**
  69059. * Not supported by GPUParticleSystem
  69060. * @param gradient defines the gradient to use (between 0 and 1)
  69061. * @param factor defines the emit rate value to affect to the specified gradient
  69062. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  69063. * @returns the current particle system
  69064. */
  69065. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  69066. /**
  69067. * Not supported by GPUParticleSystem
  69068. * @param gradient defines the gradient to remove
  69069. * @returns the current particle system
  69070. */
  69071. removeEmitRateGradient(gradient: number): IParticleSystem;
  69072. /**
  69073. * Not supported by GPUParticleSystem
  69074. * @param gradient defines the gradient to use (between 0 and 1)
  69075. * @param factor defines the start size value to affect to the specified gradient
  69076. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  69077. * @returns the current particle system
  69078. */
  69079. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  69080. /**
  69081. * Not supported by GPUParticleSystem
  69082. * @param gradient defines the gradient to remove
  69083. * @returns the current particle system
  69084. */
  69085. removeStartSizeGradient(gradient: number): IParticleSystem;
  69086. /**
  69087. * Not supported by GPUParticleSystem
  69088. * @param gradient defines the gradient to use (between 0 and 1)
  69089. * @param min defines the color remap minimal range
  69090. * @param max defines the color remap maximal range
  69091. * @returns the current particle system
  69092. */
  69093. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  69094. /**
  69095. * Not supported by GPUParticleSystem
  69096. * @param gradient defines the gradient to remove
  69097. * @returns the current particle system
  69098. */
  69099. removeColorRemapGradient(): IParticleSystem;
  69100. /**
  69101. * Not supported by GPUParticleSystem
  69102. * @param gradient defines the gradient to use (between 0 and 1)
  69103. * @param min defines the alpha remap minimal range
  69104. * @param max defines the alpha remap maximal range
  69105. * @returns the current particle system
  69106. */
  69107. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  69108. /**
  69109. * Not supported by GPUParticleSystem
  69110. * @param gradient defines the gradient to remove
  69111. * @returns the current particle system
  69112. */
  69113. removeAlphaRemapGradient(): IParticleSystem;
  69114. /**
  69115. * Not supported by GPUParticleSystem
  69116. * @param gradient defines the gradient to use (between 0 and 1)
  69117. * @param color defines the color to affect to the specified gradient
  69118. * @returns the current particle system
  69119. */
  69120. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  69121. /**
  69122. * Not supported by GPUParticleSystem
  69123. * @param gradient defines the gradient to remove
  69124. * @returns the current particle system
  69125. */
  69126. removeRampGradient(): IParticleSystem;
  69127. /**
  69128. * Not supported by GPUParticleSystem
  69129. * @returns the list of ramp gradients
  69130. */
  69131. getRampGradients(): Nullable<Array<Color3Gradient>>;
  69132. /**
  69133. * Not supported by GPUParticleSystem
  69134. * Gets or sets a boolean indicating that ramp gradients must be used
  69135. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  69136. */
  69137. get useRampGradients(): boolean;
  69138. set useRampGradients(value: boolean);
  69139. /**
  69140. * Not supported by GPUParticleSystem
  69141. * @param gradient defines the gradient to use (between 0 and 1)
  69142. * @param factor defines the life time factor to affect to the specified gradient
  69143. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  69144. * @returns the current particle system
  69145. */
  69146. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  69147. /**
  69148. * Not supported by GPUParticleSystem
  69149. * @param gradient defines the gradient to remove
  69150. * @returns the current particle system
  69151. */
  69152. removeLifeTimeGradient(gradient: number): IParticleSystem;
  69153. /**
  69154. * Instantiates a GPU particle system.
  69155. * 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.
  69156. * @param name The name of the particle system
  69157. * @param options The options used to create the system
  69158. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  69159. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  69160. * @param customEffect a custom effect used to change the way particles are rendered by default
  69161. */
  69162. constructor(name: string, options: Partial<{
  69163. capacity: number;
  69164. randomTextureSize: number;
  69165. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  69166. protected _reset(): void;
  69167. private _createUpdateVAO;
  69168. private _createRenderVAO;
  69169. private _initialize;
  69170. /** @hidden */
  69171. _recreateUpdateEffect(): void;
  69172. private _getEffect;
  69173. /**
  69174. * Fill the defines array according to the current settings of the particle system
  69175. * @param defines Array to be updated
  69176. * @param blendMode blend mode to take into account when updating the array
  69177. */
  69178. fillDefines(defines: Array<string>, blendMode?: number): void;
  69179. /**
  69180. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  69181. * @param uniforms Uniforms array to fill
  69182. * @param attributes Attributes array to fill
  69183. * @param samplers Samplers array to fill
  69184. */
  69185. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  69186. /** @hidden */
  69187. _recreateRenderEffect(): Effect;
  69188. /**
  69189. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  69190. * @param preWarm defines if we are in the pre-warmimg phase
  69191. */
  69192. animate(preWarm?: boolean): void;
  69193. private _createFactorGradientTexture;
  69194. private _createSizeGradientTexture;
  69195. private _createAngularSpeedGradientTexture;
  69196. private _createVelocityGradientTexture;
  69197. private _createLimitVelocityGradientTexture;
  69198. private _createDragGradientTexture;
  69199. private _createColorGradientTexture;
  69200. /**
  69201. * Renders the particle system in its current state
  69202. * @param preWarm defines if the system should only update the particles but not render them
  69203. * @returns the current number of particles
  69204. */
  69205. render(preWarm?: boolean): number;
  69206. /**
  69207. * Rebuilds the particle system
  69208. */
  69209. rebuild(): void;
  69210. private _releaseBuffers;
  69211. private _releaseVAOs;
  69212. /**
  69213. * Disposes the particle system and free the associated resources
  69214. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  69215. */
  69216. dispose(disposeTexture?: boolean): void;
  69217. /**
  69218. * Clones the particle system.
  69219. * @param name The name of the cloned object
  69220. * @param newEmitter The new emitter to use
  69221. * @returns the cloned particle system
  69222. */
  69223. clone(name: string, newEmitter: any): GPUParticleSystem;
  69224. /**
  69225. * Serializes the particle system to a JSON object
  69226. * @param serializeTexture defines if the texture must be serialized as well
  69227. * @returns the JSON object
  69228. */
  69229. serialize(serializeTexture?: boolean): any;
  69230. /**
  69231. * Parses a JSON object to create a GPU particle system.
  69232. * @param parsedParticleSystem The JSON object to parse
  69233. * @param sceneOrEngine The scene or the engine to create the particle system in
  69234. * @param rootUrl The root url to use to load external dependencies like texture
  69235. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  69236. * @returns the parsed GPU particle system
  69237. */
  69238. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  69239. }
  69240. }
  69241. declare module BABYLON {
  69242. /**
  69243. * Represents a set of particle systems working together to create a specific effect
  69244. */
  69245. export class ParticleSystemSet implements IDisposable {
  69246. /**
  69247. * Gets or sets base Assets URL
  69248. */
  69249. static BaseAssetsUrl: string;
  69250. private _emitterCreationOptions;
  69251. private _emitterNode;
  69252. /**
  69253. * Gets the particle system list
  69254. */
  69255. systems: IParticleSystem[];
  69256. /**
  69257. * Gets the emitter node used with this set
  69258. */
  69259. get emitterNode(): Nullable<TransformNode>;
  69260. /**
  69261. * Creates a new emitter mesh as a sphere
  69262. * @param options defines the options used to create the sphere
  69263. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  69264. * @param scene defines the hosting scene
  69265. */
  69266. setEmitterAsSphere(options: {
  69267. diameter: number;
  69268. segments: number;
  69269. color: Color3;
  69270. }, renderingGroupId: number, scene: Scene): void;
  69271. /**
  69272. * Starts all particle systems of the set
  69273. * @param emitter defines an optional mesh to use as emitter for the particle systems
  69274. */
  69275. start(emitter?: AbstractMesh): void;
  69276. /**
  69277. * Release all associated resources
  69278. */
  69279. dispose(): void;
  69280. /**
  69281. * Serialize the set into a JSON compatible object
  69282. * @param serializeTexture defines if the texture must be serialized as well
  69283. * @returns a JSON compatible representation of the set
  69284. */
  69285. serialize(serializeTexture?: boolean): any;
  69286. /**
  69287. * Parse a new ParticleSystemSet from a serialized source
  69288. * @param data defines a JSON compatible representation of the set
  69289. * @param scene defines the hosting scene
  69290. * @param gpu defines if we want GPU particles or CPU particles
  69291. * @returns a new ParticleSystemSet
  69292. */
  69293. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  69294. }
  69295. }
  69296. declare module BABYLON {
  69297. /**
  69298. * This class is made for on one-liner static method to help creating particle system set.
  69299. */
  69300. export class ParticleHelper {
  69301. /**
  69302. * Gets or sets base Assets URL
  69303. */
  69304. static BaseAssetsUrl: string;
  69305. /** Define the Url to load snippets */
  69306. static SnippetUrl: string;
  69307. /**
  69308. * Create a default particle system that you can tweak
  69309. * @param emitter defines the emitter to use
  69310. * @param capacity defines the system capacity (default is 500 particles)
  69311. * @param scene defines the hosting scene
  69312. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  69313. * @returns the new Particle system
  69314. */
  69315. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  69316. /**
  69317. * This is the main static method (one-liner) of this helper to create different particle systems
  69318. * @param type This string represents the type to the particle system to create
  69319. * @param scene The scene where the particle system should live
  69320. * @param gpu If the system will use gpu
  69321. * @returns the ParticleSystemSet created
  69322. */
  69323. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  69324. /**
  69325. * Static function used to export a particle system to a ParticleSystemSet variable.
  69326. * Please note that the emitter shape is not exported
  69327. * @param systems defines the particle systems to export
  69328. * @returns the created particle system set
  69329. */
  69330. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  69331. /**
  69332. * Creates a particle system from a snippet saved in a remote file
  69333. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  69334. * @param url defines the url to load from
  69335. * @param scene defines the hosting scene
  69336. * @param gpu If the system will use gpu
  69337. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  69338. * @returns a promise that will resolve to the new particle system
  69339. */
  69340. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  69341. /**
  69342. * Creates a particle system from a snippet saved by the particle system editor
  69343. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  69344. * @param scene defines the hosting scene
  69345. * @param gpu If the system will use gpu
  69346. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  69347. * @returns a promise that will resolve to the new particle system
  69348. */
  69349. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  69350. }
  69351. }
  69352. declare module BABYLON {
  69353. interface Engine {
  69354. /**
  69355. * Create an effect to use with particle systems.
  69356. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  69357. * the particle system for which you want to create a custom effect in the last parameter
  69358. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  69359. * @param uniformsNames defines a list of attribute names
  69360. * @param samplers defines an array of string used to represent textures
  69361. * @param defines defines the string containing the defines to use to compile the shaders
  69362. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  69363. * @param onCompiled defines a function to call when the effect creation is successful
  69364. * @param onError defines a function to call when the effect creation has failed
  69365. * @param particleSystem the particle system you want to create the effect for
  69366. * @returns the new Effect
  69367. */
  69368. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  69369. }
  69370. interface Mesh {
  69371. /**
  69372. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  69373. * @returns an array of IParticleSystem
  69374. */
  69375. getEmittedParticleSystems(): IParticleSystem[];
  69376. /**
  69377. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  69378. * @returns an array of IParticleSystem
  69379. */
  69380. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  69381. }
  69382. }
  69383. declare module BABYLON {
  69384. /** Defines the 4 color options */
  69385. export enum PointColor {
  69386. /** color value */
  69387. Color = 2,
  69388. /** uv value */
  69389. UV = 1,
  69390. /** random value */
  69391. Random = 0,
  69392. /** stated value */
  69393. Stated = 3
  69394. }
  69395. /**
  69396. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  69397. * As it is just a mesh, the PointCloudSystem has all the same properties as any other BJS mesh : not more, not less. It can be scaled, rotated, translated, enlighted, textured, moved, etc.
  69398. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  69399. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  69400. *
  69401. * Full documentation here : TO BE ENTERED
  69402. */
  69403. export class PointsCloudSystem implements IDisposable {
  69404. /**
  69405. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  69406. * Example : var p = SPS.particles[i];
  69407. */
  69408. particles: CloudPoint[];
  69409. /**
  69410. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  69411. */
  69412. nbParticles: number;
  69413. /**
  69414. * This a counter for your own usage. It's not set by any SPS functions.
  69415. */
  69416. counter: number;
  69417. /**
  69418. * The PCS name. This name is also given to the underlying mesh.
  69419. */
  69420. name: string;
  69421. /**
  69422. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  69423. */
  69424. mesh: Mesh;
  69425. /**
  69426. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  69427. * Please read :
  69428. */
  69429. vars: any;
  69430. /**
  69431. * @hidden
  69432. */
  69433. _size: number;
  69434. private _scene;
  69435. private _promises;
  69436. private _positions;
  69437. private _indices;
  69438. private _normals;
  69439. private _colors;
  69440. private _uvs;
  69441. private _indices32;
  69442. private _positions32;
  69443. private _colors32;
  69444. private _uvs32;
  69445. private _updatable;
  69446. private _isVisibilityBoxLocked;
  69447. private _alwaysVisible;
  69448. private _groups;
  69449. private _groupCounter;
  69450. private _computeParticleColor;
  69451. private _computeParticleTexture;
  69452. private _computeParticleRotation;
  69453. private _computeBoundingBox;
  69454. private _isReady;
  69455. /**
  69456. * Creates a PCS (Points Cloud System) object
  69457. * @param name (String) is the PCS name, this will be the underlying mesh name
  69458. * @param pointSize (number) is the size for each point
  69459. * @param scene (Scene) is the scene in which the PCS is added
  69460. * @param options defines the options of the PCS e.g.
  69461. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  69462. */
  69463. constructor(name: string, pointSize: number, scene: Scene, options?: {
  69464. updatable?: boolean;
  69465. });
  69466. /**
  69467. * Builds the PCS underlying mesh. Returns a standard Mesh.
  69468. * If no points were added to the PCS, the returned mesh is just a single point.
  69469. * @returns a promise for the created mesh
  69470. */
  69471. buildMeshAsync(): Promise<Mesh>;
  69472. /**
  69473. * @hidden
  69474. */
  69475. private _buildMesh;
  69476. private _addParticle;
  69477. private _randomUnitVector;
  69478. private _getColorIndicesForCoord;
  69479. private _setPointsColorOrUV;
  69480. private _colorFromTexture;
  69481. private _calculateDensity;
  69482. /**
  69483. * Adds points to the PCS in random positions within a unit sphere
  69484. * @param nb (positive integer) the number of particles to be created from this model
  69485. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  69486. * @returns the number of groups in the system
  69487. */
  69488. addPoints(nb: number, pointFunction?: any): number;
  69489. /**
  69490. * Adds points to the PCS from the surface of the model shape
  69491. * @param mesh is any Mesh object that will be used as a surface model for the points
  69492. * @param nb (positive integer) the number of particles to be created from this model
  69493. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  69494. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  69495. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  69496. * @returns the number of groups in the system
  69497. */
  69498. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  69499. /**
  69500. * Adds points to the PCS inside the model shape
  69501. * @param mesh is any Mesh object that will be used as a surface model for the points
  69502. * @param nb (positive integer) the number of particles to be created from this model
  69503. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  69504. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  69505. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  69506. * @returns the number of groups in the system
  69507. */
  69508. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  69509. /**
  69510. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  69511. * This method calls `updateParticle()` for each particle of the SPS.
  69512. * For an animated SPS, it is usually called within the render loop.
  69513. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  69514. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  69515. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  69516. * @returns the PCS.
  69517. */
  69518. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  69519. /**
  69520. * Disposes the PCS.
  69521. */
  69522. dispose(): void;
  69523. /**
  69524. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  69525. * doc :
  69526. * @returns the PCS.
  69527. */
  69528. refreshVisibleSize(): PointsCloudSystem;
  69529. /**
  69530. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  69531. * @param size the size (float) of the visibility box
  69532. * note : this doesn't lock the PCS mesh bounding box.
  69533. * doc :
  69534. */
  69535. setVisibilityBox(size: number): void;
  69536. /**
  69537. * Gets whether the PCS is always visible or not
  69538. * doc :
  69539. */
  69540. get isAlwaysVisible(): boolean;
  69541. /**
  69542. * Sets the PCS as always visible or not
  69543. * doc :
  69544. */
  69545. set isAlwaysVisible(val: boolean);
  69546. /**
  69547. * Tells to `setParticles()` to compute the particle rotations or not
  69548. * Default value : false. The PCS is faster when it's set to false
  69549. * Note : particle rotations are only applied to parent particles
  69550. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  69551. */
  69552. set computeParticleRotation(val: boolean);
  69553. /**
  69554. * Tells to `setParticles()` to compute the particle colors or not.
  69555. * Default value : true. The PCS is faster when it's set to false.
  69556. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  69557. */
  69558. set computeParticleColor(val: boolean);
  69559. set computeParticleTexture(val: boolean);
  69560. /**
  69561. * Gets if `setParticles()` computes the particle colors or not.
  69562. * Default value : false. The PCS is faster when it's set to false.
  69563. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  69564. */
  69565. get computeParticleColor(): boolean;
  69566. /**
  69567. * Gets if `setParticles()` computes the particle textures or not.
  69568. * Default value : false. The PCS is faster when it's set to false.
  69569. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  69570. */
  69571. get computeParticleTexture(): boolean;
  69572. /**
  69573. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  69574. */
  69575. set computeBoundingBox(val: boolean);
  69576. /**
  69577. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  69578. */
  69579. get computeBoundingBox(): boolean;
  69580. /**
  69581. * This function does nothing. It may be overwritten to set all the particle first values.
  69582. * The PCS doesn't call this function, you may have to call it by your own.
  69583. * doc :
  69584. */
  69585. initParticles(): void;
  69586. /**
  69587. * This function does nothing. It may be overwritten to recycle a particle
  69588. * The PCS doesn't call this function, you can to call it
  69589. * doc :
  69590. * @param particle The particle to recycle
  69591. * @returns the recycled particle
  69592. */
  69593. recycleParticle(particle: CloudPoint): CloudPoint;
  69594. /**
  69595. * Updates a particle : this function should be overwritten by the user.
  69596. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  69597. * doc :
  69598. * @example : just set a particle position or velocity and recycle conditions
  69599. * @param particle The particle to update
  69600. * @returns the updated particle
  69601. */
  69602. updateParticle(particle: CloudPoint): CloudPoint;
  69603. /**
  69604. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  69605. * This does nothing and may be overwritten by the user.
  69606. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  69607. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  69608. * @param update the boolean update value actually passed to setParticles()
  69609. */
  69610. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  69611. /**
  69612. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  69613. * This will be passed three parameters.
  69614. * This does nothing and may be overwritten by the user.
  69615. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  69616. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  69617. * @param update the boolean update value actually passed to setParticles()
  69618. */
  69619. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  69620. }
  69621. }
  69622. declare module BABYLON {
  69623. /**
  69624. * Represents one particle of a points cloud system.
  69625. */
  69626. export class CloudPoint {
  69627. /**
  69628. * particle global index
  69629. */
  69630. idx: number;
  69631. /**
  69632. * The color of the particle
  69633. */
  69634. color: Nullable<Color4>;
  69635. /**
  69636. * The world space position of the particle.
  69637. */
  69638. position: Vector3;
  69639. /**
  69640. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  69641. */
  69642. rotation: Vector3;
  69643. /**
  69644. * The world space rotation quaternion of the particle.
  69645. */
  69646. rotationQuaternion: Nullable<Quaternion>;
  69647. /**
  69648. * The uv of the particle.
  69649. */
  69650. uv: Nullable<Vector2>;
  69651. /**
  69652. * The current speed of the particle.
  69653. */
  69654. velocity: Vector3;
  69655. /**
  69656. * The pivot point in the particle local space.
  69657. */
  69658. pivot: Vector3;
  69659. /**
  69660. * Must the particle be translated from its pivot point in its local space ?
  69661. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  69662. * Default : false
  69663. */
  69664. translateFromPivot: boolean;
  69665. /**
  69666. * Index of this particle in the global "positions" array (Internal use)
  69667. * @hidden
  69668. */
  69669. _pos: number;
  69670. /**
  69671. * @hidden Index of this particle in the global "indices" array (Internal use)
  69672. */
  69673. _ind: number;
  69674. /**
  69675. * Group this particle belongs to
  69676. */
  69677. _group: PointsGroup;
  69678. /**
  69679. * Group id of this particle
  69680. */
  69681. groupId: number;
  69682. /**
  69683. * Index of the particle in its group id (Internal use)
  69684. */
  69685. idxInGroup: number;
  69686. /**
  69687. * @hidden Particle BoundingInfo object (Internal use)
  69688. */
  69689. _boundingInfo: BoundingInfo;
  69690. /**
  69691. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  69692. */
  69693. _pcs: PointsCloudSystem;
  69694. /**
  69695. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  69696. */
  69697. _stillInvisible: boolean;
  69698. /**
  69699. * @hidden Last computed particle rotation matrix
  69700. */
  69701. _rotationMatrix: number[];
  69702. /**
  69703. * Parent particle Id, if any.
  69704. * Default null.
  69705. */
  69706. parentId: Nullable<number>;
  69707. /**
  69708. * @hidden Internal global position in the PCS.
  69709. */
  69710. _globalPosition: Vector3;
  69711. /**
  69712. * Creates a Point Cloud object.
  69713. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  69714. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  69715. * @param group (PointsGroup) is the group the particle belongs to
  69716. * @param groupId (integer) is the group identifier in the PCS.
  69717. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  69718. * @param pcs defines the PCS it is associated to
  69719. */
  69720. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  69721. /**
  69722. * get point size
  69723. */
  69724. get size(): Vector3;
  69725. /**
  69726. * Set point size
  69727. */
  69728. set size(scale: Vector3);
  69729. /**
  69730. * Legacy support, changed quaternion to rotationQuaternion
  69731. */
  69732. get quaternion(): Nullable<Quaternion>;
  69733. /**
  69734. * Legacy support, changed quaternion to rotationQuaternion
  69735. */
  69736. set quaternion(q: Nullable<Quaternion>);
  69737. /**
  69738. * Returns a boolean. True if the particle intersects a mesh, else false
  69739. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  69740. * @param target is the object (point or mesh) what the intersection is computed against
  69741. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  69742. * @returns true if it intersects
  69743. */
  69744. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  69745. /**
  69746. * get the rotation matrix of the particle
  69747. * @hidden
  69748. */
  69749. getRotationMatrix(m: Matrix): void;
  69750. }
  69751. /**
  69752. * Represents a group of points in a points cloud system
  69753. * * PCS internal tool, don't use it manually.
  69754. */
  69755. export class PointsGroup {
  69756. /**
  69757. * The group id
  69758. * @hidden
  69759. */
  69760. groupID: number;
  69761. /**
  69762. * image data for group (internal use)
  69763. * @hidden
  69764. */
  69765. _groupImageData: Nullable<ArrayBufferView>;
  69766. /**
  69767. * Image Width (internal use)
  69768. * @hidden
  69769. */
  69770. _groupImgWidth: number;
  69771. /**
  69772. * Image Height (internal use)
  69773. * @hidden
  69774. */
  69775. _groupImgHeight: number;
  69776. /**
  69777. * Custom position function (internal use)
  69778. * @hidden
  69779. */
  69780. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  69781. /**
  69782. * density per facet for surface points
  69783. * @hidden
  69784. */
  69785. _groupDensity: number[];
  69786. /**
  69787. * Only when points are colored by texture carries pointer to texture list array
  69788. * @hidden
  69789. */
  69790. _textureNb: number;
  69791. /**
  69792. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  69793. * PCS internal tool, don't use it manually.
  69794. * @hidden
  69795. */
  69796. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  69797. }
  69798. }
  69799. declare module BABYLON {
  69800. interface Scene {
  69801. /** @hidden (Backing field) */
  69802. _physicsEngine: Nullable<IPhysicsEngine>;
  69803. /** @hidden */
  69804. _physicsTimeAccumulator: number;
  69805. /**
  69806. * Gets the current physics engine
  69807. * @returns a IPhysicsEngine or null if none attached
  69808. */
  69809. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  69810. /**
  69811. * Enables physics to the current scene
  69812. * @param gravity defines the scene's gravity for the physics engine
  69813. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  69814. * @return a boolean indicating if the physics engine was initialized
  69815. */
  69816. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  69817. /**
  69818. * Disables and disposes the physics engine associated with the scene
  69819. */
  69820. disablePhysicsEngine(): void;
  69821. /**
  69822. * Gets a boolean indicating if there is an active physics engine
  69823. * @returns a boolean indicating if there is an active physics engine
  69824. */
  69825. isPhysicsEnabled(): boolean;
  69826. /**
  69827. * Deletes a physics compound impostor
  69828. * @param compound defines the compound to delete
  69829. */
  69830. deleteCompoundImpostor(compound: any): void;
  69831. /**
  69832. * An event triggered when physic simulation is about to be run
  69833. */
  69834. onBeforePhysicsObservable: Observable<Scene>;
  69835. /**
  69836. * An event triggered when physic simulation has been done
  69837. */
  69838. onAfterPhysicsObservable: Observable<Scene>;
  69839. }
  69840. interface AbstractMesh {
  69841. /** @hidden */
  69842. _physicsImpostor: Nullable<PhysicsImpostor>;
  69843. /**
  69844. * Gets or sets impostor used for physic simulation
  69845. * @see https://doc.babylonjs.com/features/physics_engine
  69846. */
  69847. physicsImpostor: Nullable<PhysicsImpostor>;
  69848. /**
  69849. * Gets the current physics impostor
  69850. * @see https://doc.babylonjs.com/features/physics_engine
  69851. * @returns a physics impostor or null
  69852. */
  69853. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  69854. /** Apply a physic impulse to the mesh
  69855. * @param force defines the force to apply
  69856. * @param contactPoint defines where to apply the force
  69857. * @returns the current mesh
  69858. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  69859. */
  69860. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  69861. /**
  69862. * Creates a physic joint between two meshes
  69863. * @param otherMesh defines the other mesh to use
  69864. * @param pivot1 defines the pivot to use on this mesh
  69865. * @param pivot2 defines the pivot to use on the other mesh
  69866. * @param options defines additional options (can be plugin dependent)
  69867. * @returns the current mesh
  69868. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  69869. */
  69870. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  69871. /** @hidden */
  69872. _disposePhysicsObserver: Nullable<Observer<Node>>;
  69873. }
  69874. /**
  69875. * Defines the physics engine scene component responsible to manage a physics engine
  69876. */
  69877. export class PhysicsEngineSceneComponent implements ISceneComponent {
  69878. /**
  69879. * The component name helpful to identify the component in the list of scene components.
  69880. */
  69881. readonly name: string;
  69882. /**
  69883. * The scene the component belongs to.
  69884. */
  69885. scene: Scene;
  69886. /**
  69887. * Creates a new instance of the component for the given scene
  69888. * @param scene Defines the scene to register the component in
  69889. */
  69890. constructor(scene: Scene);
  69891. /**
  69892. * Registers the component in a given scene
  69893. */
  69894. register(): void;
  69895. /**
  69896. * Rebuilds the elements related to this component in case of
  69897. * context lost for instance.
  69898. */
  69899. rebuild(): void;
  69900. /**
  69901. * Disposes the component and the associated ressources
  69902. */
  69903. dispose(): void;
  69904. }
  69905. }
  69906. declare module BABYLON {
  69907. /**
  69908. * A helper for physics simulations
  69909. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  69910. */
  69911. export class PhysicsHelper {
  69912. private _scene;
  69913. private _physicsEngine;
  69914. /**
  69915. * Initializes the Physics helper
  69916. * @param scene Babylon.js scene
  69917. */
  69918. constructor(scene: Scene);
  69919. /**
  69920. * Applies a radial explosion impulse
  69921. * @param origin the origin of the explosion
  69922. * @param radiusOrEventOptions the radius or the options of radial explosion
  69923. * @param strength the explosion strength
  69924. * @param falloff possible options: Constant & Linear. Defaults to Constant
  69925. * @returns A physics radial explosion event, or null
  69926. */
  69927. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  69928. /**
  69929. * Applies a radial explosion force
  69930. * @param origin the origin of the explosion
  69931. * @param radiusOrEventOptions the radius or the options of radial explosion
  69932. * @param strength the explosion strength
  69933. * @param falloff possible options: Constant & Linear. Defaults to Constant
  69934. * @returns A physics radial explosion event, or null
  69935. */
  69936. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  69937. /**
  69938. * Creates a gravitational field
  69939. * @param origin the origin of the explosion
  69940. * @param radiusOrEventOptions the radius or the options of radial explosion
  69941. * @param strength the explosion strength
  69942. * @param falloff possible options: Constant & Linear. Defaults to Constant
  69943. * @returns A physics gravitational field event, or null
  69944. */
  69945. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  69946. /**
  69947. * Creates a physics updraft event
  69948. * @param origin the origin of the updraft
  69949. * @param radiusOrEventOptions the radius or the options of the updraft
  69950. * @param strength the strength of the updraft
  69951. * @param height the height of the updraft
  69952. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  69953. * @returns A physics updraft event, or null
  69954. */
  69955. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  69956. /**
  69957. * Creates a physics vortex event
  69958. * @param origin the of the vortex
  69959. * @param radiusOrEventOptions the radius or the options of the vortex
  69960. * @param strength the strength of the vortex
  69961. * @param height the height of the vortex
  69962. * @returns a Physics vortex event, or null
  69963. * A physics vortex event or null
  69964. */
  69965. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  69966. }
  69967. /**
  69968. * Represents a physics radial explosion event
  69969. */
  69970. class PhysicsRadialExplosionEvent {
  69971. private _scene;
  69972. private _options;
  69973. private _sphere;
  69974. private _dataFetched;
  69975. /**
  69976. * Initializes a radial explosioin event
  69977. * @param _scene BabylonJS scene
  69978. * @param _options The options for the vortex event
  69979. */
  69980. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  69981. /**
  69982. * Returns the data related to the radial explosion event (sphere).
  69983. * @returns The radial explosion event data
  69984. */
  69985. getData(): PhysicsRadialExplosionEventData;
  69986. /**
  69987. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  69988. * @param impostor A physics imposter
  69989. * @param origin the origin of the explosion
  69990. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  69991. */
  69992. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  69993. /**
  69994. * Triggers affecterd impostors callbacks
  69995. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  69996. */
  69997. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  69998. /**
  69999. * Disposes the sphere.
  70000. * @param force Specifies if the sphere should be disposed by force
  70001. */
  70002. dispose(force?: boolean): void;
  70003. /*** Helpers ***/
  70004. private _prepareSphere;
  70005. private _intersectsWithSphere;
  70006. }
  70007. /**
  70008. * Represents a gravitational field event
  70009. */
  70010. class PhysicsGravitationalFieldEvent {
  70011. private _physicsHelper;
  70012. private _scene;
  70013. private _origin;
  70014. private _options;
  70015. private _tickCallback;
  70016. private _sphere;
  70017. private _dataFetched;
  70018. /**
  70019. * Initializes the physics gravitational field event
  70020. * @param _physicsHelper A physics helper
  70021. * @param _scene BabylonJS scene
  70022. * @param _origin The origin position of the gravitational field event
  70023. * @param _options The options for the vortex event
  70024. */
  70025. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  70026. /**
  70027. * Returns the data related to the gravitational field event (sphere).
  70028. * @returns A gravitational field event
  70029. */
  70030. getData(): PhysicsGravitationalFieldEventData;
  70031. /**
  70032. * Enables the gravitational field.
  70033. */
  70034. enable(): void;
  70035. /**
  70036. * Disables the gravitational field.
  70037. */
  70038. disable(): void;
  70039. /**
  70040. * Disposes the sphere.
  70041. * @param force The force to dispose from the gravitational field event
  70042. */
  70043. dispose(force?: boolean): void;
  70044. private _tick;
  70045. }
  70046. /**
  70047. * Represents a physics updraft event
  70048. */
  70049. class PhysicsUpdraftEvent {
  70050. private _scene;
  70051. private _origin;
  70052. private _options;
  70053. private _physicsEngine;
  70054. private _originTop;
  70055. private _originDirection;
  70056. private _tickCallback;
  70057. private _cylinder;
  70058. private _cylinderPosition;
  70059. private _dataFetched;
  70060. /**
  70061. * Initializes the physics updraft event
  70062. * @param _scene BabylonJS scene
  70063. * @param _origin The origin position of the updraft
  70064. * @param _options The options for the updraft event
  70065. */
  70066. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  70067. /**
  70068. * Returns the data related to the updraft event (cylinder).
  70069. * @returns A physics updraft event
  70070. */
  70071. getData(): PhysicsUpdraftEventData;
  70072. /**
  70073. * Enables the updraft.
  70074. */
  70075. enable(): void;
  70076. /**
  70077. * Disables the updraft.
  70078. */
  70079. disable(): void;
  70080. /**
  70081. * Disposes the cylinder.
  70082. * @param force Specifies if the updraft should be disposed by force
  70083. */
  70084. dispose(force?: boolean): void;
  70085. private getImpostorHitData;
  70086. private _tick;
  70087. /*** Helpers ***/
  70088. private _prepareCylinder;
  70089. private _intersectsWithCylinder;
  70090. }
  70091. /**
  70092. * Represents a physics vortex event
  70093. */
  70094. class PhysicsVortexEvent {
  70095. private _scene;
  70096. private _origin;
  70097. private _options;
  70098. private _physicsEngine;
  70099. private _originTop;
  70100. private _tickCallback;
  70101. private _cylinder;
  70102. private _cylinderPosition;
  70103. private _dataFetched;
  70104. /**
  70105. * Initializes the physics vortex event
  70106. * @param _scene The BabylonJS scene
  70107. * @param _origin The origin position of the vortex
  70108. * @param _options The options for the vortex event
  70109. */
  70110. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  70111. /**
  70112. * Returns the data related to the vortex event (cylinder).
  70113. * @returns The physics vortex event data
  70114. */
  70115. getData(): PhysicsVortexEventData;
  70116. /**
  70117. * Enables the vortex.
  70118. */
  70119. enable(): void;
  70120. /**
  70121. * Disables the cortex.
  70122. */
  70123. disable(): void;
  70124. /**
  70125. * Disposes the sphere.
  70126. * @param force
  70127. */
  70128. dispose(force?: boolean): void;
  70129. private getImpostorHitData;
  70130. private _tick;
  70131. /*** Helpers ***/
  70132. private _prepareCylinder;
  70133. private _intersectsWithCylinder;
  70134. }
  70135. /**
  70136. * Options fot the radial explosion event
  70137. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  70138. */
  70139. export class PhysicsRadialExplosionEventOptions {
  70140. /**
  70141. * The radius of the sphere for the radial explosion.
  70142. */
  70143. radius: number;
  70144. /**
  70145. * The strenth of the explosion.
  70146. */
  70147. strength: number;
  70148. /**
  70149. * The strenght of the force in correspondence to the distance of the affected object
  70150. */
  70151. falloff: PhysicsRadialImpulseFalloff;
  70152. /**
  70153. * Sphere options for the radial explosion.
  70154. */
  70155. sphere: {
  70156. segments: number;
  70157. diameter: number;
  70158. };
  70159. /**
  70160. * Sphere options for the radial explosion.
  70161. */
  70162. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  70163. }
  70164. /**
  70165. * Options fot the updraft event
  70166. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  70167. */
  70168. export class PhysicsUpdraftEventOptions {
  70169. /**
  70170. * The radius of the cylinder for the vortex
  70171. */
  70172. radius: number;
  70173. /**
  70174. * The strenth of the updraft.
  70175. */
  70176. strength: number;
  70177. /**
  70178. * The height of the cylinder for the updraft.
  70179. */
  70180. height: number;
  70181. /**
  70182. * The mode for the the updraft.
  70183. */
  70184. updraftMode: PhysicsUpdraftMode;
  70185. }
  70186. /**
  70187. * Options fot the vortex event
  70188. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  70189. */
  70190. export class PhysicsVortexEventOptions {
  70191. /**
  70192. * The radius of the cylinder for the vortex
  70193. */
  70194. radius: number;
  70195. /**
  70196. * The strenth of the vortex.
  70197. */
  70198. strength: number;
  70199. /**
  70200. * The height of the cylinder for the vortex.
  70201. */
  70202. height: number;
  70203. /**
  70204. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  70205. */
  70206. centripetalForceThreshold: number;
  70207. /**
  70208. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  70209. */
  70210. centripetalForceMultiplier: number;
  70211. /**
  70212. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  70213. */
  70214. centrifugalForceMultiplier: number;
  70215. /**
  70216. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  70217. */
  70218. updraftForceMultiplier: number;
  70219. }
  70220. /**
  70221. * The strenght of the force in correspondence to the distance of the affected object
  70222. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  70223. */
  70224. export enum PhysicsRadialImpulseFalloff {
  70225. /** Defines that impulse is constant in strength across it's whole radius */
  70226. Constant = 0,
  70227. /** Defines that impulse gets weaker if it's further from the origin */
  70228. Linear = 1
  70229. }
  70230. /**
  70231. * The strength of the force in correspondence to the distance of the affected object
  70232. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  70233. */
  70234. export enum PhysicsUpdraftMode {
  70235. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  70236. Center = 0,
  70237. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  70238. Perpendicular = 1
  70239. }
  70240. /**
  70241. * Interface for a physics hit data
  70242. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  70243. */
  70244. export interface PhysicsHitData {
  70245. /**
  70246. * The force applied at the contact point
  70247. */
  70248. force: Vector3;
  70249. /**
  70250. * The contact point
  70251. */
  70252. contactPoint: Vector3;
  70253. /**
  70254. * The distance from the origin to the contact point
  70255. */
  70256. distanceFromOrigin: number;
  70257. }
  70258. /**
  70259. * Interface for radial explosion event data
  70260. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  70261. */
  70262. export interface PhysicsRadialExplosionEventData {
  70263. /**
  70264. * A sphere used for the radial explosion event
  70265. */
  70266. sphere: Mesh;
  70267. }
  70268. /**
  70269. * Interface for gravitational field event data
  70270. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  70271. */
  70272. export interface PhysicsGravitationalFieldEventData {
  70273. /**
  70274. * A sphere mesh used for the gravitational field event
  70275. */
  70276. sphere: Mesh;
  70277. }
  70278. /**
  70279. * Interface for updraft event data
  70280. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  70281. */
  70282. export interface PhysicsUpdraftEventData {
  70283. /**
  70284. * A cylinder used for the updraft event
  70285. */
  70286. cylinder: Mesh;
  70287. }
  70288. /**
  70289. * Interface for vortex event data
  70290. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  70291. */
  70292. export interface PhysicsVortexEventData {
  70293. /**
  70294. * A cylinder used for the vortex event
  70295. */
  70296. cylinder: Mesh;
  70297. }
  70298. /**
  70299. * Interface for an affected physics impostor
  70300. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  70301. */
  70302. export interface PhysicsAffectedImpostorWithData {
  70303. /**
  70304. * The impostor affected by the effect
  70305. */
  70306. impostor: PhysicsImpostor;
  70307. /**
  70308. * The data about the hit/horce from the explosion
  70309. */
  70310. hitData: PhysicsHitData;
  70311. }
  70312. }
  70313. declare module BABYLON {
  70314. /** @hidden */
  70315. export var blackAndWhitePixelShader: {
  70316. name: string;
  70317. shader: string;
  70318. };
  70319. }
  70320. declare module BABYLON {
  70321. /**
  70322. * Post process used to render in black and white
  70323. */
  70324. export class BlackAndWhitePostProcess extends PostProcess {
  70325. /**
  70326. * Linear about to convert he result to black and white (default: 1)
  70327. */
  70328. degree: number;
  70329. /**
  70330. * Gets a string identifying the name of the class
  70331. * @returns "BlackAndWhitePostProcess" string
  70332. */
  70333. getClassName(): string;
  70334. /**
  70335. * Creates a black and white post process
  70336. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  70337. * @param name The name of the effect.
  70338. * @param options The required width/height ratio to downsize to before computing the render pass.
  70339. * @param camera The camera to apply the render pass to.
  70340. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  70341. * @param engine The engine which the post process will be applied. (default: current engine)
  70342. * @param reusable If the post process can be reused on the same frame. (default: false)
  70343. */
  70344. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  70345. /** @hidden */
  70346. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  70347. }
  70348. }
  70349. declare module BABYLON {
  70350. /**
  70351. * This represents a set of one or more post processes in Babylon.
  70352. * A post process can be used to apply a shader to a texture after it is rendered.
  70353. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  70354. */
  70355. export class PostProcessRenderEffect {
  70356. private _postProcesses;
  70357. private _getPostProcesses;
  70358. private _singleInstance;
  70359. private _cameras;
  70360. private _indicesForCamera;
  70361. /**
  70362. * Name of the effect
  70363. * @hidden
  70364. */
  70365. _name: string;
  70366. /**
  70367. * Instantiates a post process render effect.
  70368. * A post process can be used to apply a shader to a texture after it is rendered.
  70369. * @param engine The engine the effect is tied to
  70370. * @param name The name of the effect
  70371. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  70372. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  70373. */
  70374. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  70375. /**
  70376. * Checks if all the post processes in the effect are supported.
  70377. */
  70378. get isSupported(): boolean;
  70379. /**
  70380. * Updates the current state of the effect
  70381. * @hidden
  70382. */
  70383. _update(): void;
  70384. /**
  70385. * Attaches the effect on cameras
  70386. * @param cameras The camera to attach to.
  70387. * @hidden
  70388. */
  70389. _attachCameras(cameras: Camera): void;
  70390. /**
  70391. * Attaches the effect on cameras
  70392. * @param cameras The camera to attach to.
  70393. * @hidden
  70394. */
  70395. _attachCameras(cameras: Camera[]): void;
  70396. /**
  70397. * Detaches the effect on cameras
  70398. * @param cameras The camera to detatch from.
  70399. * @hidden
  70400. */
  70401. _detachCameras(cameras: Camera): void;
  70402. /**
  70403. * Detatches the effect on cameras
  70404. * @param cameras The camera to detatch from.
  70405. * @hidden
  70406. */
  70407. _detachCameras(cameras: Camera[]): void;
  70408. /**
  70409. * Enables the effect on given cameras
  70410. * @param cameras The camera to enable.
  70411. * @hidden
  70412. */
  70413. _enable(cameras: Camera): void;
  70414. /**
  70415. * Enables the effect on given cameras
  70416. * @param cameras The camera to enable.
  70417. * @hidden
  70418. */
  70419. _enable(cameras: Nullable<Camera[]>): void;
  70420. /**
  70421. * Disables the effect on the given cameras
  70422. * @param cameras The camera to disable.
  70423. * @hidden
  70424. */
  70425. _disable(cameras: Camera): void;
  70426. /**
  70427. * Disables the effect on the given cameras
  70428. * @param cameras The camera to disable.
  70429. * @hidden
  70430. */
  70431. _disable(cameras: Nullable<Camera[]>): void;
  70432. /**
  70433. * Gets a list of the post processes contained in the effect.
  70434. * @param camera The camera to get the post processes on.
  70435. * @returns The list of the post processes in the effect.
  70436. */
  70437. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  70438. }
  70439. }
  70440. declare module BABYLON {
  70441. /** @hidden */
  70442. export var extractHighlightsPixelShader: {
  70443. name: string;
  70444. shader: string;
  70445. };
  70446. }
  70447. declare module BABYLON {
  70448. /**
  70449. * 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.
  70450. */
  70451. export class ExtractHighlightsPostProcess extends PostProcess {
  70452. /**
  70453. * The luminance threshold, pixels below this value will be set to black.
  70454. */
  70455. threshold: number;
  70456. /** @hidden */
  70457. _exposure: number;
  70458. /**
  70459. * Post process which has the input texture to be used when performing highlight extraction
  70460. * @hidden
  70461. */
  70462. _inputPostProcess: Nullable<PostProcess>;
  70463. /**
  70464. * Gets a string identifying the name of the class
  70465. * @returns "ExtractHighlightsPostProcess" string
  70466. */
  70467. getClassName(): string;
  70468. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  70469. }
  70470. }
  70471. declare module BABYLON {
  70472. /** @hidden */
  70473. export var bloomMergePixelShader: {
  70474. name: string;
  70475. shader: string;
  70476. };
  70477. }
  70478. declare module BABYLON {
  70479. /**
  70480. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  70481. */
  70482. export class BloomMergePostProcess extends PostProcess {
  70483. /** Weight of the bloom to be added to the original input. */
  70484. weight: number;
  70485. /**
  70486. * Gets a string identifying the name of the class
  70487. * @returns "BloomMergePostProcess" string
  70488. */
  70489. getClassName(): string;
  70490. /**
  70491. * Creates a new instance of @see BloomMergePostProcess
  70492. * @param name The name of the effect.
  70493. * @param originalFromInput Post process which's input will be used for the merge.
  70494. * @param blurred Blurred highlights post process which's output will be used.
  70495. * @param weight Weight of the bloom to be added to the original input.
  70496. * @param options The required width/height ratio to downsize to before computing the render pass.
  70497. * @param camera The camera to apply the render pass to.
  70498. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  70499. * @param engine The engine which the post process will be applied. (default: current engine)
  70500. * @param reusable If the post process can be reused on the same frame. (default: false)
  70501. * @param textureType Type of textures used when performing the post process. (default: 0)
  70502. * @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)
  70503. */
  70504. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  70505. /** Weight of the bloom to be added to the original input. */
  70506. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  70507. }
  70508. }
  70509. declare module BABYLON {
  70510. /**
  70511. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  70512. */
  70513. export class BloomEffect extends PostProcessRenderEffect {
  70514. private bloomScale;
  70515. /**
  70516. * @hidden Internal
  70517. */
  70518. _effects: Array<PostProcess>;
  70519. /**
  70520. * @hidden Internal
  70521. */
  70522. _downscale: ExtractHighlightsPostProcess;
  70523. private _blurX;
  70524. private _blurY;
  70525. private _merge;
  70526. /**
  70527. * The luminance threshold to find bright areas of the image to bloom.
  70528. */
  70529. get threshold(): number;
  70530. set threshold(value: number);
  70531. /**
  70532. * The strength of the bloom.
  70533. */
  70534. get weight(): number;
  70535. set weight(value: number);
  70536. /**
  70537. * Specifies the size of the bloom blur kernel, relative to the final output size
  70538. */
  70539. get kernel(): number;
  70540. set kernel(value: number);
  70541. /**
  70542. * Creates a new instance of @see BloomEffect
  70543. * @param scene The scene the effect belongs to.
  70544. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  70545. * @param bloomKernel The size of the kernel to be used when applying the blur.
  70546. * @param bloomWeight The the strength of bloom.
  70547. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  70548. * @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)
  70549. */
  70550. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  70551. /**
  70552. * Disposes each of the internal effects for a given camera.
  70553. * @param camera The camera to dispose the effect on.
  70554. */
  70555. disposeEffects(camera: Camera): void;
  70556. /**
  70557. * @hidden Internal
  70558. */
  70559. _updateEffects(): void;
  70560. /**
  70561. * Internal
  70562. * @returns if all the contained post processes are ready.
  70563. * @hidden
  70564. */
  70565. _isReady(): boolean;
  70566. }
  70567. }
  70568. declare module BABYLON {
  70569. /** @hidden */
  70570. export var chromaticAberrationPixelShader: {
  70571. name: string;
  70572. shader: string;
  70573. };
  70574. }
  70575. declare module BABYLON {
  70576. /**
  70577. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  70578. */
  70579. export class ChromaticAberrationPostProcess extends PostProcess {
  70580. /**
  70581. * The amount of seperation of rgb channels (default: 30)
  70582. */
  70583. aberrationAmount: number;
  70584. /**
  70585. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  70586. */
  70587. radialIntensity: number;
  70588. /**
  70589. * 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))
  70590. */
  70591. direction: Vector2;
  70592. /**
  70593. * 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))
  70594. */
  70595. centerPosition: Vector2;
  70596. /** The width of the screen to apply the effect on */
  70597. screenWidth: number;
  70598. /** The height of the screen to apply the effect on */
  70599. screenHeight: number;
  70600. /**
  70601. * Gets a string identifying the name of the class
  70602. * @returns "ChromaticAberrationPostProcess" string
  70603. */
  70604. getClassName(): string;
  70605. /**
  70606. * Creates a new instance ChromaticAberrationPostProcess
  70607. * @param name The name of the effect.
  70608. * @param screenWidth The width of the screen to apply the effect on.
  70609. * @param screenHeight The height of the screen to apply the effect on.
  70610. * @param options The required width/height ratio to downsize to before computing the render pass.
  70611. * @param camera The camera to apply the render pass to.
  70612. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  70613. * @param engine The engine which the post process will be applied. (default: current engine)
  70614. * @param reusable If the post process can be reused on the same frame. (default: false)
  70615. * @param textureType Type of textures used when performing the post process. (default: 0)
  70616. * @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)
  70617. */
  70618. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  70619. /** @hidden */
  70620. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  70621. }
  70622. }
  70623. declare module BABYLON {
  70624. /** @hidden */
  70625. export var circleOfConfusionPixelShader: {
  70626. name: string;
  70627. shader: string;
  70628. };
  70629. }
  70630. declare module BABYLON {
  70631. /**
  70632. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  70633. */
  70634. export class CircleOfConfusionPostProcess extends PostProcess {
  70635. /**
  70636. * 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.
  70637. */
  70638. lensSize: number;
  70639. /**
  70640. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  70641. */
  70642. fStop: number;
  70643. /**
  70644. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  70645. */
  70646. focusDistance: number;
  70647. /**
  70648. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  70649. */
  70650. focalLength: number;
  70651. /**
  70652. * Gets a string identifying the name of the class
  70653. * @returns "CircleOfConfusionPostProcess" string
  70654. */
  70655. getClassName(): string;
  70656. private _depthTexture;
  70657. /**
  70658. * Creates a new instance CircleOfConfusionPostProcess
  70659. * @param name The name of the effect.
  70660. * @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.
  70661. * @param options The required width/height ratio to downsize to before computing the render pass.
  70662. * @param camera The camera to apply the render pass to.
  70663. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  70664. * @param engine The engine which the post process will be applied. (default: current engine)
  70665. * @param reusable If the post process can be reused on the same frame. (default: false)
  70666. * @param textureType Type of textures used when performing the post process. (default: 0)
  70667. * @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)
  70668. */
  70669. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  70670. /**
  70671. * 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.
  70672. */
  70673. set depthTexture(value: RenderTargetTexture);
  70674. }
  70675. }
  70676. declare module BABYLON {
  70677. /** @hidden */
  70678. export var colorCorrectionPixelShader: {
  70679. name: string;
  70680. shader: string;
  70681. };
  70682. }
  70683. declare module BABYLON {
  70684. /**
  70685. *
  70686. * This post-process allows the modification of rendered colors by using
  70687. * a 'look-up table' (LUT). This effect is also called Color Grading.
  70688. *
  70689. * The object needs to be provided an url to a texture containing the color
  70690. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  70691. * Use an image editing software to tweak the LUT to match your needs.
  70692. *
  70693. * For an example of a color LUT, see here:
  70694. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  70695. * For explanations on color grading, see here:
  70696. * @see http://udn.epicgames.com/Three/ColorGrading.html
  70697. *
  70698. */
  70699. export class ColorCorrectionPostProcess extends PostProcess {
  70700. private _colorTableTexture;
  70701. /**
  70702. * Gets the color table url used to create the LUT texture
  70703. */
  70704. colorTableUrl: string;
  70705. /**
  70706. * Gets a string identifying the name of the class
  70707. * @returns "ColorCorrectionPostProcess" string
  70708. */
  70709. getClassName(): string;
  70710. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  70711. /** @hidden */
  70712. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  70713. }
  70714. }
  70715. declare module BABYLON {
  70716. /** @hidden */
  70717. export var convolutionPixelShader: {
  70718. name: string;
  70719. shader: string;
  70720. };
  70721. }
  70722. declare module BABYLON {
  70723. /**
  70724. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  70725. * input texture to perform effects such as edge detection or sharpening
  70726. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  70727. */
  70728. export class ConvolutionPostProcess extends PostProcess {
  70729. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  70730. kernel: number[];
  70731. /**
  70732. * Gets a string identifying the name of the class
  70733. * @returns "ConvolutionPostProcess" string
  70734. */
  70735. getClassName(): string;
  70736. /**
  70737. * Creates a new instance ConvolutionPostProcess
  70738. * @param name The name of the effect.
  70739. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  70740. * @param options The required width/height ratio to downsize to before computing the render pass.
  70741. * @param camera The camera to apply the render pass to.
  70742. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  70743. * @param engine The engine which the post process will be applied. (default: current engine)
  70744. * @param reusable If the post process can be reused on the same frame. (default: false)
  70745. * @param textureType Type of textures used when performing the post process. (default: 0)
  70746. */
  70747. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  70748. /** @hidden */
  70749. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  70750. /**
  70751. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  70752. */
  70753. static EdgeDetect0Kernel: number[];
  70754. /**
  70755. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  70756. */
  70757. static EdgeDetect1Kernel: number[];
  70758. /**
  70759. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  70760. */
  70761. static EdgeDetect2Kernel: number[];
  70762. /**
  70763. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  70764. */
  70765. static SharpenKernel: number[];
  70766. /**
  70767. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  70768. */
  70769. static EmbossKernel: number[];
  70770. /**
  70771. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  70772. */
  70773. static GaussianKernel: number[];
  70774. }
  70775. }
  70776. declare module BABYLON {
  70777. /**
  70778. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  70779. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  70780. * based on samples that have a large difference in distance than the center pixel.
  70781. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  70782. */
  70783. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  70784. /**
  70785. * The direction the blur should be applied
  70786. */
  70787. direction: Vector2;
  70788. /**
  70789. * Gets a string identifying the name of the class
  70790. * @returns "DepthOfFieldBlurPostProcess" string
  70791. */
  70792. getClassName(): string;
  70793. /**
  70794. * Creates a new instance CircleOfConfusionPostProcess
  70795. * @param name The name of the effect.
  70796. * @param scene The scene the effect belongs to.
  70797. * @param direction The direction the blur should be applied.
  70798. * @param kernel The size of the kernel used to blur.
  70799. * @param options The required width/height ratio to downsize to before computing the render pass.
  70800. * @param camera The camera to apply the render pass to.
  70801. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  70802. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  70803. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  70804. * @param engine The engine which the post process will be applied. (default: current engine)
  70805. * @param reusable If the post process can be reused on the same frame. (default: false)
  70806. * @param textureType Type of textures used when performing the post process. (default: 0)
  70807. * @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)
  70808. */
  70809. 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);
  70810. }
  70811. }
  70812. declare module BABYLON {
  70813. /** @hidden */
  70814. export var depthOfFieldMergePixelShader: {
  70815. name: string;
  70816. shader: string;
  70817. };
  70818. }
  70819. declare module BABYLON {
  70820. /**
  70821. * Options to be set when merging outputs from the default pipeline.
  70822. */
  70823. export class DepthOfFieldMergePostProcessOptions {
  70824. /**
  70825. * The original image to merge on top of
  70826. */
  70827. originalFromInput: PostProcess;
  70828. /**
  70829. * Parameters to perform the merge of the depth of field effect
  70830. */
  70831. depthOfField?: {
  70832. circleOfConfusion: PostProcess;
  70833. blurSteps: Array<PostProcess>;
  70834. };
  70835. /**
  70836. * Parameters to perform the merge of bloom effect
  70837. */
  70838. bloom?: {
  70839. blurred: PostProcess;
  70840. weight: number;
  70841. };
  70842. }
  70843. /**
  70844. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  70845. */
  70846. export class DepthOfFieldMergePostProcess extends PostProcess {
  70847. private blurSteps;
  70848. /**
  70849. * Gets a string identifying the name of the class
  70850. * @returns "DepthOfFieldMergePostProcess" string
  70851. */
  70852. getClassName(): string;
  70853. /**
  70854. * Creates a new instance of DepthOfFieldMergePostProcess
  70855. * @param name The name of the effect.
  70856. * @param originalFromInput Post process which's input will be used for the merge.
  70857. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  70858. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  70859. * @param options The required width/height ratio to downsize to before computing the render pass.
  70860. * @param camera The camera to apply the render pass to.
  70861. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  70862. * @param engine The engine which the post process will be applied. (default: current engine)
  70863. * @param reusable If the post process can be reused on the same frame. (default: false)
  70864. * @param textureType Type of textures used when performing the post process. (default: 0)
  70865. * @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)
  70866. */
  70867. 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);
  70868. /**
  70869. * Updates the effect with the current post process compile time values and recompiles the shader.
  70870. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  70871. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  70872. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  70873. * @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
  70874. * @param onCompiled Called when the shader has been compiled.
  70875. * @param onError Called if there is an error when compiling a shader.
  70876. */
  70877. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  70878. }
  70879. }
  70880. declare module BABYLON {
  70881. /**
  70882. * Specifies the level of max blur that should be applied when using the depth of field effect
  70883. */
  70884. export enum DepthOfFieldEffectBlurLevel {
  70885. /**
  70886. * Subtle blur
  70887. */
  70888. Low = 0,
  70889. /**
  70890. * Medium blur
  70891. */
  70892. Medium = 1,
  70893. /**
  70894. * Large blur
  70895. */
  70896. High = 2
  70897. }
  70898. /**
  70899. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  70900. */
  70901. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  70902. private _circleOfConfusion;
  70903. /**
  70904. * @hidden Internal, blurs from high to low
  70905. */
  70906. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  70907. private _depthOfFieldBlurY;
  70908. private _dofMerge;
  70909. /**
  70910. * @hidden Internal post processes in depth of field effect
  70911. */
  70912. _effects: Array<PostProcess>;
  70913. /**
  70914. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  70915. */
  70916. set focalLength(value: number);
  70917. get focalLength(): number;
  70918. /**
  70919. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  70920. */
  70921. set fStop(value: number);
  70922. get fStop(): number;
  70923. /**
  70924. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  70925. */
  70926. set focusDistance(value: number);
  70927. get focusDistance(): number;
  70928. /**
  70929. * 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.
  70930. */
  70931. set lensSize(value: number);
  70932. get lensSize(): number;
  70933. /**
  70934. * Creates a new instance DepthOfFieldEffect
  70935. * @param scene The scene the effect belongs to.
  70936. * @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.
  70937. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  70938. * @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)
  70939. */
  70940. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  70941. /**
  70942. * Get the current class name of the current effet
  70943. * @returns "DepthOfFieldEffect"
  70944. */
  70945. getClassName(): string;
  70946. /**
  70947. * 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.
  70948. */
  70949. set depthTexture(value: RenderTargetTexture);
  70950. /**
  70951. * Disposes each of the internal effects for a given camera.
  70952. * @param camera The camera to dispose the effect on.
  70953. */
  70954. disposeEffects(camera: Camera): void;
  70955. /**
  70956. * @hidden Internal
  70957. */
  70958. _updateEffects(): void;
  70959. /**
  70960. * Internal
  70961. * @returns if all the contained post processes are ready.
  70962. * @hidden
  70963. */
  70964. _isReady(): boolean;
  70965. }
  70966. }
  70967. declare module BABYLON {
  70968. /** @hidden */
  70969. export var displayPassPixelShader: {
  70970. name: string;
  70971. shader: string;
  70972. };
  70973. }
  70974. declare module BABYLON {
  70975. /**
  70976. * DisplayPassPostProcess which produces an output the same as it's input
  70977. */
  70978. export class DisplayPassPostProcess extends PostProcess {
  70979. /**
  70980. * Gets a string identifying the name of the class
  70981. * @returns "DisplayPassPostProcess" string
  70982. */
  70983. getClassName(): string;
  70984. /**
  70985. * Creates the DisplayPassPostProcess
  70986. * @param name The name of the effect.
  70987. * @param options The required width/height ratio to downsize to before computing the render pass.
  70988. * @param camera The camera to apply the render pass to.
  70989. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  70990. * @param engine The engine which the post process will be applied. (default: current engine)
  70991. * @param reusable If the post process can be reused on the same frame. (default: false)
  70992. */
  70993. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  70994. /** @hidden */
  70995. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  70996. }
  70997. }
  70998. declare module BABYLON {
  70999. /** @hidden */
  71000. export var filterPixelShader: {
  71001. name: string;
  71002. shader: string;
  71003. };
  71004. }
  71005. declare module BABYLON {
  71006. /**
  71007. * Applies a kernel filter to the image
  71008. */
  71009. export class FilterPostProcess extends PostProcess {
  71010. /** The matrix to be applied to the image */
  71011. kernelMatrix: Matrix;
  71012. /**
  71013. * Gets a string identifying the name of the class
  71014. * @returns "FilterPostProcess" string
  71015. */
  71016. getClassName(): string;
  71017. /**
  71018. *
  71019. * @param name The name of the effect.
  71020. * @param kernelMatrix The matrix to be applied to the image
  71021. * @param options The required width/height ratio to downsize to before computing the render pass.
  71022. * @param camera The camera to apply the render pass to.
  71023. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  71024. * @param engine The engine which the post process will be applied. (default: current engine)
  71025. * @param reusable If the post process can be reused on the same frame. (default: false)
  71026. */
  71027. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  71028. /** @hidden */
  71029. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  71030. }
  71031. }
  71032. declare module BABYLON {
  71033. /** @hidden */
  71034. export var fxaaPixelShader: {
  71035. name: string;
  71036. shader: string;
  71037. };
  71038. }
  71039. declare module BABYLON {
  71040. /** @hidden */
  71041. export var fxaaVertexShader: {
  71042. name: string;
  71043. shader: string;
  71044. };
  71045. }
  71046. declare module BABYLON {
  71047. /**
  71048. * Fxaa post process
  71049. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  71050. */
  71051. export class FxaaPostProcess extends PostProcess {
  71052. /**
  71053. * Gets a string identifying the name of the class
  71054. * @returns "FxaaPostProcess" string
  71055. */
  71056. getClassName(): string;
  71057. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  71058. private _getDefines;
  71059. /** @hidden */
  71060. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  71061. }
  71062. }
  71063. declare module BABYLON {
  71064. /** @hidden */
  71065. export var grainPixelShader: {
  71066. name: string;
  71067. shader: string;
  71068. };
  71069. }
  71070. declare module BABYLON {
  71071. /**
  71072. * The GrainPostProcess adds noise to the image at mid luminance levels
  71073. */
  71074. export class GrainPostProcess extends PostProcess {
  71075. /**
  71076. * The intensity of the grain added (default: 30)
  71077. */
  71078. intensity: number;
  71079. /**
  71080. * If the grain should be randomized on every frame
  71081. */
  71082. animated: boolean;
  71083. /**
  71084. * Gets a string identifying the name of the class
  71085. * @returns "GrainPostProcess" string
  71086. */
  71087. getClassName(): string;
  71088. /**
  71089. * Creates a new instance of @see GrainPostProcess
  71090. * @param name The name of the effect.
  71091. * @param options The required width/height ratio to downsize to before computing the render pass.
  71092. * @param camera The camera to apply the render pass to.
  71093. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  71094. * @param engine The engine which the post process will be applied. (default: current engine)
  71095. * @param reusable If the post process can be reused on the same frame. (default: false)
  71096. * @param textureType Type of textures used when performing the post process. (default: 0)
  71097. * @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)
  71098. */
  71099. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  71100. /** @hidden */
  71101. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  71102. }
  71103. }
  71104. declare module BABYLON {
  71105. /** @hidden */
  71106. export var highlightsPixelShader: {
  71107. name: string;
  71108. shader: string;
  71109. };
  71110. }
  71111. declare module BABYLON {
  71112. /**
  71113. * Extracts highlights from the image
  71114. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  71115. */
  71116. export class HighlightsPostProcess extends PostProcess {
  71117. /**
  71118. * Gets a string identifying the name of the class
  71119. * @returns "HighlightsPostProcess" string
  71120. */
  71121. getClassName(): string;
  71122. /**
  71123. * Extracts highlights from the image
  71124. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  71125. * @param name The name of the effect.
  71126. * @param options The required width/height ratio to downsize to before computing the render pass.
  71127. * @param camera The camera to apply the render pass to.
  71128. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  71129. * @param engine The engine which the post process will be applied. (default: current engine)
  71130. * @param reusable If the post process can be reused on the same frame. (default: false)
  71131. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  71132. */
  71133. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  71134. }
  71135. }
  71136. declare module BABYLON {
  71137. /**
  71138. * Contains all parameters needed for the prepass to perform
  71139. * motion blur
  71140. */
  71141. export class MotionBlurConfiguration implements PrePassEffectConfiguration {
  71142. /**
  71143. * Is motion blur enabled
  71144. */
  71145. enabled: boolean;
  71146. /**
  71147. * Name of the configuration
  71148. */
  71149. name: string;
  71150. /**
  71151. * Textures that should be present in the MRT for this effect to work
  71152. */
  71153. readonly texturesRequired: number[];
  71154. }
  71155. }
  71156. declare module BABYLON {
  71157. interface Scene {
  71158. /** @hidden (Backing field) */
  71159. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  71160. /**
  71161. * Gets or Sets the current geometry buffer associated to the scene.
  71162. */
  71163. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  71164. /**
  71165. * Enables a GeometryBufferRender and associates it with the scene
  71166. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  71167. * @returns the GeometryBufferRenderer
  71168. */
  71169. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  71170. /**
  71171. * Disables the GeometryBufferRender associated with the scene
  71172. */
  71173. disableGeometryBufferRenderer(): void;
  71174. }
  71175. /**
  71176. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  71177. * in several rendering techniques.
  71178. */
  71179. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  71180. /**
  71181. * The component name helpful to identify the component in the list of scene components.
  71182. */
  71183. readonly name: string;
  71184. /**
  71185. * The scene the component belongs to.
  71186. */
  71187. scene: Scene;
  71188. /**
  71189. * Creates a new instance of the component for the given scene
  71190. * @param scene Defines the scene to register the component in
  71191. */
  71192. constructor(scene: Scene);
  71193. /**
  71194. * Registers the component in a given scene
  71195. */
  71196. register(): void;
  71197. /**
  71198. * Rebuilds the elements related to this component in case of
  71199. * context lost for instance.
  71200. */
  71201. rebuild(): void;
  71202. /**
  71203. * Disposes the component and the associated ressources
  71204. */
  71205. dispose(): void;
  71206. private _gatherRenderTargets;
  71207. }
  71208. }
  71209. declare module BABYLON {
  71210. /** @hidden */
  71211. export var motionBlurPixelShader: {
  71212. name: string;
  71213. shader: string;
  71214. };
  71215. }
  71216. declare module BABYLON {
  71217. /**
  71218. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  71219. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  71220. * As an example, all you have to do is to create the post-process:
  71221. * var mb = new BABYLON.MotionBlurPostProcess(
  71222. * 'mb', // The name of the effect.
  71223. * scene, // The scene containing the objects to blur according to their velocity.
  71224. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  71225. * camera // The camera to apply the render pass to.
  71226. * );
  71227. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  71228. */
  71229. export class MotionBlurPostProcess extends PostProcess {
  71230. /**
  71231. * Defines how much the image is blurred by the movement. Default value is equal to 1
  71232. */
  71233. motionStrength: number;
  71234. /**
  71235. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  71236. */
  71237. get motionBlurSamples(): number;
  71238. /**
  71239. * Sets the number of iterations to be used for motion blur quality
  71240. */
  71241. set motionBlurSamples(samples: number);
  71242. private _motionBlurSamples;
  71243. private _forceGeometryBuffer;
  71244. private _geometryBufferRenderer;
  71245. private _prePassRenderer;
  71246. /**
  71247. * Gets a string identifying the name of the class
  71248. * @returns "MotionBlurPostProcess" string
  71249. */
  71250. getClassName(): string;
  71251. /**
  71252. * Creates a new instance MotionBlurPostProcess
  71253. * @param name The name of the effect.
  71254. * @param scene The scene containing the objects to blur according to their velocity.
  71255. * @param options The required width/height ratio to downsize to before computing the render pass.
  71256. * @param camera The camera to apply the render pass to.
  71257. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  71258. * @param engine The engine which the post process will be applied. (default: current engine)
  71259. * @param reusable If the post process can be reused on the same frame. (default: false)
  71260. * @param textureType Type of textures used when performing the post process. (default: 0)
  71261. * @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)
  71262. * @param forceGeometryBuffer If this post process should use geometry buffer instead of prepass (default: false)
  71263. */
  71264. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean, forceGeometryBuffer?: boolean);
  71265. /**
  71266. * Excludes the given skinned mesh from computing bones velocities.
  71267. * 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.
  71268. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  71269. */
  71270. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  71271. /**
  71272. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  71273. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  71274. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  71275. */
  71276. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  71277. /**
  71278. * Disposes the post process.
  71279. * @param camera The camera to dispose the post process on.
  71280. */
  71281. dispose(camera?: Camera): void;
  71282. /** @hidden */
  71283. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  71284. }
  71285. }
  71286. declare module BABYLON {
  71287. /** @hidden */
  71288. export var refractionPixelShader: {
  71289. name: string;
  71290. shader: string;
  71291. };
  71292. }
  71293. declare module BABYLON {
  71294. /**
  71295. * Post process which applies a refractin texture
  71296. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  71297. */
  71298. export class RefractionPostProcess extends PostProcess {
  71299. private _refTexture;
  71300. private _ownRefractionTexture;
  71301. /** the base color of the refraction (used to taint the rendering) */
  71302. color: Color3;
  71303. /** simulated refraction depth */
  71304. depth: number;
  71305. /** the coefficient of the base color (0 to remove base color tainting) */
  71306. colorLevel: number;
  71307. /** Gets the url used to load the refraction texture */
  71308. refractionTextureUrl: string;
  71309. /**
  71310. * Gets or sets the refraction texture
  71311. * Please note that you are responsible for disposing the texture if you set it manually
  71312. */
  71313. get refractionTexture(): Texture;
  71314. set refractionTexture(value: Texture);
  71315. /**
  71316. * Gets a string identifying the name of the class
  71317. * @returns "RefractionPostProcess" string
  71318. */
  71319. getClassName(): string;
  71320. /**
  71321. * Initializes the RefractionPostProcess
  71322. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  71323. * @param name The name of the effect.
  71324. * @param refractionTextureUrl Url of the refraction texture to use
  71325. * @param color the base color of the refraction (used to taint the rendering)
  71326. * @param depth simulated refraction depth
  71327. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  71328. * @param camera The camera to apply the render pass to.
  71329. * @param options The required width/height ratio to downsize to before computing the render pass.
  71330. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  71331. * @param engine The engine which the post process will be applied. (default: current engine)
  71332. * @param reusable If the post process can be reused on the same frame. (default: false)
  71333. */
  71334. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  71335. /**
  71336. * Disposes of the post process
  71337. * @param camera Camera to dispose post process on
  71338. */
  71339. dispose(camera: Camera): void;
  71340. /** @hidden */
  71341. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  71342. }
  71343. }
  71344. declare module BABYLON {
  71345. /** @hidden */
  71346. export var sharpenPixelShader: {
  71347. name: string;
  71348. shader: string;
  71349. };
  71350. }
  71351. declare module BABYLON {
  71352. /**
  71353. * The SharpenPostProcess applies a sharpen kernel to every pixel
  71354. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  71355. */
  71356. export class SharpenPostProcess extends PostProcess {
  71357. /**
  71358. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  71359. */
  71360. colorAmount: number;
  71361. /**
  71362. * How much sharpness should be applied (default: 0.3)
  71363. */
  71364. edgeAmount: number;
  71365. /**
  71366. * Gets a string identifying the name of the class
  71367. * @returns "SharpenPostProcess" string
  71368. */
  71369. getClassName(): string;
  71370. /**
  71371. * Creates a new instance ConvolutionPostProcess
  71372. * @param name The name of the effect.
  71373. * @param options The required width/height ratio to downsize to before computing the render pass.
  71374. * @param camera The camera to apply the render pass to.
  71375. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  71376. * @param engine The engine which the post process will be applied. (default: current engine)
  71377. * @param reusable If the post process can be reused on the same frame. (default: false)
  71378. * @param textureType Type of textures used when performing the post process. (default: 0)
  71379. * @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)
  71380. */
  71381. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  71382. /** @hidden */
  71383. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  71384. }
  71385. }
  71386. declare module BABYLON {
  71387. /**
  71388. * PostProcessRenderPipeline
  71389. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  71390. */
  71391. export class PostProcessRenderPipeline {
  71392. private engine;
  71393. private _renderEffects;
  71394. private _renderEffectsForIsolatedPass;
  71395. /**
  71396. * List of inspectable custom properties (used by the Inspector)
  71397. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  71398. */
  71399. inspectableCustomProperties: IInspectable[];
  71400. /**
  71401. * @hidden
  71402. */
  71403. protected _cameras: Camera[];
  71404. /** @hidden */
  71405. _name: string;
  71406. /**
  71407. * Gets pipeline name
  71408. */
  71409. get name(): string;
  71410. /** Gets the list of attached cameras */
  71411. get cameras(): Camera[];
  71412. /**
  71413. * Initializes a PostProcessRenderPipeline
  71414. * @param engine engine to add the pipeline to
  71415. * @param name name of the pipeline
  71416. */
  71417. constructor(engine: Engine, name: string);
  71418. /**
  71419. * Gets the class name
  71420. * @returns "PostProcessRenderPipeline"
  71421. */
  71422. getClassName(): string;
  71423. /**
  71424. * If all the render effects in the pipeline are supported
  71425. */
  71426. get isSupported(): boolean;
  71427. /**
  71428. * Adds an effect to the pipeline
  71429. * @param renderEffect the effect to add
  71430. */
  71431. addEffect(renderEffect: PostProcessRenderEffect): void;
  71432. /** @hidden */
  71433. _rebuild(): void;
  71434. /** @hidden */
  71435. _enableEffect(renderEffectName: string, cameras: Camera): void;
  71436. /** @hidden */
  71437. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  71438. /** @hidden */
  71439. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  71440. /** @hidden */
  71441. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  71442. /** @hidden */
  71443. _attachCameras(cameras: Camera, unique: boolean): void;
  71444. /** @hidden */
  71445. _attachCameras(cameras: Camera[], unique: boolean): void;
  71446. /** @hidden */
  71447. _detachCameras(cameras: Camera): void;
  71448. /** @hidden */
  71449. _detachCameras(cameras: Nullable<Camera[]>): void;
  71450. /** @hidden */
  71451. _update(): void;
  71452. /** @hidden */
  71453. _reset(): void;
  71454. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  71455. /**
  71456. * Sets the required values to the prepass renderer.
  71457. * @param prePassRenderer defines the prepass renderer to setup.
  71458. * @returns true if the pre pass is needed.
  71459. */
  71460. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  71461. /**
  71462. * Disposes of the pipeline
  71463. */
  71464. dispose(): void;
  71465. }
  71466. }
  71467. declare module BABYLON {
  71468. /**
  71469. * PostProcessRenderPipelineManager class
  71470. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  71471. */
  71472. export class PostProcessRenderPipelineManager {
  71473. private _renderPipelines;
  71474. /**
  71475. * Initializes a PostProcessRenderPipelineManager
  71476. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  71477. */
  71478. constructor();
  71479. /**
  71480. * Gets the list of supported render pipelines
  71481. */
  71482. get supportedPipelines(): PostProcessRenderPipeline[];
  71483. /**
  71484. * Adds a pipeline to the manager
  71485. * @param renderPipeline The pipeline to add
  71486. */
  71487. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  71488. /**
  71489. * Attaches a camera to the pipeline
  71490. * @param renderPipelineName The name of the pipeline to attach to
  71491. * @param cameras the camera to attach
  71492. * @param unique if the camera can be attached multiple times to the pipeline
  71493. */
  71494. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  71495. /**
  71496. * Detaches a camera from the pipeline
  71497. * @param renderPipelineName The name of the pipeline to detach from
  71498. * @param cameras the camera to detach
  71499. */
  71500. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  71501. /**
  71502. * Enables an effect by name on a pipeline
  71503. * @param renderPipelineName the name of the pipeline to enable the effect in
  71504. * @param renderEffectName the name of the effect to enable
  71505. * @param cameras the cameras that the effect should be enabled on
  71506. */
  71507. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  71508. /**
  71509. * Disables an effect by name on a pipeline
  71510. * @param renderPipelineName the name of the pipeline to disable the effect in
  71511. * @param renderEffectName the name of the effect to disable
  71512. * @param cameras the cameras that the effect should be disabled on
  71513. */
  71514. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  71515. /**
  71516. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  71517. */
  71518. update(): void;
  71519. /** @hidden */
  71520. _rebuild(): void;
  71521. /**
  71522. * Disposes of the manager and pipelines
  71523. */
  71524. dispose(): void;
  71525. }
  71526. }
  71527. declare module BABYLON {
  71528. interface Scene {
  71529. /** @hidden (Backing field) */
  71530. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  71531. /**
  71532. * Gets the postprocess render pipeline manager
  71533. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  71534. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  71535. */
  71536. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  71537. }
  71538. /**
  71539. * Defines the Render Pipeline scene component responsible to rendering pipelines
  71540. */
  71541. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  71542. /**
  71543. * The component name helpfull to identify the component in the list of scene components.
  71544. */
  71545. readonly name: string;
  71546. /**
  71547. * The scene the component belongs to.
  71548. */
  71549. scene: Scene;
  71550. /**
  71551. * Creates a new instance of the component for the given scene
  71552. * @param scene Defines the scene to register the component in
  71553. */
  71554. constructor(scene: Scene);
  71555. /**
  71556. * Registers the component in a given scene
  71557. */
  71558. register(): void;
  71559. /**
  71560. * Rebuilds the elements related to this component in case of
  71561. * context lost for instance.
  71562. */
  71563. rebuild(): void;
  71564. /**
  71565. * Disposes the component and the associated ressources
  71566. */
  71567. dispose(): void;
  71568. private _gatherRenderTargets;
  71569. }
  71570. }
  71571. declare module BABYLON {
  71572. /**
  71573. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  71574. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  71575. */
  71576. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  71577. private _scene;
  71578. private _camerasToBeAttached;
  71579. /**
  71580. * ID of the sharpen post process,
  71581. */
  71582. private readonly SharpenPostProcessId;
  71583. /**
  71584. * @ignore
  71585. * ID of the image processing post process;
  71586. */
  71587. readonly ImageProcessingPostProcessId: string;
  71588. /**
  71589. * @ignore
  71590. * ID of the Fast Approximate Anti-Aliasing post process;
  71591. */
  71592. readonly FxaaPostProcessId: string;
  71593. /**
  71594. * ID of the chromatic aberration post process,
  71595. */
  71596. private readonly ChromaticAberrationPostProcessId;
  71597. /**
  71598. * ID of the grain post process
  71599. */
  71600. private readonly GrainPostProcessId;
  71601. /**
  71602. * Sharpen post process which will apply a sharpen convolution to enhance edges
  71603. */
  71604. sharpen: SharpenPostProcess;
  71605. private _sharpenEffect;
  71606. private bloom;
  71607. /**
  71608. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  71609. */
  71610. depthOfField: DepthOfFieldEffect;
  71611. /**
  71612. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  71613. */
  71614. fxaa: FxaaPostProcess;
  71615. /**
  71616. * Image post processing pass used to perform operations such as tone mapping or color grading.
  71617. */
  71618. imageProcessing: ImageProcessingPostProcess;
  71619. /**
  71620. * Chromatic aberration post process which will shift rgb colors in the image
  71621. */
  71622. chromaticAberration: ChromaticAberrationPostProcess;
  71623. private _chromaticAberrationEffect;
  71624. /**
  71625. * Grain post process which add noise to the image
  71626. */
  71627. grain: GrainPostProcess;
  71628. private _grainEffect;
  71629. /**
  71630. * Glow post process which adds a glow to emissive areas of the image
  71631. */
  71632. private _glowLayer;
  71633. /**
  71634. * Animations which can be used to tweak settings over a period of time
  71635. */
  71636. animations: Animation[];
  71637. private _imageProcessingConfigurationObserver;
  71638. private _sharpenEnabled;
  71639. private _bloomEnabled;
  71640. private _depthOfFieldEnabled;
  71641. private _depthOfFieldBlurLevel;
  71642. private _fxaaEnabled;
  71643. private _imageProcessingEnabled;
  71644. private _defaultPipelineTextureType;
  71645. private _bloomScale;
  71646. private _chromaticAberrationEnabled;
  71647. private _grainEnabled;
  71648. private _buildAllowed;
  71649. /**
  71650. * This is triggered each time the pipeline has been built.
  71651. */
  71652. onBuildObservable: Observable<DefaultRenderingPipeline>;
  71653. /**
  71654. * Gets active scene
  71655. */
  71656. get scene(): Scene;
  71657. /**
  71658. * Enable or disable the sharpen process from the pipeline
  71659. */
  71660. set sharpenEnabled(enabled: boolean);
  71661. get sharpenEnabled(): boolean;
  71662. private _resizeObserver;
  71663. private _hardwareScaleLevel;
  71664. private _bloomKernel;
  71665. /**
  71666. * Specifies the size of the bloom blur kernel, relative to the final output size
  71667. */
  71668. get bloomKernel(): number;
  71669. set bloomKernel(value: number);
  71670. /**
  71671. * Specifies the weight of the bloom in the final rendering
  71672. */
  71673. private _bloomWeight;
  71674. /**
  71675. * Specifies the luma threshold for the area that will be blurred by the bloom
  71676. */
  71677. private _bloomThreshold;
  71678. private _hdr;
  71679. /**
  71680. * The strength of the bloom.
  71681. */
  71682. set bloomWeight(value: number);
  71683. get bloomWeight(): number;
  71684. /**
  71685. * The strength of the bloom.
  71686. */
  71687. set bloomThreshold(value: number);
  71688. get bloomThreshold(): number;
  71689. /**
  71690. * The scale of the bloom, lower value will provide better performance.
  71691. */
  71692. set bloomScale(value: number);
  71693. get bloomScale(): number;
  71694. /**
  71695. * Enable or disable the bloom from the pipeline
  71696. */
  71697. set bloomEnabled(enabled: boolean);
  71698. get bloomEnabled(): boolean;
  71699. private _rebuildBloom;
  71700. /**
  71701. * If the depth of field is enabled.
  71702. */
  71703. get depthOfFieldEnabled(): boolean;
  71704. set depthOfFieldEnabled(enabled: boolean);
  71705. /**
  71706. * Blur level of the depth of field effect. (Higher blur will effect performance)
  71707. */
  71708. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  71709. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  71710. /**
  71711. * If the anti aliasing is enabled.
  71712. */
  71713. set fxaaEnabled(enabled: boolean);
  71714. get fxaaEnabled(): boolean;
  71715. private _samples;
  71716. /**
  71717. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  71718. */
  71719. set samples(sampleCount: number);
  71720. get samples(): number;
  71721. /**
  71722. * If image processing is enabled.
  71723. */
  71724. set imageProcessingEnabled(enabled: boolean);
  71725. get imageProcessingEnabled(): boolean;
  71726. /**
  71727. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  71728. */
  71729. set glowLayerEnabled(enabled: boolean);
  71730. get glowLayerEnabled(): boolean;
  71731. /**
  71732. * Gets the glow layer (or null if not defined)
  71733. */
  71734. get glowLayer(): Nullable<GlowLayer>;
  71735. /**
  71736. * Enable or disable the chromaticAberration process from the pipeline
  71737. */
  71738. set chromaticAberrationEnabled(enabled: boolean);
  71739. get chromaticAberrationEnabled(): boolean;
  71740. /**
  71741. * Enable or disable the grain process from the pipeline
  71742. */
  71743. set grainEnabled(enabled: boolean);
  71744. get grainEnabled(): boolean;
  71745. /**
  71746. * @constructor
  71747. * @param name - The rendering pipeline name (default: "")
  71748. * @param hdr - If high dynamic range textures should be used (default: true)
  71749. * @param scene - The scene linked to this pipeline (default: the last created scene)
  71750. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  71751. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  71752. */
  71753. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  71754. /**
  71755. * Get the class name
  71756. * @returns "DefaultRenderingPipeline"
  71757. */
  71758. getClassName(): string;
  71759. /**
  71760. * Force the compilation of the entire pipeline.
  71761. */
  71762. prepare(): void;
  71763. private _hasCleared;
  71764. private _prevPostProcess;
  71765. private _prevPrevPostProcess;
  71766. private _setAutoClearAndTextureSharing;
  71767. private _depthOfFieldSceneObserver;
  71768. private _buildPipeline;
  71769. private _disposePostProcesses;
  71770. /**
  71771. * Adds a camera to the pipeline
  71772. * @param camera the camera to be added
  71773. */
  71774. addCamera(camera: Camera): void;
  71775. /**
  71776. * Removes a camera from the pipeline
  71777. * @param camera the camera to remove
  71778. */
  71779. removeCamera(camera: Camera): void;
  71780. /**
  71781. * Dispose of the pipeline and stop all post processes
  71782. */
  71783. dispose(): void;
  71784. /**
  71785. * Serialize the rendering pipeline (Used when exporting)
  71786. * @returns the serialized object
  71787. */
  71788. serialize(): any;
  71789. /**
  71790. * Parse the serialized pipeline
  71791. * @param source Source pipeline.
  71792. * @param scene The scene to load the pipeline to.
  71793. * @param rootUrl The URL of the serialized pipeline.
  71794. * @returns An instantiated pipeline from the serialized object.
  71795. */
  71796. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  71797. }
  71798. }
  71799. declare module BABYLON {
  71800. /** @hidden */
  71801. export var lensHighlightsPixelShader: {
  71802. name: string;
  71803. shader: string;
  71804. };
  71805. }
  71806. declare module BABYLON {
  71807. /** @hidden */
  71808. export var depthOfFieldPixelShader: {
  71809. name: string;
  71810. shader: string;
  71811. };
  71812. }
  71813. declare module BABYLON {
  71814. /**
  71815. * BABYLON.JS Chromatic Aberration GLSL Shader
  71816. * Author: Olivier Guyot
  71817. * Separates very slightly R, G and B colors on the edges of the screen
  71818. * Inspired by Francois Tarlier & Martins Upitis
  71819. */
  71820. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  71821. /**
  71822. * @ignore
  71823. * The chromatic aberration PostProcess id in the pipeline
  71824. */
  71825. LensChromaticAberrationEffect: string;
  71826. /**
  71827. * @ignore
  71828. * The highlights enhancing PostProcess id in the pipeline
  71829. */
  71830. HighlightsEnhancingEffect: string;
  71831. /**
  71832. * @ignore
  71833. * The depth-of-field PostProcess id in the pipeline
  71834. */
  71835. LensDepthOfFieldEffect: string;
  71836. private _scene;
  71837. private _depthTexture;
  71838. private _grainTexture;
  71839. private _chromaticAberrationPostProcess;
  71840. private _highlightsPostProcess;
  71841. private _depthOfFieldPostProcess;
  71842. private _edgeBlur;
  71843. private _grainAmount;
  71844. private _chromaticAberration;
  71845. private _distortion;
  71846. private _highlightsGain;
  71847. private _highlightsThreshold;
  71848. private _dofDistance;
  71849. private _dofAperture;
  71850. private _dofDarken;
  71851. private _dofPentagon;
  71852. private _blurNoise;
  71853. /**
  71854. * @constructor
  71855. *
  71856. * Effect parameters are as follow:
  71857. * {
  71858. * chromatic_aberration: number; // from 0 to x (1 for realism)
  71859. * edge_blur: number; // from 0 to x (1 for realism)
  71860. * distortion: number; // from 0 to x (1 for realism)
  71861. * grain_amount: number; // from 0 to 1
  71862. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  71863. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  71864. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  71865. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  71866. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  71867. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  71868. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  71869. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  71870. * }
  71871. * Note: if an effect parameter is unset, effect is disabled
  71872. *
  71873. * @param name The rendering pipeline name
  71874. * @param parameters - An object containing all parameters (see above)
  71875. * @param scene The scene linked to this pipeline
  71876. * @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)
  71877. * @param cameras The array of cameras that the rendering pipeline will be attached to
  71878. */
  71879. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  71880. /**
  71881. * Get the class name
  71882. * @returns "LensRenderingPipeline"
  71883. */
  71884. getClassName(): string;
  71885. /**
  71886. * Gets associated scene
  71887. */
  71888. get scene(): Scene;
  71889. /**
  71890. * Gets or sets the edge blur
  71891. */
  71892. get edgeBlur(): number;
  71893. set edgeBlur(value: number);
  71894. /**
  71895. * Gets or sets the grain amount
  71896. */
  71897. get grainAmount(): number;
  71898. set grainAmount(value: number);
  71899. /**
  71900. * Gets or sets the chromatic aberration amount
  71901. */
  71902. get chromaticAberration(): number;
  71903. set chromaticAberration(value: number);
  71904. /**
  71905. * Gets or sets the depth of field aperture
  71906. */
  71907. get dofAperture(): number;
  71908. set dofAperture(value: number);
  71909. /**
  71910. * Gets or sets the edge distortion
  71911. */
  71912. get edgeDistortion(): number;
  71913. set edgeDistortion(value: number);
  71914. /**
  71915. * Gets or sets the depth of field distortion
  71916. */
  71917. get dofDistortion(): number;
  71918. set dofDistortion(value: number);
  71919. /**
  71920. * Gets or sets the darken out of focus amount
  71921. */
  71922. get darkenOutOfFocus(): number;
  71923. set darkenOutOfFocus(value: number);
  71924. /**
  71925. * Gets or sets a boolean indicating if blur noise is enabled
  71926. */
  71927. get blurNoise(): boolean;
  71928. set blurNoise(value: boolean);
  71929. /**
  71930. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  71931. */
  71932. get pentagonBokeh(): boolean;
  71933. set pentagonBokeh(value: boolean);
  71934. /**
  71935. * Gets or sets the highlight grain amount
  71936. */
  71937. get highlightsGain(): number;
  71938. set highlightsGain(value: number);
  71939. /**
  71940. * Gets or sets the highlight threshold
  71941. */
  71942. get highlightsThreshold(): number;
  71943. set highlightsThreshold(value: number);
  71944. /**
  71945. * Sets the amount of blur at the edges
  71946. * @param amount blur amount
  71947. */
  71948. setEdgeBlur(amount: number): void;
  71949. /**
  71950. * Sets edge blur to 0
  71951. */
  71952. disableEdgeBlur(): void;
  71953. /**
  71954. * Sets the amout of grain
  71955. * @param amount Amount of grain
  71956. */
  71957. setGrainAmount(amount: number): void;
  71958. /**
  71959. * Set grain amount to 0
  71960. */
  71961. disableGrain(): void;
  71962. /**
  71963. * Sets the chromatic aberration amount
  71964. * @param amount amount of chromatic aberration
  71965. */
  71966. setChromaticAberration(amount: number): void;
  71967. /**
  71968. * Sets chromatic aberration amount to 0
  71969. */
  71970. disableChromaticAberration(): void;
  71971. /**
  71972. * Sets the EdgeDistortion amount
  71973. * @param amount amount of EdgeDistortion
  71974. */
  71975. setEdgeDistortion(amount: number): void;
  71976. /**
  71977. * Sets edge distortion to 0
  71978. */
  71979. disableEdgeDistortion(): void;
  71980. /**
  71981. * Sets the FocusDistance amount
  71982. * @param amount amount of FocusDistance
  71983. */
  71984. setFocusDistance(amount: number): void;
  71985. /**
  71986. * Disables depth of field
  71987. */
  71988. disableDepthOfField(): void;
  71989. /**
  71990. * Sets the Aperture amount
  71991. * @param amount amount of Aperture
  71992. */
  71993. setAperture(amount: number): void;
  71994. /**
  71995. * Sets the DarkenOutOfFocus amount
  71996. * @param amount amount of DarkenOutOfFocus
  71997. */
  71998. setDarkenOutOfFocus(amount: number): void;
  71999. private _pentagonBokehIsEnabled;
  72000. /**
  72001. * Creates a pentagon bokeh effect
  72002. */
  72003. enablePentagonBokeh(): void;
  72004. /**
  72005. * Disables the pentagon bokeh effect
  72006. */
  72007. disablePentagonBokeh(): void;
  72008. /**
  72009. * Enables noise blur
  72010. */
  72011. enableNoiseBlur(): void;
  72012. /**
  72013. * Disables noise blur
  72014. */
  72015. disableNoiseBlur(): void;
  72016. /**
  72017. * Sets the HighlightsGain amount
  72018. * @param amount amount of HighlightsGain
  72019. */
  72020. setHighlightsGain(amount: number): void;
  72021. /**
  72022. * Sets the HighlightsThreshold amount
  72023. * @param amount amount of HighlightsThreshold
  72024. */
  72025. setHighlightsThreshold(amount: number): void;
  72026. /**
  72027. * Disables highlights
  72028. */
  72029. disableHighlights(): void;
  72030. /**
  72031. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  72032. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  72033. */
  72034. dispose(disableDepthRender?: boolean): void;
  72035. private _createChromaticAberrationPostProcess;
  72036. private _createHighlightsPostProcess;
  72037. private _createDepthOfFieldPostProcess;
  72038. private _createGrainTexture;
  72039. }
  72040. }
  72041. declare module BABYLON {
  72042. /**
  72043. * Contains all parameters needed for the prepass to perform
  72044. * screen space subsurface scattering
  72045. */
  72046. export class SSAO2Configuration implements PrePassEffectConfiguration {
  72047. /**
  72048. * Is subsurface enabled
  72049. */
  72050. enabled: boolean;
  72051. /**
  72052. * Name of the configuration
  72053. */
  72054. name: string;
  72055. /**
  72056. * Textures that should be present in the MRT for this effect to work
  72057. */
  72058. readonly texturesRequired: number[];
  72059. }
  72060. }
  72061. declare module BABYLON {
  72062. /** @hidden */
  72063. export var ssao2PixelShader: {
  72064. name: string;
  72065. shader: string;
  72066. };
  72067. }
  72068. declare module BABYLON {
  72069. /** @hidden */
  72070. export var ssaoCombinePixelShader: {
  72071. name: string;
  72072. shader: string;
  72073. };
  72074. }
  72075. declare module BABYLON {
  72076. /**
  72077. * Render pipeline to produce ssao effect
  72078. */
  72079. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  72080. /**
  72081. * @ignore
  72082. * The PassPostProcess id in the pipeline that contains the original scene color
  72083. */
  72084. SSAOOriginalSceneColorEffect: string;
  72085. /**
  72086. * @ignore
  72087. * The SSAO PostProcess id in the pipeline
  72088. */
  72089. SSAORenderEffect: string;
  72090. /**
  72091. * @ignore
  72092. * The horizontal blur PostProcess id in the pipeline
  72093. */
  72094. SSAOBlurHRenderEffect: string;
  72095. /**
  72096. * @ignore
  72097. * The vertical blur PostProcess id in the pipeline
  72098. */
  72099. SSAOBlurVRenderEffect: string;
  72100. /**
  72101. * @ignore
  72102. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  72103. */
  72104. SSAOCombineRenderEffect: string;
  72105. /**
  72106. * The output strength of the SSAO post-process. Default value is 1.0.
  72107. */
  72108. totalStrength: number;
  72109. /**
  72110. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  72111. */
  72112. maxZ: number;
  72113. /**
  72114. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  72115. */
  72116. minZAspect: number;
  72117. private _samples;
  72118. /**
  72119. * Number of samples used for the SSAO calculations. Default value is 8
  72120. */
  72121. set samples(n: number);
  72122. get samples(): number;
  72123. private _textureSamples;
  72124. /**
  72125. * Number of samples to use for antialiasing
  72126. */
  72127. set textureSamples(n: number);
  72128. get textureSamples(): number;
  72129. /**
  72130. * Force rendering the geometry through geometry buffer
  72131. */
  72132. private _forceGeometryBuffer;
  72133. /**
  72134. * Ratio object used for SSAO ratio and blur ratio
  72135. */
  72136. private _ratio;
  72137. /**
  72138. * Dynamically generated sphere sampler.
  72139. */
  72140. private _sampleSphere;
  72141. /**
  72142. * Blur filter offsets
  72143. */
  72144. private _samplerOffsets;
  72145. private _expensiveBlur;
  72146. /**
  72147. * If bilateral blur should be used
  72148. */
  72149. set expensiveBlur(b: boolean);
  72150. get expensiveBlur(): boolean;
  72151. /**
  72152. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  72153. */
  72154. radius: number;
  72155. /**
  72156. * The base color of the SSAO post-process
  72157. * The final result is "base + ssao" between [0, 1]
  72158. */
  72159. base: number;
  72160. /**
  72161. * Support test.
  72162. */
  72163. static get IsSupported(): boolean;
  72164. private _scene;
  72165. private _randomTexture;
  72166. private _originalColorPostProcess;
  72167. private _ssaoPostProcess;
  72168. private _blurHPostProcess;
  72169. private _blurVPostProcess;
  72170. private _ssaoCombinePostProcess;
  72171. private _prePassRenderer;
  72172. /**
  72173. * Gets active scene
  72174. */
  72175. get scene(): Scene;
  72176. /**
  72177. * @constructor
  72178. * @param name The rendering pipeline name
  72179. * @param scene The scene linked to this pipeline
  72180. * @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 }
  72181. * @param cameras The array of cameras that the rendering pipeline will be attached to
  72182. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  72183. */
  72184. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  72185. /**
  72186. * Get the class name
  72187. * @returns "SSAO2RenderingPipeline"
  72188. */
  72189. getClassName(): string;
  72190. /**
  72191. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  72192. */
  72193. dispose(disableGeometryBufferRenderer?: boolean): void;
  72194. private _createBlurPostProcess;
  72195. /** @hidden */
  72196. _rebuild(): void;
  72197. private _bits;
  72198. private _radicalInverse_VdC;
  72199. private _hammersley;
  72200. private _hemisphereSample_uniform;
  72201. private _generateHemisphere;
  72202. private _getDefinesForSSAO;
  72203. private _createSSAOPostProcess;
  72204. private _createSSAOCombinePostProcess;
  72205. private _createRandomTexture;
  72206. /**
  72207. * Serialize the rendering pipeline (Used when exporting)
  72208. * @returns the serialized object
  72209. */
  72210. serialize(): any;
  72211. /**
  72212. * Parse the serialized pipeline
  72213. * @param source Source pipeline.
  72214. * @param scene The scene to load the pipeline to.
  72215. * @param rootUrl The URL of the serialized pipeline.
  72216. * @returns An instantiated pipeline from the serialized object.
  72217. */
  72218. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  72219. }
  72220. }
  72221. declare module BABYLON {
  72222. /** @hidden */
  72223. export var ssaoPixelShader: {
  72224. name: string;
  72225. shader: string;
  72226. };
  72227. }
  72228. declare module BABYLON {
  72229. /**
  72230. * Render pipeline to produce ssao effect
  72231. */
  72232. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  72233. /**
  72234. * @ignore
  72235. * The PassPostProcess id in the pipeline that contains the original scene color
  72236. */
  72237. SSAOOriginalSceneColorEffect: string;
  72238. /**
  72239. * @ignore
  72240. * The SSAO PostProcess id in the pipeline
  72241. */
  72242. SSAORenderEffect: string;
  72243. /**
  72244. * @ignore
  72245. * The horizontal blur PostProcess id in the pipeline
  72246. */
  72247. SSAOBlurHRenderEffect: string;
  72248. /**
  72249. * @ignore
  72250. * The vertical blur PostProcess id in the pipeline
  72251. */
  72252. SSAOBlurVRenderEffect: string;
  72253. /**
  72254. * @ignore
  72255. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  72256. */
  72257. SSAOCombineRenderEffect: string;
  72258. /**
  72259. * The output strength of the SSAO post-process. Default value is 1.0.
  72260. */
  72261. totalStrength: number;
  72262. /**
  72263. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  72264. */
  72265. radius: number;
  72266. /**
  72267. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  72268. * Must not be equal to fallOff and superior to fallOff.
  72269. * Default value is 0.0075
  72270. */
  72271. area: number;
  72272. /**
  72273. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  72274. * Must not be equal to area and inferior to area.
  72275. * Default value is 0.000001
  72276. */
  72277. fallOff: number;
  72278. /**
  72279. * The base color of the SSAO post-process
  72280. * The final result is "base + ssao" between [0, 1]
  72281. */
  72282. base: number;
  72283. private _scene;
  72284. private _depthTexture;
  72285. private _randomTexture;
  72286. private _originalColorPostProcess;
  72287. private _ssaoPostProcess;
  72288. private _blurHPostProcess;
  72289. private _blurVPostProcess;
  72290. private _ssaoCombinePostProcess;
  72291. private _firstUpdate;
  72292. /**
  72293. * Gets active scene
  72294. */
  72295. get scene(): Scene;
  72296. /**
  72297. * @constructor
  72298. * @param name - The rendering pipeline name
  72299. * @param scene - The scene linked to this pipeline
  72300. * @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 }
  72301. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  72302. */
  72303. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  72304. /**
  72305. * Get the class name
  72306. * @returns "SSAORenderingPipeline"
  72307. */
  72308. getClassName(): string;
  72309. /**
  72310. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  72311. */
  72312. dispose(disableDepthRender?: boolean): void;
  72313. private _createBlurPostProcess;
  72314. /** @hidden */
  72315. _rebuild(): void;
  72316. private _createSSAOPostProcess;
  72317. private _createSSAOCombinePostProcess;
  72318. private _createRandomTexture;
  72319. }
  72320. }
  72321. declare module BABYLON {
  72322. /**
  72323. * Contains all parameters needed for the prepass to perform
  72324. * screen space reflections
  72325. */
  72326. export class ScreenSpaceReflectionsConfiguration implements PrePassEffectConfiguration {
  72327. /**
  72328. * Is ssr enabled
  72329. */
  72330. enabled: boolean;
  72331. /**
  72332. * Name of the configuration
  72333. */
  72334. name: string;
  72335. /**
  72336. * Textures that should be present in the MRT for this effect to work
  72337. */
  72338. readonly texturesRequired: number[];
  72339. }
  72340. }
  72341. declare module BABYLON {
  72342. /** @hidden */
  72343. export var screenSpaceReflectionPixelShader: {
  72344. name: string;
  72345. shader: string;
  72346. };
  72347. }
  72348. declare module BABYLON {
  72349. /**
  72350. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  72351. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  72352. */
  72353. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  72354. /**
  72355. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  72356. */
  72357. threshold: number;
  72358. /**
  72359. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  72360. */
  72361. strength: number;
  72362. /**
  72363. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  72364. */
  72365. reflectionSpecularFalloffExponent: number;
  72366. /**
  72367. * Gets or sets the step size used to iterate until the effect finds the color of the reflection's pixel. Typically in interval [0.1, 1.0]
  72368. */
  72369. step: number;
  72370. /**
  72371. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  72372. */
  72373. roughnessFactor: number;
  72374. private _forceGeometryBuffer;
  72375. private _geometryBufferRenderer;
  72376. private _prePassRenderer;
  72377. private _enableSmoothReflections;
  72378. private _reflectionSamples;
  72379. private _smoothSteps;
  72380. /**
  72381. * Gets a string identifying the name of the class
  72382. * @returns "ScreenSpaceReflectionPostProcess" string
  72383. */
  72384. getClassName(): string;
  72385. /**
  72386. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  72387. * @param name The name of the effect.
  72388. * @param scene The scene containing the objects to calculate reflections.
  72389. * @param options The required width/height ratio to downsize to before computing the render pass.
  72390. * @param camera The camera to apply the render pass to.
  72391. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72392. * @param engine The engine which the post process will be applied. (default: current engine)
  72393. * @param reusable If the post process can be reused on the same frame. (default: false)
  72394. * @param textureType Type of textures used when performing the post process. (default: 0)
  72395. * @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)
  72396. * @param forceGeometryBuffer If this post process should use geometry buffer instead of prepass (default: false)
  72397. */
  72398. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean, forceGeometryBuffer?: boolean);
  72399. /**
  72400. * Gets wether or not smoothing reflections is enabled.
  72401. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  72402. */
  72403. get enableSmoothReflections(): boolean;
  72404. /**
  72405. * Sets wether or not smoothing reflections is enabled.
  72406. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  72407. */
  72408. set enableSmoothReflections(enabled: boolean);
  72409. /**
  72410. * Gets the number of samples taken while computing reflections. More samples count is high,
  72411. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  72412. */
  72413. get reflectionSamples(): number;
  72414. /**
  72415. * Sets the number of samples taken while computing reflections. More samples count is high,
  72416. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  72417. */
  72418. set reflectionSamples(samples: number);
  72419. /**
  72420. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  72421. * more the post-process will require GPU power and can generate a drop in FPS.
  72422. * Default value (5.0) work pretty well in all cases but can be adjusted.
  72423. */
  72424. get smoothSteps(): number;
  72425. set smoothSteps(steps: number);
  72426. private _updateEffectDefines;
  72427. /** @hidden */
  72428. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  72429. }
  72430. }
  72431. declare module BABYLON {
  72432. /** @hidden */
  72433. export var standardPixelShader: {
  72434. name: string;
  72435. shader: string;
  72436. };
  72437. }
  72438. declare module BABYLON {
  72439. /**
  72440. * Standard rendering pipeline
  72441. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  72442. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  72443. */
  72444. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  72445. /**
  72446. * Public members
  72447. */
  72448. /**
  72449. * Post-process which contains the original scene color before the pipeline applies all the effects
  72450. */
  72451. originalPostProcess: Nullable<PostProcess>;
  72452. /**
  72453. * Post-process used to down scale an image x4
  72454. */
  72455. downSampleX4PostProcess: Nullable<PostProcess>;
  72456. /**
  72457. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  72458. */
  72459. brightPassPostProcess: Nullable<PostProcess>;
  72460. /**
  72461. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  72462. */
  72463. blurHPostProcesses: PostProcess[];
  72464. /**
  72465. * Post-process array storing all the vertical blur post-processes used by the pipeline
  72466. */
  72467. blurVPostProcesses: PostProcess[];
  72468. /**
  72469. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  72470. */
  72471. textureAdderPostProcess: Nullable<PostProcess>;
  72472. /**
  72473. * Post-process used to create volumetric lighting effect
  72474. */
  72475. volumetricLightPostProcess: Nullable<PostProcess>;
  72476. /**
  72477. * Post-process used to smooth the previous volumetric light post-process on the X axis
  72478. */
  72479. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  72480. /**
  72481. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  72482. */
  72483. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  72484. /**
  72485. * Post-process used to merge the volumetric light effect and the real scene color
  72486. */
  72487. volumetricLightMergePostProces: Nullable<PostProcess>;
  72488. /**
  72489. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  72490. */
  72491. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  72492. /**
  72493. * Base post-process used to calculate the average luminance of the final image for HDR
  72494. */
  72495. luminancePostProcess: Nullable<PostProcess>;
  72496. /**
  72497. * Post-processes used to create down sample post-processes in order to get
  72498. * the average luminance of the final image for HDR
  72499. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  72500. */
  72501. luminanceDownSamplePostProcesses: PostProcess[];
  72502. /**
  72503. * Post-process used to create a HDR effect (light adaptation)
  72504. */
  72505. hdrPostProcess: Nullable<PostProcess>;
  72506. /**
  72507. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  72508. */
  72509. textureAdderFinalPostProcess: Nullable<PostProcess>;
  72510. /**
  72511. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  72512. */
  72513. lensFlareFinalPostProcess: Nullable<PostProcess>;
  72514. /**
  72515. * Post-process used to merge the final HDR post-process and the real scene color
  72516. */
  72517. hdrFinalPostProcess: Nullable<PostProcess>;
  72518. /**
  72519. * Post-process used to create a lens flare effect
  72520. */
  72521. lensFlarePostProcess: Nullable<PostProcess>;
  72522. /**
  72523. * Post-process that merges the result of the lens flare post-process and the real scene color
  72524. */
  72525. lensFlareComposePostProcess: Nullable<PostProcess>;
  72526. /**
  72527. * Post-process used to create a motion blur effect
  72528. */
  72529. motionBlurPostProcess: Nullable<PostProcess>;
  72530. /**
  72531. * Post-process used to create a depth of field effect
  72532. */
  72533. depthOfFieldPostProcess: Nullable<PostProcess>;
  72534. /**
  72535. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  72536. */
  72537. fxaaPostProcess: Nullable<FxaaPostProcess>;
  72538. /**
  72539. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  72540. */
  72541. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  72542. /**
  72543. * Represents the brightness threshold in order to configure the illuminated surfaces
  72544. */
  72545. brightThreshold: number;
  72546. /**
  72547. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  72548. */
  72549. blurWidth: number;
  72550. /**
  72551. * Sets if the blur for highlighted surfaces must be only horizontal
  72552. */
  72553. horizontalBlur: boolean;
  72554. /**
  72555. * Gets the overall exposure used by the pipeline
  72556. */
  72557. get exposure(): number;
  72558. /**
  72559. * Sets the overall exposure used by the pipeline
  72560. */
  72561. set exposure(value: number);
  72562. /**
  72563. * Texture used typically to simulate "dirty" on camera lens
  72564. */
  72565. lensTexture: Nullable<Texture>;
  72566. /**
  72567. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  72568. */
  72569. volumetricLightCoefficient: number;
  72570. /**
  72571. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  72572. */
  72573. volumetricLightPower: number;
  72574. /**
  72575. * Used the set the blur intensity to smooth the volumetric lights
  72576. */
  72577. volumetricLightBlurScale: number;
  72578. /**
  72579. * Light (spot or directional) used to generate the volumetric lights rays
  72580. * The source light must have a shadow generate so the pipeline can get its
  72581. * depth map
  72582. */
  72583. sourceLight: Nullable<SpotLight | DirectionalLight>;
  72584. /**
  72585. * For eye adaptation, represents the minimum luminance the eye can see
  72586. */
  72587. hdrMinimumLuminance: number;
  72588. /**
  72589. * For eye adaptation, represents the decrease luminance speed
  72590. */
  72591. hdrDecreaseRate: number;
  72592. /**
  72593. * For eye adaptation, represents the increase luminance speed
  72594. */
  72595. hdrIncreaseRate: number;
  72596. /**
  72597. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  72598. */
  72599. get hdrAutoExposure(): boolean;
  72600. /**
  72601. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  72602. */
  72603. set hdrAutoExposure(value: boolean);
  72604. /**
  72605. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  72606. */
  72607. lensColorTexture: Nullable<Texture>;
  72608. /**
  72609. * The overall strengh for the lens flare effect
  72610. */
  72611. lensFlareStrength: number;
  72612. /**
  72613. * Dispersion coefficient for lens flare ghosts
  72614. */
  72615. lensFlareGhostDispersal: number;
  72616. /**
  72617. * Main lens flare halo width
  72618. */
  72619. lensFlareHaloWidth: number;
  72620. /**
  72621. * Based on the lens distortion effect, defines how much the lens flare result
  72622. * is distorted
  72623. */
  72624. lensFlareDistortionStrength: number;
  72625. /**
  72626. * Configures the blur intensity used for for lens flare (halo)
  72627. */
  72628. lensFlareBlurWidth: number;
  72629. /**
  72630. * Lens star texture must be used to simulate rays on the flares and is available
  72631. * in the documentation
  72632. */
  72633. lensStarTexture: Nullable<Texture>;
  72634. /**
  72635. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  72636. * flare effect by taking account of the dirt texture
  72637. */
  72638. lensFlareDirtTexture: Nullable<Texture>;
  72639. /**
  72640. * Represents the focal length for the depth of field effect
  72641. */
  72642. depthOfFieldDistance: number;
  72643. /**
  72644. * Represents the blur intensity for the blurred part of the depth of field effect
  72645. */
  72646. depthOfFieldBlurWidth: number;
  72647. /**
  72648. * Gets how much the image is blurred by the movement while using the motion blur post-process
  72649. */
  72650. get motionStrength(): number;
  72651. /**
  72652. * Sets how much the image is blurred by the movement while using the motion blur post-process
  72653. */
  72654. set motionStrength(strength: number);
  72655. /**
  72656. * Gets wether or not the motion blur post-process is object based or screen based.
  72657. */
  72658. get objectBasedMotionBlur(): boolean;
  72659. /**
  72660. * Sets wether or not the motion blur post-process should be object based or screen based
  72661. */
  72662. set objectBasedMotionBlur(value: boolean);
  72663. /**
  72664. * List of animations for the pipeline (IAnimatable implementation)
  72665. */
  72666. animations: Animation[];
  72667. /**
  72668. * Private members
  72669. */
  72670. private _scene;
  72671. private _currentDepthOfFieldSource;
  72672. private _basePostProcess;
  72673. private _fixedExposure;
  72674. private _currentExposure;
  72675. private _hdrAutoExposure;
  72676. private _hdrCurrentLuminance;
  72677. private _motionStrength;
  72678. private _isObjectBasedMotionBlur;
  72679. private _floatTextureType;
  72680. private _camerasToBeAttached;
  72681. private _ratio;
  72682. private _bloomEnabled;
  72683. private _depthOfFieldEnabled;
  72684. private _vlsEnabled;
  72685. private _lensFlareEnabled;
  72686. private _hdrEnabled;
  72687. private _motionBlurEnabled;
  72688. private _fxaaEnabled;
  72689. private _screenSpaceReflectionsEnabled;
  72690. private _motionBlurSamples;
  72691. private _volumetricLightStepsCount;
  72692. private _samples;
  72693. /**
  72694. * @ignore
  72695. * Specifies if the bloom pipeline is enabled
  72696. */
  72697. get BloomEnabled(): boolean;
  72698. set BloomEnabled(enabled: boolean);
  72699. /**
  72700. * @ignore
  72701. * Specifies if the depth of field pipeline is enabed
  72702. */
  72703. get DepthOfFieldEnabled(): boolean;
  72704. set DepthOfFieldEnabled(enabled: boolean);
  72705. /**
  72706. * @ignore
  72707. * Specifies if the lens flare pipeline is enabed
  72708. */
  72709. get LensFlareEnabled(): boolean;
  72710. set LensFlareEnabled(enabled: boolean);
  72711. /**
  72712. * @ignore
  72713. * Specifies if the HDR pipeline is enabled
  72714. */
  72715. get HDREnabled(): boolean;
  72716. set HDREnabled(enabled: boolean);
  72717. /**
  72718. * @ignore
  72719. * Specifies if the volumetric lights scattering effect is enabled
  72720. */
  72721. get VLSEnabled(): boolean;
  72722. set VLSEnabled(enabled: boolean);
  72723. /**
  72724. * @ignore
  72725. * Specifies if the motion blur effect is enabled
  72726. */
  72727. get MotionBlurEnabled(): boolean;
  72728. set MotionBlurEnabled(enabled: boolean);
  72729. /**
  72730. * Specifies if anti-aliasing is enabled
  72731. */
  72732. get fxaaEnabled(): boolean;
  72733. set fxaaEnabled(enabled: boolean);
  72734. /**
  72735. * Specifies if screen space reflections are enabled.
  72736. */
  72737. get screenSpaceReflectionsEnabled(): boolean;
  72738. set screenSpaceReflectionsEnabled(enabled: boolean);
  72739. /**
  72740. * Specifies the number of steps used to calculate the volumetric lights
  72741. * Typically in interval [50, 200]
  72742. */
  72743. get volumetricLightStepsCount(): number;
  72744. set volumetricLightStepsCount(count: number);
  72745. /**
  72746. * Specifies the number of samples used for the motion blur effect
  72747. * Typically in interval [16, 64]
  72748. */
  72749. get motionBlurSamples(): number;
  72750. set motionBlurSamples(samples: number);
  72751. /**
  72752. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  72753. */
  72754. get samples(): number;
  72755. set samples(sampleCount: number);
  72756. /**
  72757. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  72758. * @constructor
  72759. * @param name The rendering pipeline name
  72760. * @param scene The scene linked to this pipeline
  72761. * @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)
  72762. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  72763. * @param cameras The array of cameras that the rendering pipeline will be attached to
  72764. */
  72765. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  72766. private _buildPipeline;
  72767. private _createDownSampleX4PostProcess;
  72768. private _createBrightPassPostProcess;
  72769. private _createBlurPostProcesses;
  72770. private _createTextureAdderPostProcess;
  72771. private _createVolumetricLightPostProcess;
  72772. private _createLuminancePostProcesses;
  72773. private _createHdrPostProcess;
  72774. private _createLensFlarePostProcess;
  72775. private _createDepthOfFieldPostProcess;
  72776. private _createMotionBlurPostProcess;
  72777. private _getDepthTexture;
  72778. private _disposePostProcesses;
  72779. /**
  72780. * Dispose of the pipeline and stop all post processes
  72781. */
  72782. dispose(): void;
  72783. /**
  72784. * Serialize the rendering pipeline (Used when exporting)
  72785. * @returns the serialized object
  72786. */
  72787. serialize(): any;
  72788. /**
  72789. * Parse the serialized pipeline
  72790. * @param source Source pipeline.
  72791. * @param scene The scene to load the pipeline to.
  72792. * @param rootUrl The URL of the serialized pipeline.
  72793. * @returns An instantiated pipeline from the serialized object.
  72794. */
  72795. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  72796. /**
  72797. * Luminance steps
  72798. */
  72799. static LuminanceSteps: number;
  72800. }
  72801. }
  72802. declare module BABYLON {
  72803. /** @hidden */
  72804. export var stereoscopicInterlacePixelShader: {
  72805. name: string;
  72806. shader: string;
  72807. };
  72808. }
  72809. declare module BABYLON {
  72810. /**
  72811. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  72812. */
  72813. export class StereoscopicInterlacePostProcessI extends PostProcess {
  72814. private _stepSize;
  72815. private _passedProcess;
  72816. /**
  72817. * Gets a string identifying the name of the class
  72818. * @returns "StereoscopicInterlacePostProcessI" string
  72819. */
  72820. getClassName(): string;
  72821. /**
  72822. * Initializes a StereoscopicInterlacePostProcessI
  72823. * @param name The name of the effect.
  72824. * @param rigCameras The rig cameras to be appled to the post process
  72825. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  72826. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  72827. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72828. * @param engine The engine which the post process will be applied. (default: current engine)
  72829. * @param reusable If the post process can be reused on the same frame. (default: false)
  72830. */
  72831. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72832. }
  72833. /**
  72834. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  72835. */
  72836. export class StereoscopicInterlacePostProcess extends PostProcess {
  72837. private _stepSize;
  72838. private _passedProcess;
  72839. /**
  72840. * Gets a string identifying the name of the class
  72841. * @returns "StereoscopicInterlacePostProcess" string
  72842. */
  72843. getClassName(): string;
  72844. /**
  72845. * Initializes a StereoscopicInterlacePostProcess
  72846. * @param name The name of the effect.
  72847. * @param rigCameras The rig cameras to be appled to the post process
  72848. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  72849. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72850. * @param engine The engine which the post process will be applied. (default: current engine)
  72851. * @param reusable If the post process can be reused on the same frame. (default: false)
  72852. */
  72853. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72854. }
  72855. }
  72856. declare module BABYLON {
  72857. /** @hidden */
  72858. export var tonemapPixelShader: {
  72859. name: string;
  72860. shader: string;
  72861. };
  72862. }
  72863. declare module BABYLON {
  72864. /** Defines operator used for tonemapping */
  72865. export enum TonemappingOperator {
  72866. /** Hable */
  72867. Hable = 0,
  72868. /** Reinhard */
  72869. Reinhard = 1,
  72870. /** HejiDawson */
  72871. HejiDawson = 2,
  72872. /** Photographic */
  72873. Photographic = 3
  72874. }
  72875. /**
  72876. * Defines a post process to apply tone mapping
  72877. */
  72878. export class TonemapPostProcess extends PostProcess {
  72879. private _operator;
  72880. /** Defines the required exposure adjustement */
  72881. exposureAdjustment: number;
  72882. /**
  72883. * Gets a string identifying the name of the class
  72884. * @returns "TonemapPostProcess" string
  72885. */
  72886. getClassName(): string;
  72887. /**
  72888. * Creates a new TonemapPostProcess
  72889. * @param name defines the name of the postprocess
  72890. * @param _operator defines the operator to use
  72891. * @param exposureAdjustment defines the required exposure adjustement
  72892. * @param camera defines the camera to use (can be null)
  72893. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  72894. * @param engine defines the hosting engine (can be ignore if camera is set)
  72895. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  72896. */
  72897. constructor(name: string, _operator: TonemappingOperator,
  72898. /** Defines the required exposure adjustement */
  72899. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  72900. }
  72901. }
  72902. declare module BABYLON {
  72903. /** @hidden */
  72904. export var volumetricLightScatteringPixelShader: {
  72905. name: string;
  72906. shader: string;
  72907. };
  72908. }
  72909. declare module BABYLON {
  72910. /** @hidden */
  72911. export var volumetricLightScatteringPassVertexShader: {
  72912. name: string;
  72913. shader: string;
  72914. };
  72915. }
  72916. declare module BABYLON {
  72917. /** @hidden */
  72918. export var volumetricLightScatteringPassPixelShader: {
  72919. name: string;
  72920. shader: string;
  72921. };
  72922. }
  72923. declare module BABYLON {
  72924. /**
  72925. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  72926. */
  72927. export class VolumetricLightScatteringPostProcess extends PostProcess {
  72928. private _volumetricLightScatteringPass;
  72929. private _volumetricLightScatteringRTT;
  72930. private _viewPort;
  72931. private _screenCoordinates;
  72932. private _cachedDefines;
  72933. /**
  72934. * If not undefined, the mesh position is computed from the attached node position
  72935. */
  72936. attachedNode: {
  72937. position: Vector3;
  72938. };
  72939. /**
  72940. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  72941. */
  72942. customMeshPosition: Vector3;
  72943. /**
  72944. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  72945. */
  72946. useCustomMeshPosition: boolean;
  72947. /**
  72948. * If the post-process should inverse the light scattering direction
  72949. */
  72950. invert: boolean;
  72951. /**
  72952. * The internal mesh used by the post-process
  72953. */
  72954. mesh: Mesh;
  72955. /**
  72956. * @hidden
  72957. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  72958. */
  72959. get useDiffuseColor(): boolean;
  72960. set useDiffuseColor(useDiffuseColor: boolean);
  72961. /**
  72962. * Array containing the excluded meshes not rendered in the internal pass
  72963. */
  72964. excludedMeshes: AbstractMesh[];
  72965. /**
  72966. * Controls the overall intensity of the post-process
  72967. */
  72968. exposure: number;
  72969. /**
  72970. * Dissipates each sample's contribution in range [0, 1]
  72971. */
  72972. decay: number;
  72973. /**
  72974. * Controls the overall intensity of each sample
  72975. */
  72976. weight: number;
  72977. /**
  72978. * Controls the density of each sample
  72979. */
  72980. density: number;
  72981. /**
  72982. * @constructor
  72983. * @param name The post-process name
  72984. * @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)
  72985. * @param camera The camera that the post-process will be attached to
  72986. * @param mesh The mesh used to create the light scattering
  72987. * @param samples The post-process quality, default 100
  72988. * @param samplingModeThe post-process filtering mode
  72989. * @param engine The babylon engine
  72990. * @param reusable If the post-process is reusable
  72991. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  72992. */
  72993. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  72994. /**
  72995. * Returns the string "VolumetricLightScatteringPostProcess"
  72996. * @returns "VolumetricLightScatteringPostProcess"
  72997. */
  72998. getClassName(): string;
  72999. private _isReady;
  73000. /**
  73001. * Sets the new light position for light scattering effect
  73002. * @param position The new custom light position
  73003. */
  73004. setCustomMeshPosition(position: Vector3): void;
  73005. /**
  73006. * Returns the light position for light scattering effect
  73007. * @return Vector3 The custom light position
  73008. */
  73009. getCustomMeshPosition(): Vector3;
  73010. /**
  73011. * Disposes the internal assets and detaches the post-process from the camera
  73012. */
  73013. dispose(camera: Camera): void;
  73014. /**
  73015. * Returns the render target texture used by the post-process
  73016. * @return the render target texture used by the post-process
  73017. */
  73018. getPass(): RenderTargetTexture;
  73019. private _meshExcluded;
  73020. private _createPass;
  73021. private _updateMeshScreenCoordinates;
  73022. /**
  73023. * Creates a default mesh for the Volumeric Light Scattering post-process
  73024. * @param name The mesh name
  73025. * @param scene The scene where to create the mesh
  73026. * @return the default mesh
  73027. */
  73028. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  73029. }
  73030. }
  73031. declare module BABYLON {
  73032. /** @hidden */
  73033. export var screenSpaceCurvaturePixelShader: {
  73034. name: string;
  73035. shader: string;
  73036. };
  73037. }
  73038. declare module BABYLON {
  73039. /**
  73040. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  73041. */
  73042. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  73043. /**
  73044. * Defines how much ridge the curvature effect displays.
  73045. */
  73046. ridge: number;
  73047. /**
  73048. * Defines how much valley the curvature effect displays.
  73049. */
  73050. valley: number;
  73051. private _geometryBufferRenderer;
  73052. /**
  73053. * Gets a string identifying the name of the class
  73054. * @returns "ScreenSpaceCurvaturePostProcess" string
  73055. */
  73056. getClassName(): string;
  73057. /**
  73058. * Creates a new instance ScreenSpaceCurvaturePostProcess
  73059. * @param name The name of the effect.
  73060. * @param scene The scene containing the objects to blur according to their velocity.
  73061. * @param options The required width/height ratio to downsize to before computing the render pass.
  73062. * @param camera The camera to apply the render pass to.
  73063. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73064. * @param engine The engine which the post process will be applied. (default: current engine)
  73065. * @param reusable If the post process can be reused on the same frame. (default: false)
  73066. * @param textureType Type of textures used when performing the post process. (default: 0)
  73067. * @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)
  73068. */
  73069. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73070. /**
  73071. * Support test.
  73072. */
  73073. static get IsSupported(): boolean;
  73074. /** @hidden */
  73075. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  73076. }
  73077. }
  73078. declare module BABYLON {
  73079. interface Scene {
  73080. /** @hidden (Backing field) */
  73081. _boundingBoxRenderer: BoundingBoxRenderer;
  73082. /** @hidden (Backing field) */
  73083. _forceShowBoundingBoxes: boolean;
  73084. /**
  73085. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  73086. */
  73087. forceShowBoundingBoxes: boolean;
  73088. /**
  73089. * Gets the bounding box renderer associated with the scene
  73090. * @returns a BoundingBoxRenderer
  73091. */
  73092. getBoundingBoxRenderer(): BoundingBoxRenderer;
  73093. }
  73094. interface AbstractMesh {
  73095. /** @hidden (Backing field) */
  73096. _showBoundingBox: boolean;
  73097. /**
  73098. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  73099. */
  73100. showBoundingBox: boolean;
  73101. }
  73102. /**
  73103. * Component responsible of rendering the bounding box of the meshes in a scene.
  73104. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  73105. */
  73106. export class BoundingBoxRenderer implements ISceneComponent {
  73107. /**
  73108. * The component name helpfull to identify the component in the list of scene components.
  73109. */
  73110. readonly name: string;
  73111. /**
  73112. * The scene the component belongs to.
  73113. */
  73114. scene: Scene;
  73115. /**
  73116. * Color of the bounding box lines placed in front of an object
  73117. */
  73118. frontColor: Color3;
  73119. /**
  73120. * Color of the bounding box lines placed behind an object
  73121. */
  73122. backColor: Color3;
  73123. /**
  73124. * Defines if the renderer should show the back lines or not
  73125. */
  73126. showBackLines: boolean;
  73127. /**
  73128. * Observable raised before rendering a bounding box
  73129. */
  73130. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  73131. /**
  73132. * Observable raised after rendering a bounding box
  73133. */
  73134. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  73135. /**
  73136. * Observable raised after resources are created
  73137. */
  73138. onResourcesReadyObservable: Observable<BoundingBoxRenderer>;
  73139. /**
  73140. * When false, no bounding boxes will be rendered
  73141. */
  73142. enabled: boolean;
  73143. /**
  73144. * @hidden
  73145. */
  73146. renderList: SmartArray<BoundingBox>;
  73147. private _colorShader;
  73148. private _vertexBuffers;
  73149. private _indexBuffer;
  73150. private _fillIndexBuffer;
  73151. private _fillIndexData;
  73152. /**
  73153. * Instantiates a new bounding box renderer in a scene.
  73154. * @param scene the scene the renderer renders in
  73155. */
  73156. constructor(scene: Scene);
  73157. /**
  73158. * Registers the component in a given scene
  73159. */
  73160. register(): void;
  73161. private _evaluateSubMesh;
  73162. private _preActiveMesh;
  73163. private _prepareResources;
  73164. private _createIndexBuffer;
  73165. /**
  73166. * Rebuilds the elements related to this component in case of
  73167. * context lost for instance.
  73168. */
  73169. rebuild(): void;
  73170. /**
  73171. * @hidden
  73172. */
  73173. reset(): void;
  73174. /**
  73175. * Render the bounding boxes of a specific rendering group
  73176. * @param renderingGroupId defines the rendering group to render
  73177. */
  73178. render(renderingGroupId: number): void;
  73179. /**
  73180. * In case of occlusion queries, we can render the occlusion bounding box through this method
  73181. * @param mesh Define the mesh to render the occlusion bounding box for
  73182. */
  73183. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  73184. /**
  73185. * Dispose and release the resources attached to this renderer.
  73186. */
  73187. dispose(): void;
  73188. }
  73189. }
  73190. declare module BABYLON {
  73191. interface Scene {
  73192. /** @hidden (Backing field) */
  73193. _depthRenderer: {
  73194. [id: string]: DepthRenderer;
  73195. };
  73196. /**
  73197. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  73198. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  73199. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  73200. * @param force32bitsFloat Forces 32 bits float when supported (else 16 bits float is prioritized over 32 bits float if supported)
  73201. * @returns the created depth renderer
  73202. */
  73203. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean, force32bitsFloat?: boolean): DepthRenderer;
  73204. /**
  73205. * Disables a depth renderer for a given camera
  73206. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  73207. */
  73208. disableDepthRenderer(camera?: Nullable<Camera>): void;
  73209. }
  73210. /**
  73211. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  73212. * in several rendering techniques.
  73213. */
  73214. export class DepthRendererSceneComponent implements ISceneComponent {
  73215. /**
  73216. * The component name helpfull to identify the component in the list of scene components.
  73217. */
  73218. readonly name: string;
  73219. /**
  73220. * The scene the component belongs to.
  73221. */
  73222. scene: Scene;
  73223. /**
  73224. * Creates a new instance of the component for the given scene
  73225. * @param scene Defines the scene to register the component in
  73226. */
  73227. constructor(scene: Scene);
  73228. /**
  73229. * Registers the component in a given scene
  73230. */
  73231. register(): void;
  73232. /**
  73233. * Rebuilds the elements related to this component in case of
  73234. * context lost for instance.
  73235. */
  73236. rebuild(): void;
  73237. /**
  73238. * Disposes the component and the associated ressources
  73239. */
  73240. dispose(): void;
  73241. private _gatherRenderTargets;
  73242. private _gatherActiveCameraRenderTargets;
  73243. }
  73244. }
  73245. declare module BABYLON {
  73246. interface AbstractScene {
  73247. /** @hidden (Backing field) */
  73248. _prePassRenderer: Nullable<PrePassRenderer>;
  73249. /**
  73250. * Gets or Sets the current prepass renderer associated to the scene.
  73251. */
  73252. prePassRenderer: Nullable<PrePassRenderer>;
  73253. /**
  73254. * Enables the prepass and associates it with the scene
  73255. * @returns the PrePassRenderer
  73256. */
  73257. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  73258. /**
  73259. * Disables the prepass associated with the scene
  73260. */
  73261. disablePrePassRenderer(): void;
  73262. }
  73263. /**
  73264. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  73265. * in several rendering techniques.
  73266. */
  73267. export class PrePassRendererSceneComponent implements ISceneComponent {
  73268. /**
  73269. * The component name helpful to identify the component in the list of scene components.
  73270. */
  73271. readonly name: string;
  73272. /**
  73273. * The scene the component belongs to.
  73274. */
  73275. scene: Scene;
  73276. /**
  73277. * Creates a new instance of the component for the given scene
  73278. * @param scene Defines the scene to register the component in
  73279. */
  73280. constructor(scene: Scene);
  73281. /**
  73282. * Registers the component in a given scene
  73283. */
  73284. register(): void;
  73285. private _beforeCameraDraw;
  73286. private _afterCameraDraw;
  73287. private _beforeClearStage;
  73288. /**
  73289. * Rebuilds the elements related to this component in case of
  73290. * context lost for instance.
  73291. */
  73292. rebuild(): void;
  73293. /**
  73294. * Disposes the component and the associated ressources
  73295. */
  73296. dispose(): void;
  73297. }
  73298. }
  73299. declare module BABYLON {
  73300. /** @hidden */
  73301. export var fibonacci: {
  73302. name: string;
  73303. shader: string;
  73304. };
  73305. }
  73306. declare module BABYLON {
  73307. /** @hidden */
  73308. export var diffusionProfile: {
  73309. name: string;
  73310. shader: string;
  73311. };
  73312. }
  73313. declare module BABYLON {
  73314. /** @hidden */
  73315. export var subSurfaceScatteringPixelShader: {
  73316. name: string;
  73317. shader: string;
  73318. };
  73319. }
  73320. declare module BABYLON {
  73321. /**
  73322. * Sub surface scattering post process
  73323. */
  73324. export class SubSurfaceScatteringPostProcess extends PostProcess {
  73325. /**
  73326. * Gets a string identifying the name of the class
  73327. * @returns "SubSurfaceScatteringPostProcess" string
  73328. */
  73329. getClassName(): string;
  73330. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73331. }
  73332. }
  73333. declare module BABYLON {
  73334. /**
  73335. * Contains all parameters needed for the prepass to perform
  73336. * screen space subsurface scattering
  73337. */
  73338. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  73339. /** @hidden */
  73340. static _SceneComponentInitialization: (scene: Scene) => void;
  73341. private _ssDiffusionS;
  73342. private _ssFilterRadii;
  73343. private _ssDiffusionD;
  73344. /**
  73345. * Post process to attach for screen space subsurface scattering
  73346. */
  73347. postProcess: SubSurfaceScatteringPostProcess;
  73348. /**
  73349. * Diffusion profile color for subsurface scattering
  73350. */
  73351. get ssDiffusionS(): number[];
  73352. /**
  73353. * Diffusion profile max color channel value for subsurface scattering
  73354. */
  73355. get ssDiffusionD(): number[];
  73356. /**
  73357. * Diffusion profile filter radius for subsurface scattering
  73358. */
  73359. get ssFilterRadii(): number[];
  73360. /**
  73361. * Is subsurface enabled
  73362. */
  73363. enabled: boolean;
  73364. /**
  73365. * Name of the configuration
  73366. */
  73367. name: string;
  73368. /**
  73369. * Diffusion profile colors for subsurface scattering
  73370. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  73371. * See ...
  73372. * Note that you can only store up to 5 of them
  73373. */
  73374. ssDiffusionProfileColors: Color3[];
  73375. /**
  73376. * Defines the ratio real world => scene units.
  73377. * Used for subsurface scattering
  73378. */
  73379. metersPerUnit: number;
  73380. /**
  73381. * Textures that should be present in the MRT for this effect to work
  73382. */
  73383. readonly texturesRequired: number[];
  73384. private _scene;
  73385. /**
  73386. * Builds a subsurface configuration object
  73387. * @param scene The scene
  73388. */
  73389. constructor(scene: Scene);
  73390. /**
  73391. * Adds a new diffusion profile.
  73392. * Useful for more realistic subsurface scattering on diverse materials.
  73393. * @param color The color of the diffusion profile. Should be the average color of the material.
  73394. * @return The index of the diffusion profile for the material subsurface configuration
  73395. */
  73396. addDiffusionProfile(color: Color3): number;
  73397. /**
  73398. * Creates the sss post process
  73399. * @return The created post process
  73400. */
  73401. createPostProcess(): SubSurfaceScatteringPostProcess;
  73402. /**
  73403. * Deletes all diffusion profiles.
  73404. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  73405. */
  73406. clearAllDiffusionProfiles(): void;
  73407. /**
  73408. * Disposes this object
  73409. */
  73410. dispose(): void;
  73411. /**
  73412. * @hidden
  73413. * https://zero-radiance.github.io/post/sampling-diffusion/
  73414. *
  73415. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  73416. * ------------------------------------------------------------------------------------
  73417. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  73418. * PDF[r, phi, s] = r * R[r, phi, s]
  73419. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  73420. * ------------------------------------------------------------------------------------
  73421. * We importance sample the color channel with the widest scattering distance.
  73422. */
  73423. getDiffusionProfileParameters(color: Color3): number;
  73424. /**
  73425. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  73426. * 'u' is the random number (the value of the CDF): [0, 1).
  73427. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  73428. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  73429. */
  73430. private _sampleBurleyDiffusionProfile;
  73431. }
  73432. }
  73433. declare module BABYLON {
  73434. interface AbstractScene {
  73435. /** @hidden (Backing field) */
  73436. _subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>;
  73437. /**
  73438. * Gets or Sets the current prepass renderer associated to the scene.
  73439. */
  73440. subSurfaceConfiguration: Nullable<SubSurfaceConfiguration>;
  73441. /**
  73442. * Enables the subsurface effect for prepass
  73443. * @returns the SubSurfaceConfiguration
  73444. */
  73445. enableSubSurfaceForPrePass(): Nullable<SubSurfaceConfiguration>;
  73446. /**
  73447. * Disables the subsurface effect for prepass
  73448. */
  73449. disableSubSurfaceForPrePass(): void;
  73450. }
  73451. /**
  73452. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  73453. * in several rendering techniques.
  73454. */
  73455. export class SubSurfaceSceneComponent implements ISceneSerializableComponent {
  73456. /**
  73457. * The component name helpful to identify the component in the list of scene components.
  73458. */
  73459. readonly name: string;
  73460. /**
  73461. * The scene the component belongs to.
  73462. */
  73463. scene: Scene;
  73464. /**
  73465. * Creates a new instance of the component for the given scene
  73466. * @param scene Defines the scene to register the component in
  73467. */
  73468. constructor(scene: Scene);
  73469. /**
  73470. * Registers the component in a given scene
  73471. */
  73472. register(): void;
  73473. /**
  73474. * Serializes the component data to the specified json object
  73475. * @param serializationObject The object to serialize to
  73476. */
  73477. serialize(serializationObject: any): void;
  73478. /**
  73479. * Adds all the elements from the container to the scene
  73480. * @param container the container holding the elements
  73481. */
  73482. addFromContainer(container: AbstractScene): void;
  73483. /**
  73484. * Removes all the elements in the container from the scene
  73485. * @param container contains the elements to remove
  73486. * @param dispose if the removed element should be disposed (default: false)
  73487. */
  73488. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  73489. /**
  73490. * Rebuilds the elements related to this component in case of
  73491. * context lost for instance.
  73492. */
  73493. rebuild(): void;
  73494. /**
  73495. * Disposes the component and the associated ressources
  73496. */
  73497. dispose(): void;
  73498. }
  73499. }
  73500. declare module BABYLON {
  73501. /** @hidden */
  73502. export var outlinePixelShader: {
  73503. name: string;
  73504. shader: string;
  73505. };
  73506. }
  73507. declare module BABYLON {
  73508. /** @hidden */
  73509. export var outlineVertexShader: {
  73510. name: string;
  73511. shader: string;
  73512. };
  73513. }
  73514. declare module BABYLON {
  73515. interface Scene {
  73516. /** @hidden */
  73517. _outlineRenderer: OutlineRenderer;
  73518. /**
  73519. * Gets the outline renderer associated with the scene
  73520. * @returns a OutlineRenderer
  73521. */
  73522. getOutlineRenderer(): OutlineRenderer;
  73523. }
  73524. interface AbstractMesh {
  73525. /** @hidden (Backing field) */
  73526. _renderOutline: boolean;
  73527. /**
  73528. * Gets or sets a boolean indicating if the outline must be rendered as well
  73529. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  73530. */
  73531. renderOutline: boolean;
  73532. /** @hidden (Backing field) */
  73533. _renderOverlay: boolean;
  73534. /**
  73535. * Gets or sets a boolean indicating if the overlay must be rendered as well
  73536. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  73537. */
  73538. renderOverlay: boolean;
  73539. }
  73540. /**
  73541. * This class is responsible to draw bothe outline/overlay of meshes.
  73542. * It should not be used directly but through the available method on mesh.
  73543. */
  73544. export class OutlineRenderer implements ISceneComponent {
  73545. /**
  73546. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  73547. */
  73548. private static _StencilReference;
  73549. /**
  73550. * The name of the component. Each component must have a unique name.
  73551. */
  73552. name: string;
  73553. /**
  73554. * The scene the component belongs to.
  73555. */
  73556. scene: Scene;
  73557. /**
  73558. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  73559. */
  73560. zOffset: number;
  73561. private _engine;
  73562. private _effect;
  73563. private _cachedDefines;
  73564. private _savedDepthWrite;
  73565. /**
  73566. * Instantiates a new outline renderer. (There could be only one per scene).
  73567. * @param scene Defines the scene it belongs to
  73568. */
  73569. constructor(scene: Scene);
  73570. /**
  73571. * Register the component to one instance of a scene.
  73572. */
  73573. register(): void;
  73574. /**
  73575. * Rebuilds the elements related to this component in case of
  73576. * context lost for instance.
  73577. */
  73578. rebuild(): void;
  73579. /**
  73580. * Disposes the component and the associated ressources.
  73581. */
  73582. dispose(): void;
  73583. /**
  73584. * Renders the outline in the canvas.
  73585. * @param subMesh Defines the sumesh to render
  73586. * @param batch Defines the batch of meshes in case of instances
  73587. * @param useOverlay Defines if the rendering is for the overlay or the outline
  73588. */
  73589. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  73590. /**
  73591. * Returns whether or not the outline renderer is ready for a given submesh.
  73592. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  73593. * @param subMesh Defines the submesh to check readyness for
  73594. * @param useInstances Defines wheter wee are trying to render instances or not
  73595. * @returns true if ready otherwise false
  73596. */
  73597. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73598. private _beforeRenderingMesh;
  73599. private _afterRenderingMesh;
  73600. }
  73601. }
  73602. declare module BABYLON {
  73603. /**
  73604. * Defines the basic options interface of a Sprite Frame Source Size.
  73605. */
  73606. export interface ISpriteJSONSpriteSourceSize {
  73607. /**
  73608. * number of the original width of the Frame
  73609. */
  73610. w: number;
  73611. /**
  73612. * number of the original height of the Frame
  73613. */
  73614. h: number;
  73615. }
  73616. /**
  73617. * Defines the basic options interface of a Sprite Frame Data.
  73618. */
  73619. export interface ISpriteJSONSpriteFrameData {
  73620. /**
  73621. * number of the x offset of the Frame
  73622. */
  73623. x: number;
  73624. /**
  73625. * number of the y offset of the Frame
  73626. */
  73627. y: number;
  73628. /**
  73629. * number of the width of the Frame
  73630. */
  73631. w: number;
  73632. /**
  73633. * number of the height of the Frame
  73634. */
  73635. h: number;
  73636. }
  73637. /**
  73638. * Defines the basic options interface of a JSON Sprite.
  73639. */
  73640. export interface ISpriteJSONSprite {
  73641. /**
  73642. * string name of the Frame
  73643. */
  73644. filename: string;
  73645. /**
  73646. * ISpriteJSONSpriteFrame basic object of the frame data
  73647. */
  73648. frame: ISpriteJSONSpriteFrameData;
  73649. /**
  73650. * boolean to flag is the frame was rotated.
  73651. */
  73652. rotated: boolean;
  73653. /**
  73654. * boolean to flag is the frame was trimmed.
  73655. */
  73656. trimmed: boolean;
  73657. /**
  73658. * ISpriteJSONSpriteFrame basic object of the source data
  73659. */
  73660. spriteSourceSize: ISpriteJSONSpriteFrameData;
  73661. /**
  73662. * ISpriteJSONSpriteFrame basic object of the source data
  73663. */
  73664. sourceSize: ISpriteJSONSpriteSourceSize;
  73665. }
  73666. /**
  73667. * Defines the basic options interface of a JSON atlas.
  73668. */
  73669. export interface ISpriteJSONAtlas {
  73670. /**
  73671. * Array of objects that contain the frame data.
  73672. */
  73673. frames: Array<ISpriteJSONSprite>;
  73674. /**
  73675. * object basic object containing the sprite meta data.
  73676. */
  73677. meta?: object;
  73678. }
  73679. }
  73680. declare module BABYLON {
  73681. /** @hidden */
  73682. export var spriteMapPixelShader: {
  73683. name: string;
  73684. shader: string;
  73685. };
  73686. }
  73687. declare module BABYLON {
  73688. /** @hidden */
  73689. export var spriteMapVertexShader: {
  73690. name: string;
  73691. shader: string;
  73692. };
  73693. }
  73694. declare module BABYLON {
  73695. /**
  73696. * Defines the basic options interface of a SpriteMap
  73697. */
  73698. export interface ISpriteMapOptions {
  73699. /**
  73700. * Vector2 of the number of cells in the grid.
  73701. */
  73702. stageSize?: Vector2;
  73703. /**
  73704. * Vector2 of the size of the output plane in World Units.
  73705. */
  73706. outputSize?: Vector2;
  73707. /**
  73708. * Vector3 of the position of the output plane in World Units.
  73709. */
  73710. outputPosition?: Vector3;
  73711. /**
  73712. * Vector3 of the rotation of the output plane.
  73713. */
  73714. outputRotation?: Vector3;
  73715. /**
  73716. * number of layers that the system will reserve in resources.
  73717. */
  73718. layerCount?: number;
  73719. /**
  73720. * number of max animation frames a single cell will reserve in resources.
  73721. */
  73722. maxAnimationFrames?: number;
  73723. /**
  73724. * number cell index of the base tile when the system compiles.
  73725. */
  73726. baseTile?: number;
  73727. /**
  73728. * boolean flip the sprite after its been repositioned by the framing data.
  73729. */
  73730. flipU?: boolean;
  73731. /**
  73732. * Vector3 scalar of the global RGB values of the SpriteMap.
  73733. */
  73734. colorMultiply?: Vector3;
  73735. }
  73736. /**
  73737. * Defines the IDisposable interface in order to be cleanable from resources.
  73738. */
  73739. export interface ISpriteMap extends IDisposable {
  73740. /**
  73741. * String name of the SpriteMap.
  73742. */
  73743. name: string;
  73744. /**
  73745. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  73746. */
  73747. atlasJSON: ISpriteJSONAtlas;
  73748. /**
  73749. * Texture of the SpriteMap.
  73750. */
  73751. spriteSheet: Texture;
  73752. /**
  73753. * The parameters to initialize the SpriteMap with.
  73754. */
  73755. options: ISpriteMapOptions;
  73756. }
  73757. /**
  73758. * Class used to manage a grid restricted sprite deployment on an Output plane.
  73759. */
  73760. export class SpriteMap implements ISpriteMap {
  73761. /** The Name of the spriteMap */
  73762. name: string;
  73763. /** The JSON file with the frame and meta data */
  73764. atlasJSON: ISpriteJSONAtlas;
  73765. /** The systems Sprite Sheet Texture */
  73766. spriteSheet: Texture;
  73767. /** Arguments passed with the Constructor */
  73768. options: ISpriteMapOptions;
  73769. /** Public Sprite Storage array, parsed from atlasJSON */
  73770. sprites: Array<ISpriteJSONSprite>;
  73771. /** Returns the Number of Sprites in the System */
  73772. get spriteCount(): number;
  73773. /** Returns the Position of Output Plane*/
  73774. get position(): Vector3;
  73775. /** Returns the Position of Output Plane*/
  73776. set position(v: Vector3);
  73777. /** Returns the Rotation of Output Plane*/
  73778. get rotation(): Vector3;
  73779. /** Returns the Rotation of Output Plane*/
  73780. set rotation(v: Vector3);
  73781. /** Sets the AnimationMap*/
  73782. get animationMap(): RawTexture;
  73783. /** Sets the AnimationMap*/
  73784. set animationMap(v: RawTexture);
  73785. /** Scene that the SpriteMap was created in */
  73786. private _scene;
  73787. /** Texture Buffer of Float32 that holds tile frame data*/
  73788. private _frameMap;
  73789. /** Texture Buffers of Float32 that holds tileMap data*/
  73790. private _tileMaps;
  73791. /** Texture Buffer of Float32 that holds Animation Data*/
  73792. private _animationMap;
  73793. /** Custom ShaderMaterial Central to the System*/
  73794. private _material;
  73795. /** Custom ShaderMaterial Central to the System*/
  73796. private _output;
  73797. /** Systems Time Ticker*/
  73798. private _time;
  73799. /**
  73800. * Creates a new SpriteMap
  73801. * @param name defines the SpriteMaps Name
  73802. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  73803. * @param spriteSheet is the Texture that the Sprites are on.
  73804. * @param options a basic deployment configuration
  73805. * @param scene The Scene that the map is deployed on
  73806. */
  73807. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  73808. /**
  73809. * Returns tileID location
  73810. * @returns Vector2 the cell position ID
  73811. */
  73812. getTileID(): Vector2;
  73813. /**
  73814. * Gets the UV location of the mouse over the SpriteMap.
  73815. * @returns Vector2 the UV position of the mouse interaction
  73816. */
  73817. getMousePosition(): Vector2;
  73818. /**
  73819. * Creates the "frame" texture Buffer
  73820. * -------------------------------------
  73821. * Structure of frames
  73822. * "filename": "Falling-Water-2.png",
  73823. * "frame": {"x":69,"y":103,"w":24,"h":32},
  73824. * "rotated": true,
  73825. * "trimmed": true,
  73826. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  73827. * "sourceSize": {"w":32,"h":32}
  73828. * @returns RawTexture of the frameMap
  73829. */
  73830. private _createFrameBuffer;
  73831. /**
  73832. * Creates the tileMap texture Buffer
  73833. * @param buffer normally and array of numbers, or a false to generate from scratch
  73834. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  73835. * @returns RawTexture of the tileMap
  73836. */
  73837. private _createTileBuffer;
  73838. /**
  73839. * Modifies the data of the tileMaps
  73840. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  73841. * @param pos is the iVector2 Coordinates of the Tile
  73842. * @param tile The SpriteIndex of the new Tile
  73843. */
  73844. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  73845. /**
  73846. * Creates the animationMap texture Buffer
  73847. * @param buffer normally and array of numbers, or a false to generate from scratch
  73848. * @returns RawTexture of the animationMap
  73849. */
  73850. private _createTileAnimationBuffer;
  73851. /**
  73852. * Modifies the data of the animationMap
  73853. * @param cellID is the Index of the Sprite
  73854. * @param _frame is the target Animation frame
  73855. * @param toCell is the Target Index of the next frame of the animation
  73856. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  73857. * @param speed is a global scalar of the time variable on the map.
  73858. */
  73859. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  73860. /**
  73861. * Exports the .tilemaps file
  73862. */
  73863. saveTileMaps(): void;
  73864. /**
  73865. * Imports the .tilemaps file
  73866. * @param url of the .tilemaps file
  73867. */
  73868. loadTileMaps(url: string): void;
  73869. /**
  73870. * Release associated resources
  73871. */
  73872. dispose(): void;
  73873. }
  73874. }
  73875. declare module BABYLON {
  73876. /**
  73877. * Class used to manage multiple sprites of different sizes on the same spritesheet
  73878. * @see https://doc.babylonjs.com/babylon101/sprites
  73879. */
  73880. export class SpritePackedManager extends SpriteManager {
  73881. /** defines the packed manager's name */
  73882. name: string;
  73883. /**
  73884. * Creates a new sprite manager from a packed sprite sheet
  73885. * @param name defines the manager's name
  73886. * @param imgUrl defines the sprite sheet url
  73887. * @param capacity defines the maximum allowed number of sprites
  73888. * @param scene defines the hosting scene
  73889. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  73890. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  73891. * @param samplingMode defines the smapling mode to use with spritesheet
  73892. * @param fromPacked set to true; do not alter
  73893. */
  73894. constructor(
  73895. /** defines the packed manager's name */
  73896. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  73897. }
  73898. }
  73899. declare module BABYLON {
  73900. /**
  73901. * Defines the list of states available for a task inside a AssetsManager
  73902. */
  73903. export enum AssetTaskState {
  73904. /**
  73905. * Initialization
  73906. */
  73907. INIT = 0,
  73908. /**
  73909. * Running
  73910. */
  73911. RUNNING = 1,
  73912. /**
  73913. * Done
  73914. */
  73915. DONE = 2,
  73916. /**
  73917. * Error
  73918. */
  73919. ERROR = 3
  73920. }
  73921. /**
  73922. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  73923. */
  73924. export abstract class AbstractAssetTask {
  73925. /**
  73926. * Task name
  73927. */ name: string;
  73928. /**
  73929. * Callback called when the task is successful
  73930. */
  73931. onSuccess: (task: any) => void;
  73932. /**
  73933. * Callback called when the task is not successful
  73934. */
  73935. onError: (task: any, message?: string, exception?: any) => void;
  73936. /**
  73937. * Creates a new AssetsManager
  73938. * @param name defines the name of the task
  73939. */
  73940. constructor(
  73941. /**
  73942. * Task name
  73943. */ name: string);
  73944. private _isCompleted;
  73945. private _taskState;
  73946. private _errorObject;
  73947. /**
  73948. * Get if the task is completed
  73949. */
  73950. get isCompleted(): boolean;
  73951. /**
  73952. * Gets the current state of the task
  73953. */
  73954. get taskState(): AssetTaskState;
  73955. /**
  73956. * Gets the current error object (if task is in error)
  73957. */
  73958. get errorObject(): {
  73959. message?: string;
  73960. exception?: any;
  73961. };
  73962. /**
  73963. * Internal only
  73964. * @hidden
  73965. */
  73966. _setErrorObject(message?: string, exception?: any): void;
  73967. /**
  73968. * Execute the current task
  73969. * @param scene defines the scene where you want your assets to be loaded
  73970. * @param onSuccess is a callback called when the task is successfully executed
  73971. * @param onError is a callback called if an error occurs
  73972. */
  73973. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  73974. /**
  73975. * Execute the current task
  73976. * @param scene defines the scene where you want your assets to be loaded
  73977. * @param onSuccess is a callback called when the task is successfully executed
  73978. * @param onError is a callback called if an error occurs
  73979. */
  73980. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  73981. /**
  73982. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  73983. * This can be used with failed tasks that have the reason for failure fixed.
  73984. */
  73985. reset(): void;
  73986. private onErrorCallback;
  73987. private onDoneCallback;
  73988. }
  73989. /**
  73990. * Define the interface used by progress events raised during assets loading
  73991. */
  73992. export interface IAssetsProgressEvent {
  73993. /**
  73994. * Defines the number of remaining tasks to process
  73995. */
  73996. remainingCount: number;
  73997. /**
  73998. * Defines the total number of tasks
  73999. */
  74000. totalCount: number;
  74001. /**
  74002. * Defines the task that was just processed
  74003. */
  74004. task: AbstractAssetTask;
  74005. }
  74006. /**
  74007. * Class used to share progress information about assets loading
  74008. */
  74009. export class AssetsProgressEvent implements IAssetsProgressEvent {
  74010. /**
  74011. * Defines the number of remaining tasks to process
  74012. */
  74013. remainingCount: number;
  74014. /**
  74015. * Defines the total number of tasks
  74016. */
  74017. totalCount: number;
  74018. /**
  74019. * Defines the task that was just processed
  74020. */
  74021. task: AbstractAssetTask;
  74022. /**
  74023. * Creates a AssetsProgressEvent
  74024. * @param remainingCount defines the number of remaining tasks to process
  74025. * @param totalCount defines the total number of tasks
  74026. * @param task defines the task that was just processed
  74027. */
  74028. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  74029. }
  74030. /**
  74031. * Define a task used by AssetsManager to load assets into a container
  74032. */
  74033. export class ContainerAssetTask extends AbstractAssetTask {
  74034. /**
  74035. * Defines the name of the task
  74036. */
  74037. name: string;
  74038. /**
  74039. * Defines the list of mesh's names you want to load
  74040. */
  74041. meshesNames: any;
  74042. /**
  74043. * Defines the root url to use as a base to load your meshes and associated resources
  74044. */
  74045. rootUrl: string;
  74046. /**
  74047. * Defines the filename or File of the scene to load from
  74048. */
  74049. sceneFilename: string | File;
  74050. /**
  74051. * Get the loaded asset container
  74052. */
  74053. loadedContainer: AssetContainer;
  74054. /**
  74055. * Gets the list of loaded meshes
  74056. */
  74057. loadedMeshes: Array<AbstractMesh>;
  74058. /**
  74059. * Gets the list of loaded particle systems
  74060. */
  74061. loadedParticleSystems: Array<IParticleSystem>;
  74062. /**
  74063. * Gets the list of loaded skeletons
  74064. */
  74065. loadedSkeletons: Array<Skeleton>;
  74066. /**
  74067. * Gets the list of loaded animation groups
  74068. */
  74069. loadedAnimationGroups: Array<AnimationGroup>;
  74070. /**
  74071. * Callback called when the task is successful
  74072. */
  74073. onSuccess: (task: ContainerAssetTask) => void;
  74074. /**
  74075. * Callback called when the task is successful
  74076. */
  74077. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  74078. /**
  74079. * Creates a new ContainerAssetTask
  74080. * @param name defines the name of the task
  74081. * @param meshesNames defines the list of mesh's names you want to load
  74082. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  74083. * @param sceneFilename defines the filename or File of the scene to load from
  74084. */
  74085. constructor(
  74086. /**
  74087. * Defines the name of the task
  74088. */
  74089. name: string,
  74090. /**
  74091. * Defines the list of mesh's names you want to load
  74092. */
  74093. meshesNames: any,
  74094. /**
  74095. * Defines the root url to use as a base to load your meshes and associated resources
  74096. */
  74097. rootUrl: string,
  74098. /**
  74099. * Defines the filename or File of the scene to load from
  74100. */
  74101. sceneFilename: string | File);
  74102. /**
  74103. * Execute the current task
  74104. * @param scene defines the scene where you want your assets to be loaded
  74105. * @param onSuccess is a callback called when the task is successfully executed
  74106. * @param onError is a callback called if an error occurs
  74107. */
  74108. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  74109. }
  74110. /**
  74111. * Define a task used by AssetsManager to load meshes
  74112. */
  74113. export class MeshAssetTask extends AbstractAssetTask {
  74114. /**
  74115. * Defines the name of the task
  74116. */
  74117. name: string;
  74118. /**
  74119. * Defines the list of mesh's names you want to load
  74120. */
  74121. meshesNames: any;
  74122. /**
  74123. * Defines the root url to use as a base to load your meshes and associated resources
  74124. */
  74125. rootUrl: string;
  74126. /**
  74127. * Defines the filename or File of the scene to load from
  74128. */
  74129. sceneFilename: string | File;
  74130. /**
  74131. * Gets the list of loaded meshes
  74132. */
  74133. loadedMeshes: Array<AbstractMesh>;
  74134. /**
  74135. * Gets the list of loaded particle systems
  74136. */
  74137. loadedParticleSystems: Array<IParticleSystem>;
  74138. /**
  74139. * Gets the list of loaded skeletons
  74140. */
  74141. loadedSkeletons: Array<Skeleton>;
  74142. /**
  74143. * Gets the list of loaded animation groups
  74144. */
  74145. loadedAnimationGroups: Array<AnimationGroup>;
  74146. /**
  74147. * Callback called when the task is successful
  74148. */
  74149. onSuccess: (task: MeshAssetTask) => void;
  74150. /**
  74151. * Callback called when the task is successful
  74152. */
  74153. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  74154. /**
  74155. * Creates a new MeshAssetTask
  74156. * @param name defines the name of the task
  74157. * @param meshesNames defines the list of mesh's names you want to load
  74158. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  74159. * @param sceneFilename defines the filename or File of the scene to load from
  74160. */
  74161. constructor(
  74162. /**
  74163. * Defines the name of the task
  74164. */
  74165. name: string,
  74166. /**
  74167. * Defines the list of mesh's names you want to load
  74168. */
  74169. meshesNames: any,
  74170. /**
  74171. * Defines the root url to use as a base to load your meshes and associated resources
  74172. */
  74173. rootUrl: string,
  74174. /**
  74175. * Defines the filename or File of the scene to load from
  74176. */
  74177. sceneFilename: string | File);
  74178. /**
  74179. * Execute the current task
  74180. * @param scene defines the scene where you want your assets to be loaded
  74181. * @param onSuccess is a callback called when the task is successfully executed
  74182. * @param onError is a callback called if an error occurs
  74183. */
  74184. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  74185. }
  74186. /**
  74187. * Define a task used by AssetsManager to load text content
  74188. */
  74189. export class TextFileAssetTask extends AbstractAssetTask {
  74190. /**
  74191. * Defines the name of the task
  74192. */
  74193. name: string;
  74194. /**
  74195. * Defines the location of the file to load
  74196. */
  74197. url: string;
  74198. /**
  74199. * Gets the loaded text string
  74200. */
  74201. text: string;
  74202. /**
  74203. * Callback called when the task is successful
  74204. */
  74205. onSuccess: (task: TextFileAssetTask) => void;
  74206. /**
  74207. * Callback called when the task is successful
  74208. */
  74209. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  74210. /**
  74211. * Creates a new TextFileAssetTask object
  74212. * @param name defines the name of the task
  74213. * @param url defines the location of the file to load
  74214. */
  74215. constructor(
  74216. /**
  74217. * Defines the name of the task
  74218. */
  74219. name: string,
  74220. /**
  74221. * Defines the location of the file to load
  74222. */
  74223. url: string);
  74224. /**
  74225. * Execute the current task
  74226. * @param scene defines the scene where you want your assets to be loaded
  74227. * @param onSuccess is a callback called when the task is successfully executed
  74228. * @param onError is a callback called if an error occurs
  74229. */
  74230. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  74231. }
  74232. /**
  74233. * Define a task used by AssetsManager to load binary data
  74234. */
  74235. export class BinaryFileAssetTask extends AbstractAssetTask {
  74236. /**
  74237. * Defines the name of the task
  74238. */
  74239. name: string;
  74240. /**
  74241. * Defines the location of the file to load
  74242. */
  74243. url: string;
  74244. /**
  74245. * Gets the lodaded data (as an array buffer)
  74246. */
  74247. data: ArrayBuffer;
  74248. /**
  74249. * Callback called when the task is successful
  74250. */
  74251. onSuccess: (task: BinaryFileAssetTask) => void;
  74252. /**
  74253. * Callback called when the task is successful
  74254. */
  74255. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  74256. /**
  74257. * Creates a new BinaryFileAssetTask object
  74258. * @param name defines the name of the new task
  74259. * @param url defines the location of the file to load
  74260. */
  74261. constructor(
  74262. /**
  74263. * Defines the name of the task
  74264. */
  74265. name: string,
  74266. /**
  74267. * Defines the location of the file to load
  74268. */
  74269. url: string);
  74270. /**
  74271. * Execute the current task
  74272. * @param scene defines the scene where you want your assets to be loaded
  74273. * @param onSuccess is a callback called when the task is successfully executed
  74274. * @param onError is a callback called if an error occurs
  74275. */
  74276. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  74277. }
  74278. /**
  74279. * Define a task used by AssetsManager to load images
  74280. */
  74281. export class ImageAssetTask extends AbstractAssetTask {
  74282. /**
  74283. * Defines the name of the task
  74284. */
  74285. name: string;
  74286. /**
  74287. * Defines the location of the image to load
  74288. */
  74289. url: string;
  74290. /**
  74291. * Gets the loaded images
  74292. */
  74293. image: HTMLImageElement;
  74294. /**
  74295. * Callback called when the task is successful
  74296. */
  74297. onSuccess: (task: ImageAssetTask) => void;
  74298. /**
  74299. * Callback called when the task is successful
  74300. */
  74301. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  74302. /**
  74303. * Creates a new ImageAssetTask
  74304. * @param name defines the name of the task
  74305. * @param url defines the location of the image to load
  74306. */
  74307. constructor(
  74308. /**
  74309. * Defines the name of the task
  74310. */
  74311. name: string,
  74312. /**
  74313. * Defines the location of the image to load
  74314. */
  74315. url: string);
  74316. /**
  74317. * Execute the current task
  74318. * @param scene defines the scene where you want your assets to be loaded
  74319. * @param onSuccess is a callback called when the task is successfully executed
  74320. * @param onError is a callback called if an error occurs
  74321. */
  74322. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  74323. }
  74324. /**
  74325. * Defines the interface used by texture loading tasks
  74326. */
  74327. export interface ITextureAssetTask<TEX extends BaseTexture> {
  74328. /**
  74329. * Gets the loaded texture
  74330. */
  74331. texture: TEX;
  74332. }
  74333. /**
  74334. * Define a task used by AssetsManager to load 2D textures
  74335. */
  74336. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  74337. /**
  74338. * Defines the name of the task
  74339. */
  74340. name: string;
  74341. /**
  74342. * Defines the location of the file to load
  74343. */
  74344. url: string;
  74345. /**
  74346. * Defines if mipmap should not be generated (default is false)
  74347. */
  74348. noMipmap?: boolean | undefined;
  74349. /**
  74350. * Defines if texture must be inverted on Y axis (default is true)
  74351. */
  74352. invertY: boolean;
  74353. /**
  74354. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  74355. */
  74356. samplingMode: number;
  74357. /**
  74358. * Gets the loaded texture
  74359. */
  74360. texture: Texture;
  74361. /**
  74362. * Callback called when the task is successful
  74363. */
  74364. onSuccess: (task: TextureAssetTask) => void;
  74365. /**
  74366. * Callback called when the task is successful
  74367. */
  74368. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  74369. /**
  74370. * Creates a new TextureAssetTask object
  74371. * @param name defines the name of the task
  74372. * @param url defines the location of the file to load
  74373. * @param noMipmap defines if mipmap should not be generated (default is false)
  74374. * @param invertY defines if texture must be inverted on Y axis (default is true)
  74375. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  74376. */
  74377. constructor(
  74378. /**
  74379. * Defines the name of the task
  74380. */
  74381. name: string,
  74382. /**
  74383. * Defines the location of the file to load
  74384. */
  74385. url: string,
  74386. /**
  74387. * Defines if mipmap should not be generated (default is false)
  74388. */
  74389. noMipmap?: boolean | undefined,
  74390. /**
  74391. * Defines if texture must be inverted on Y axis (default is true)
  74392. */
  74393. invertY?: boolean,
  74394. /**
  74395. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  74396. */
  74397. samplingMode?: number);
  74398. /**
  74399. * Execute the current task
  74400. * @param scene defines the scene where you want your assets to be loaded
  74401. * @param onSuccess is a callback called when the task is successfully executed
  74402. * @param onError is a callback called if an error occurs
  74403. */
  74404. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  74405. }
  74406. /**
  74407. * Define a task used by AssetsManager to load cube textures
  74408. */
  74409. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  74410. /**
  74411. * Defines the name of the task
  74412. */
  74413. name: string;
  74414. /**
  74415. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  74416. */
  74417. url: string;
  74418. /**
  74419. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  74420. */
  74421. extensions?: string[] | undefined;
  74422. /**
  74423. * Defines if mipmaps should not be generated (default is false)
  74424. */
  74425. noMipmap?: boolean | undefined;
  74426. /**
  74427. * Defines the explicit list of files (undefined by default)
  74428. */
  74429. files?: string[] | undefined;
  74430. /**
  74431. * Gets the loaded texture
  74432. */
  74433. texture: CubeTexture;
  74434. /**
  74435. * Callback called when the task is successful
  74436. */
  74437. onSuccess: (task: CubeTextureAssetTask) => void;
  74438. /**
  74439. * Callback called when the task is successful
  74440. */
  74441. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  74442. /**
  74443. * Creates a new CubeTextureAssetTask
  74444. * @param name defines the name of the task
  74445. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  74446. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  74447. * @param noMipmap defines if mipmaps should not be generated (default is false)
  74448. * @param files defines the explicit list of files (undefined by default)
  74449. */
  74450. constructor(
  74451. /**
  74452. * Defines the name of the task
  74453. */
  74454. name: string,
  74455. /**
  74456. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  74457. */
  74458. url: string,
  74459. /**
  74460. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  74461. */
  74462. extensions?: string[] | undefined,
  74463. /**
  74464. * Defines if mipmaps should not be generated (default is false)
  74465. */
  74466. noMipmap?: boolean | undefined,
  74467. /**
  74468. * Defines the explicit list of files (undefined by default)
  74469. */
  74470. files?: string[] | undefined);
  74471. /**
  74472. * Execute the current task
  74473. * @param scene defines the scene where you want your assets to be loaded
  74474. * @param onSuccess is a callback called when the task is successfully executed
  74475. * @param onError is a callback called if an error occurs
  74476. */
  74477. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  74478. }
  74479. /**
  74480. * Define a task used by AssetsManager to load HDR cube textures
  74481. */
  74482. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  74483. /**
  74484. * Defines the name of the task
  74485. */
  74486. name: string;
  74487. /**
  74488. * Defines the location of the file to load
  74489. */
  74490. url: string;
  74491. /**
  74492. * Defines the desired size (the more it increases the longer the generation will be)
  74493. */
  74494. size: number;
  74495. /**
  74496. * Defines if mipmaps should not be generated (default is false)
  74497. */
  74498. noMipmap: boolean;
  74499. /**
  74500. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  74501. */
  74502. generateHarmonics: boolean;
  74503. /**
  74504. * 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)
  74505. */
  74506. gammaSpace: boolean;
  74507. /**
  74508. * Internal Use Only
  74509. */
  74510. reserved: boolean;
  74511. /**
  74512. * Gets the loaded texture
  74513. */
  74514. texture: HDRCubeTexture;
  74515. /**
  74516. * Callback called when the task is successful
  74517. */
  74518. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  74519. /**
  74520. * Callback called when the task is successful
  74521. */
  74522. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  74523. /**
  74524. * Creates a new HDRCubeTextureAssetTask object
  74525. * @param name defines the name of the task
  74526. * @param url defines the location of the file to load
  74527. * @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.
  74528. * @param noMipmap defines if mipmaps should not be generated (default is false)
  74529. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  74530. * @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)
  74531. * @param reserved Internal use only
  74532. */
  74533. constructor(
  74534. /**
  74535. * Defines the name of the task
  74536. */
  74537. name: string,
  74538. /**
  74539. * Defines the location of the file to load
  74540. */
  74541. url: string,
  74542. /**
  74543. * Defines the desired size (the more it increases the longer the generation will be)
  74544. */
  74545. size: number,
  74546. /**
  74547. * Defines if mipmaps should not be generated (default is false)
  74548. */
  74549. noMipmap?: boolean,
  74550. /**
  74551. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  74552. */
  74553. generateHarmonics?: boolean,
  74554. /**
  74555. * 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)
  74556. */
  74557. gammaSpace?: boolean,
  74558. /**
  74559. * Internal Use Only
  74560. */
  74561. reserved?: boolean);
  74562. /**
  74563. * Execute the current task
  74564. * @param scene defines the scene where you want your assets to be loaded
  74565. * @param onSuccess is a callback called when the task is successfully executed
  74566. * @param onError is a callback called if an error occurs
  74567. */
  74568. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  74569. }
  74570. /**
  74571. * Define a task used by AssetsManager to load Equirectangular cube textures
  74572. */
  74573. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  74574. /**
  74575. * Defines the name of the task
  74576. */
  74577. name: string;
  74578. /**
  74579. * Defines the location of the file to load
  74580. */
  74581. url: string;
  74582. /**
  74583. * Defines the desired size (the more it increases the longer the generation will be)
  74584. */
  74585. size: number;
  74586. /**
  74587. * Defines if mipmaps should not be generated (default is false)
  74588. */
  74589. noMipmap: boolean;
  74590. /**
  74591. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  74592. * but the standard material would require them in Gamma space) (default is true)
  74593. */
  74594. gammaSpace: boolean;
  74595. /**
  74596. * Gets the loaded texture
  74597. */
  74598. texture: EquiRectangularCubeTexture;
  74599. /**
  74600. * Callback called when the task is successful
  74601. */
  74602. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  74603. /**
  74604. * Callback called when the task is successful
  74605. */
  74606. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  74607. /**
  74608. * Creates a new EquiRectangularCubeTextureAssetTask object
  74609. * @param name defines the name of the task
  74610. * @param url defines the location of the file to load
  74611. * @param size defines the desired size (the more it increases the longer the generation will be)
  74612. * If the size is omitted this implies you are using a preprocessed cubemap.
  74613. * @param noMipmap defines if mipmaps should not be generated (default is false)
  74614. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  74615. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  74616. * (default is true)
  74617. */
  74618. constructor(
  74619. /**
  74620. * Defines the name of the task
  74621. */
  74622. name: string,
  74623. /**
  74624. * Defines the location of the file to load
  74625. */
  74626. url: string,
  74627. /**
  74628. * Defines the desired size (the more it increases the longer the generation will be)
  74629. */
  74630. size: number,
  74631. /**
  74632. * Defines if mipmaps should not be generated (default is false)
  74633. */
  74634. noMipmap?: boolean,
  74635. /**
  74636. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  74637. * but the standard material would require them in Gamma space) (default is true)
  74638. */
  74639. gammaSpace?: boolean);
  74640. /**
  74641. * Execute the current task
  74642. * @param scene defines the scene where you want your assets to be loaded
  74643. * @param onSuccess is a callback called when the task is successfully executed
  74644. * @param onError is a callback called if an error occurs
  74645. */
  74646. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  74647. }
  74648. /**
  74649. * This class can be used to easily import assets into a scene
  74650. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  74651. */
  74652. export class AssetsManager {
  74653. private _scene;
  74654. private _isLoading;
  74655. protected _tasks: AbstractAssetTask[];
  74656. protected _waitingTasksCount: number;
  74657. protected _totalTasksCount: number;
  74658. /**
  74659. * Callback called when all tasks are processed
  74660. */
  74661. onFinish: (tasks: AbstractAssetTask[]) => void;
  74662. /**
  74663. * Callback called when a task is successful
  74664. */
  74665. onTaskSuccess: (task: AbstractAssetTask) => void;
  74666. /**
  74667. * Callback called when a task had an error
  74668. */
  74669. onTaskError: (task: AbstractAssetTask) => void;
  74670. /**
  74671. * Callback called when a task is done (whatever the result is)
  74672. */
  74673. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  74674. /**
  74675. * Observable called when all tasks are processed
  74676. */
  74677. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  74678. /**
  74679. * Observable called when a task had an error
  74680. */
  74681. onTaskErrorObservable: Observable<AbstractAssetTask>;
  74682. /**
  74683. * Observable called when all tasks were executed
  74684. */
  74685. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  74686. /**
  74687. * Observable called when a task is done (whatever the result is)
  74688. */
  74689. onProgressObservable: Observable<IAssetsProgressEvent>;
  74690. /**
  74691. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  74692. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  74693. */
  74694. useDefaultLoadingScreen: boolean;
  74695. /**
  74696. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  74697. * when all assets have been downloaded.
  74698. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  74699. */
  74700. autoHideLoadingUI: boolean;
  74701. /**
  74702. * Creates a new AssetsManager
  74703. * @param scene defines the scene to work on
  74704. */
  74705. constructor(scene: Scene);
  74706. /**
  74707. * Add a ContainerAssetTask to the list of active tasks
  74708. * @param taskName defines the name of the new task
  74709. * @param meshesNames defines the name of meshes to load
  74710. * @param rootUrl defines the root url to use to locate files
  74711. * @param sceneFilename defines the filename of the scene file
  74712. * @returns a new ContainerAssetTask object
  74713. */
  74714. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  74715. /**
  74716. * Add a MeshAssetTask to the list of active tasks
  74717. * @param taskName defines the name of the new task
  74718. * @param meshesNames defines the name of meshes to load
  74719. * @param rootUrl defines the root url to use to locate files
  74720. * @param sceneFilename defines the filename of the scene file
  74721. * @returns a new MeshAssetTask object
  74722. */
  74723. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  74724. /**
  74725. * Add a TextFileAssetTask to the list of active tasks
  74726. * @param taskName defines the name of the new task
  74727. * @param url defines the url of the file to load
  74728. * @returns a new TextFileAssetTask object
  74729. */
  74730. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  74731. /**
  74732. * Add a BinaryFileAssetTask to the list of active tasks
  74733. * @param taskName defines the name of the new task
  74734. * @param url defines the url of the file to load
  74735. * @returns a new BinaryFileAssetTask object
  74736. */
  74737. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  74738. /**
  74739. * Add a ImageAssetTask to the list of active tasks
  74740. * @param taskName defines the name of the new task
  74741. * @param url defines the url of the file to load
  74742. * @returns a new ImageAssetTask object
  74743. */
  74744. addImageTask(taskName: string, url: string): ImageAssetTask;
  74745. /**
  74746. * Add a TextureAssetTask to the list of active tasks
  74747. * @param taskName defines the name of the new task
  74748. * @param url defines the url of the file to load
  74749. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  74750. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  74751. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  74752. * @returns a new TextureAssetTask object
  74753. */
  74754. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  74755. /**
  74756. * Add a CubeTextureAssetTask to the list of active tasks
  74757. * @param taskName defines the name of the new task
  74758. * @param url defines the url of the file to load
  74759. * @param extensions defines the extension to use to load the cube map (can be null)
  74760. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  74761. * @param files defines the list of files to load (can be null)
  74762. * @returns a new CubeTextureAssetTask object
  74763. */
  74764. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  74765. /**
  74766. *
  74767. * Add a HDRCubeTextureAssetTask to the list of active tasks
  74768. * @param taskName defines the name of the new task
  74769. * @param url defines the url of the file to load
  74770. * @param size defines the size you want for the cubemap (can be null)
  74771. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  74772. * @param generateHarmonics defines if you want to automatically generate (true by default)
  74773. * @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)
  74774. * @param reserved Internal use only
  74775. * @returns a new HDRCubeTextureAssetTask object
  74776. */
  74777. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  74778. /**
  74779. *
  74780. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  74781. * @param taskName defines the name of the new task
  74782. * @param url defines the url of the file to load
  74783. * @param size defines the size you want for the cubemap (can be null)
  74784. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  74785. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  74786. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  74787. * @returns a new EquiRectangularCubeTextureAssetTask object
  74788. */
  74789. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  74790. /**
  74791. * Remove a task from the assets manager.
  74792. * @param task the task to remove
  74793. */
  74794. removeTask(task: AbstractAssetTask): void;
  74795. private _decreaseWaitingTasksCount;
  74796. private _runTask;
  74797. /**
  74798. * Reset the AssetsManager and remove all tasks
  74799. * @return the current instance of the AssetsManager
  74800. */
  74801. reset(): AssetsManager;
  74802. /**
  74803. * Start the loading process
  74804. * @return the current instance of the AssetsManager
  74805. */
  74806. load(): AssetsManager;
  74807. /**
  74808. * Start the loading process as an async operation
  74809. * @return a promise returning the list of failed tasks
  74810. */
  74811. loadAsync(): Promise<void>;
  74812. }
  74813. }
  74814. declare module BABYLON {
  74815. /**
  74816. * Wrapper class for promise with external resolve and reject.
  74817. */
  74818. export class Deferred<T> {
  74819. /**
  74820. * The promise associated with this deferred object.
  74821. */
  74822. readonly promise: Promise<T>;
  74823. private _resolve;
  74824. private _reject;
  74825. /**
  74826. * The resolve method of the promise associated with this deferred object.
  74827. */
  74828. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  74829. /**
  74830. * The reject method of the promise associated with this deferred object.
  74831. */
  74832. get reject(): (reason?: any) => void;
  74833. /**
  74834. * Constructor for this deferred object.
  74835. */
  74836. constructor();
  74837. }
  74838. }
  74839. declare module BABYLON {
  74840. /**
  74841. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  74842. */
  74843. export class MeshExploder {
  74844. private _centerMesh;
  74845. private _meshes;
  74846. private _meshesOrigins;
  74847. private _toCenterVectors;
  74848. private _scaledDirection;
  74849. private _newPosition;
  74850. private _centerPosition;
  74851. /**
  74852. * Explodes meshes from a center mesh.
  74853. * @param meshes The meshes to explode.
  74854. * @param centerMesh The mesh to be center of explosion.
  74855. */
  74856. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  74857. private _setCenterMesh;
  74858. /**
  74859. * Get class name
  74860. * @returns "MeshExploder"
  74861. */
  74862. getClassName(): string;
  74863. /**
  74864. * "Exploded meshes"
  74865. * @returns Array of meshes with the centerMesh at index 0.
  74866. */
  74867. getMeshes(): Array<Mesh>;
  74868. /**
  74869. * Explodes meshes giving a specific direction
  74870. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  74871. */
  74872. explode(direction?: number): void;
  74873. }
  74874. }
  74875. declare module BABYLON {
  74876. /**
  74877. * Class used to help managing file picking and drag'n'drop
  74878. */
  74879. export class FilesInput {
  74880. /**
  74881. * List of files ready to be loaded
  74882. */
  74883. static get FilesToLoad(): {
  74884. [key: string]: File;
  74885. };
  74886. /**
  74887. * Callback called when a file is processed
  74888. */
  74889. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  74890. private _engine;
  74891. private _currentScene;
  74892. private _sceneLoadedCallback;
  74893. private _progressCallback;
  74894. private _additionalRenderLoopLogicCallback;
  74895. private _textureLoadingCallback;
  74896. private _startingProcessingFilesCallback;
  74897. private _onReloadCallback;
  74898. private _errorCallback;
  74899. private _elementToMonitor;
  74900. private _sceneFileToLoad;
  74901. private _filesToLoad;
  74902. /**
  74903. * Creates a new FilesInput
  74904. * @param engine defines the rendering engine
  74905. * @param scene defines the hosting scene
  74906. * @param sceneLoadedCallback callback called when scene is loaded
  74907. * @param progressCallback callback called to track progress
  74908. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  74909. * @param textureLoadingCallback callback called when a texture is loading
  74910. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  74911. * @param onReloadCallback callback called when a reload is requested
  74912. * @param errorCallback callback call if an error occurs
  74913. */
  74914. constructor(engine: Engine, scene: Nullable<Scene>, sceneLoadedCallback: Nullable<(sceneFile: File, scene: Scene) => void>, progressCallback: Nullable<(progress: ISceneLoaderProgressEvent) => void>, additionalRenderLoopLogicCallback: Nullable<() => void>, textureLoadingCallback: Nullable<(remaining: number) => void>, startingProcessingFilesCallback: Nullable<(files?: File[]) => void>, onReloadCallback: Nullable<(sceneFile: File) => void>, errorCallback: Nullable<(sceneFile: File, scene: Nullable<Scene>, message: string) => void>);
  74915. private _dragEnterHandler;
  74916. private _dragOverHandler;
  74917. private _dropHandler;
  74918. /**
  74919. * Calls this function to listen to drag'n'drop events on a specific DOM element
  74920. * @param elementToMonitor defines the DOM element to track
  74921. */
  74922. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  74923. /** Gets the current list of files to load */
  74924. get filesToLoad(): File[];
  74925. /**
  74926. * Release all associated resources
  74927. */
  74928. dispose(): void;
  74929. private renderFunction;
  74930. private drag;
  74931. private drop;
  74932. private _traverseFolder;
  74933. private _processFiles;
  74934. /**
  74935. * Load files from a drop event
  74936. * @param event defines the drop event to use as source
  74937. */
  74938. loadFiles(event: any): void;
  74939. private _processReload;
  74940. /**
  74941. * Reload the current scene from the loaded files
  74942. */
  74943. reload(): void;
  74944. }
  74945. }
  74946. declare module BABYLON {
  74947. /**
  74948. * Defines the root class used to create scene optimization to use with SceneOptimizer
  74949. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  74950. */
  74951. export class SceneOptimization {
  74952. /**
  74953. * Defines the priority of this optimization (0 by default which means first in the list)
  74954. */
  74955. priority: number;
  74956. /**
  74957. * Gets a string describing the action executed by the current optimization
  74958. * @returns description string
  74959. */
  74960. getDescription(): string;
  74961. /**
  74962. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  74963. * @param scene defines the current scene where to apply this optimization
  74964. * @param optimizer defines the current optimizer
  74965. * @returns true if everything that can be done was applied
  74966. */
  74967. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  74968. /**
  74969. * Creates the SceneOptimization object
  74970. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  74971. * @param desc defines the description associated with the optimization
  74972. */
  74973. constructor(
  74974. /**
  74975. * Defines the priority of this optimization (0 by default which means first in the list)
  74976. */
  74977. priority?: number);
  74978. }
  74979. /**
  74980. * Defines an optimization used to reduce the size of render target textures
  74981. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  74982. */
  74983. export class TextureOptimization extends SceneOptimization {
  74984. /**
  74985. * Defines the priority of this optimization (0 by default which means first in the list)
  74986. */
  74987. priority: number;
  74988. /**
  74989. * 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
  74990. */
  74991. maximumSize: number;
  74992. /**
  74993. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  74994. */
  74995. step: number;
  74996. /**
  74997. * Gets a string describing the action executed by the current optimization
  74998. * @returns description string
  74999. */
  75000. getDescription(): string;
  75001. /**
  75002. * Creates the TextureOptimization object
  75003. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  75004. * @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
  75005. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  75006. */
  75007. constructor(
  75008. /**
  75009. * Defines the priority of this optimization (0 by default which means first in the list)
  75010. */
  75011. priority?: number,
  75012. /**
  75013. * 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
  75014. */
  75015. maximumSize?: number,
  75016. /**
  75017. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  75018. */
  75019. step?: number);
  75020. /**
  75021. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  75022. * @param scene defines the current scene where to apply this optimization
  75023. * @param optimizer defines the current optimizer
  75024. * @returns true if everything that can be done was applied
  75025. */
  75026. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  75027. }
  75028. /**
  75029. * Defines an optimization used to increase or decrease the rendering resolution
  75030. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  75031. */
  75032. export class HardwareScalingOptimization extends SceneOptimization {
  75033. /**
  75034. * Defines the priority of this optimization (0 by default which means first in the list)
  75035. */
  75036. priority: number;
  75037. /**
  75038. * Defines the maximum scale to use (2 by default)
  75039. */
  75040. maximumScale: number;
  75041. /**
  75042. * Defines the step to use between two passes (0.5 by default)
  75043. */
  75044. step: number;
  75045. private _currentScale;
  75046. private _directionOffset;
  75047. /**
  75048. * Gets a string describing the action executed by the current optimization
  75049. * @return description string
  75050. */
  75051. getDescription(): string;
  75052. /**
  75053. * Creates the HardwareScalingOptimization object
  75054. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  75055. * @param maximumScale defines the maximum scale to use (2 by default)
  75056. * @param step defines the step to use between two passes (0.5 by default)
  75057. */
  75058. constructor(
  75059. /**
  75060. * Defines the priority of this optimization (0 by default which means first in the list)
  75061. */
  75062. priority?: number,
  75063. /**
  75064. * Defines the maximum scale to use (2 by default)
  75065. */
  75066. maximumScale?: number,
  75067. /**
  75068. * Defines the step to use between two passes (0.5 by default)
  75069. */
  75070. step?: number);
  75071. /**
  75072. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  75073. * @param scene defines the current scene where to apply this optimization
  75074. * @param optimizer defines the current optimizer
  75075. * @returns true if everything that can be done was applied
  75076. */
  75077. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  75078. }
  75079. /**
  75080. * Defines an optimization used to remove shadows
  75081. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  75082. */
  75083. export class ShadowsOptimization extends SceneOptimization {
  75084. /**
  75085. * Gets a string describing the action executed by the current optimization
  75086. * @return description string
  75087. */
  75088. getDescription(): string;
  75089. /**
  75090. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  75091. * @param scene defines the current scene where to apply this optimization
  75092. * @param optimizer defines the current optimizer
  75093. * @returns true if everything that can be done was applied
  75094. */
  75095. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  75096. }
  75097. /**
  75098. * Defines an optimization used to turn post-processes off
  75099. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  75100. */
  75101. export class PostProcessesOptimization extends SceneOptimization {
  75102. /**
  75103. * Gets a string describing the action executed by the current optimization
  75104. * @return description string
  75105. */
  75106. getDescription(): string;
  75107. /**
  75108. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  75109. * @param scene defines the current scene where to apply this optimization
  75110. * @param optimizer defines the current optimizer
  75111. * @returns true if everything that can be done was applied
  75112. */
  75113. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  75114. }
  75115. /**
  75116. * Defines an optimization used to turn lens flares off
  75117. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  75118. */
  75119. export class LensFlaresOptimization extends SceneOptimization {
  75120. /**
  75121. * Gets a string describing the action executed by the current optimization
  75122. * @return description string
  75123. */
  75124. getDescription(): string;
  75125. /**
  75126. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  75127. * @param scene defines the current scene where to apply this optimization
  75128. * @param optimizer defines the current optimizer
  75129. * @returns true if everything that can be done was applied
  75130. */
  75131. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  75132. }
  75133. /**
  75134. * Defines an optimization based on user defined callback.
  75135. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  75136. */
  75137. export class CustomOptimization extends SceneOptimization {
  75138. /**
  75139. * Callback called to apply the custom optimization.
  75140. */
  75141. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  75142. /**
  75143. * Callback called to get custom description
  75144. */
  75145. onGetDescription: () => string;
  75146. /**
  75147. * Gets a string describing the action executed by the current optimization
  75148. * @returns description string
  75149. */
  75150. getDescription(): string;
  75151. /**
  75152. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  75153. * @param scene defines the current scene where to apply this optimization
  75154. * @param optimizer defines the current optimizer
  75155. * @returns true if everything that can be done was applied
  75156. */
  75157. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  75158. }
  75159. /**
  75160. * Defines an optimization used to turn particles off
  75161. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  75162. */
  75163. export class ParticlesOptimization extends SceneOptimization {
  75164. /**
  75165. * Gets a string describing the action executed by the current optimization
  75166. * @return description string
  75167. */
  75168. getDescription(): string;
  75169. /**
  75170. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  75171. * @param scene defines the current scene where to apply this optimization
  75172. * @param optimizer defines the current optimizer
  75173. * @returns true if everything that can be done was applied
  75174. */
  75175. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  75176. }
  75177. /**
  75178. * Defines an optimization used to turn render targets off
  75179. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  75180. */
  75181. export class RenderTargetsOptimization extends SceneOptimization {
  75182. /**
  75183. * Gets a string describing the action executed by the current optimization
  75184. * @return description string
  75185. */
  75186. getDescription(): string;
  75187. /**
  75188. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  75189. * @param scene defines the current scene where to apply this optimization
  75190. * @param optimizer defines the current optimizer
  75191. * @returns true if everything that can be done was applied
  75192. */
  75193. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  75194. }
  75195. /**
  75196. * Defines an optimization used to merge meshes with compatible materials
  75197. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  75198. */
  75199. export class MergeMeshesOptimization extends SceneOptimization {
  75200. private static _UpdateSelectionTree;
  75201. /**
  75202. * Gets or sets a boolean which defines if optimization octree has to be updated
  75203. */
  75204. static get UpdateSelectionTree(): boolean;
  75205. /**
  75206. * Gets or sets a boolean which defines if optimization octree has to be updated
  75207. */
  75208. static set UpdateSelectionTree(value: boolean);
  75209. /**
  75210. * Gets a string describing the action executed by the current optimization
  75211. * @return description string
  75212. */
  75213. getDescription(): string;
  75214. private _canBeMerged;
  75215. /**
  75216. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  75217. * @param scene defines the current scene where to apply this optimization
  75218. * @param optimizer defines the current optimizer
  75219. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  75220. * @returns true if everything that can be done was applied
  75221. */
  75222. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  75223. }
  75224. /**
  75225. * Defines a list of options used by SceneOptimizer
  75226. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  75227. */
  75228. export class SceneOptimizerOptions {
  75229. /**
  75230. * Defines the target frame rate to reach (60 by default)
  75231. */
  75232. targetFrameRate: number;
  75233. /**
  75234. * Defines the interval between two checkes (2000ms by default)
  75235. */
  75236. trackerDuration: number;
  75237. /**
  75238. * Gets the list of optimizations to apply
  75239. */
  75240. optimizations: SceneOptimization[];
  75241. /**
  75242. * Creates a new list of options used by SceneOptimizer
  75243. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  75244. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  75245. */
  75246. constructor(
  75247. /**
  75248. * Defines the target frame rate to reach (60 by default)
  75249. */
  75250. targetFrameRate?: number,
  75251. /**
  75252. * Defines the interval between two checkes (2000ms by default)
  75253. */
  75254. trackerDuration?: number);
  75255. /**
  75256. * Add a new optimization
  75257. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  75258. * @returns the current SceneOptimizerOptions
  75259. */
  75260. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  75261. /**
  75262. * Add a new custom optimization
  75263. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  75264. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  75265. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  75266. * @returns the current SceneOptimizerOptions
  75267. */
  75268. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  75269. /**
  75270. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  75271. * @param targetFrameRate defines the target frame rate (60 by default)
  75272. * @returns a SceneOptimizerOptions object
  75273. */
  75274. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  75275. /**
  75276. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  75277. * @param targetFrameRate defines the target frame rate (60 by default)
  75278. * @returns a SceneOptimizerOptions object
  75279. */
  75280. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  75281. /**
  75282. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  75283. * @param targetFrameRate defines the target frame rate (60 by default)
  75284. * @returns a SceneOptimizerOptions object
  75285. */
  75286. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  75287. }
  75288. /**
  75289. * Class used to run optimizations in order to reach a target frame rate
  75290. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  75291. */
  75292. export class SceneOptimizer implements IDisposable {
  75293. private _isRunning;
  75294. private _options;
  75295. private _scene;
  75296. private _currentPriorityLevel;
  75297. private _targetFrameRate;
  75298. private _trackerDuration;
  75299. private _currentFrameRate;
  75300. private _sceneDisposeObserver;
  75301. private _improvementMode;
  75302. /**
  75303. * Defines an observable called when the optimizer reaches the target frame rate
  75304. */
  75305. onSuccessObservable: Observable<SceneOptimizer>;
  75306. /**
  75307. * Defines an observable called when the optimizer enables an optimization
  75308. */
  75309. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  75310. /**
  75311. * Defines an observable called when the optimizer is not able to reach the target frame rate
  75312. */
  75313. onFailureObservable: Observable<SceneOptimizer>;
  75314. /**
  75315. * Gets a boolean indicating if the optimizer is in improvement mode
  75316. */
  75317. get isInImprovementMode(): boolean;
  75318. /**
  75319. * Gets the current priority level (0 at start)
  75320. */
  75321. get currentPriorityLevel(): number;
  75322. /**
  75323. * Gets the current frame rate checked by the SceneOptimizer
  75324. */
  75325. get currentFrameRate(): number;
  75326. /**
  75327. * Gets or sets the current target frame rate (60 by default)
  75328. */
  75329. get targetFrameRate(): number;
  75330. /**
  75331. * Gets or sets the current target frame rate (60 by default)
  75332. */
  75333. set targetFrameRate(value: number);
  75334. /**
  75335. * Gets or sets the current interval between two checks (every 2000ms by default)
  75336. */
  75337. get trackerDuration(): number;
  75338. /**
  75339. * Gets or sets the current interval between two checks (every 2000ms by default)
  75340. */
  75341. set trackerDuration(value: number);
  75342. /**
  75343. * Gets the list of active optimizations
  75344. */
  75345. get optimizations(): SceneOptimization[];
  75346. /**
  75347. * Creates a new SceneOptimizer
  75348. * @param scene defines the scene to work on
  75349. * @param options defines the options to use with the SceneOptimizer
  75350. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  75351. * @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)
  75352. */
  75353. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  75354. /**
  75355. * Stops the current optimizer
  75356. */
  75357. stop(): void;
  75358. /**
  75359. * Reset the optimizer to initial step (current priority level = 0)
  75360. */
  75361. reset(): void;
  75362. /**
  75363. * Start the optimizer. By default it will try to reach a specific framerate
  75364. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  75365. */
  75366. start(): void;
  75367. private _checkCurrentState;
  75368. /**
  75369. * Release all resources
  75370. */
  75371. dispose(): void;
  75372. /**
  75373. * Helper function to create a SceneOptimizer with one single line of code
  75374. * @param scene defines the scene to work on
  75375. * @param options defines the options to use with the SceneOptimizer
  75376. * @param onSuccess defines a callback to call on success
  75377. * @param onFailure defines a callback to call on failure
  75378. * @returns the new SceneOptimizer object
  75379. */
  75380. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  75381. }
  75382. }
  75383. declare module BABYLON {
  75384. /**
  75385. * Class used to serialize a scene into a string
  75386. */
  75387. export class SceneSerializer {
  75388. /**
  75389. * Clear cache used by a previous serialization
  75390. */
  75391. static ClearCache(): void;
  75392. /**
  75393. * Serialize a scene into a JSON compatible object
  75394. * @param scene defines the scene to serialize
  75395. * @returns a JSON compatible object
  75396. */
  75397. static Serialize(scene: Scene): any;
  75398. /**
  75399. * Serialize a mesh into a JSON compatible object
  75400. * @param toSerialize defines the mesh to serialize
  75401. * @param withParents defines if parents must be serialized as well
  75402. * @param withChildren defines if children must be serialized as well
  75403. * @returns a JSON compatible object
  75404. */
  75405. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  75406. }
  75407. }
  75408. declare module BABYLON {
  75409. /**
  75410. * Class used to host texture specific utilities
  75411. */
  75412. export class TextureTools {
  75413. /**
  75414. * Uses the GPU to create a copy texture rescaled at a given size
  75415. * @param texture Texture to copy from
  75416. * @param width defines the desired width
  75417. * @param height defines the desired height
  75418. * @param useBilinearMode defines if bilinear mode has to be used
  75419. * @return the generated texture
  75420. */
  75421. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  75422. }
  75423. }
  75424. declare module BABYLON {
  75425. /**
  75426. * This represents the different options available for the video capture.
  75427. */
  75428. export interface VideoRecorderOptions {
  75429. /** Defines the mime type of the video. */
  75430. mimeType: string;
  75431. /** Defines the FPS the video should be recorded at. */
  75432. fps: number;
  75433. /** Defines the chunk size for the recording data. */
  75434. recordChunckSize: number;
  75435. /** The audio tracks to attach to the recording. */
  75436. audioTracks?: MediaStreamTrack[];
  75437. }
  75438. /**
  75439. * This can help with recording videos from BabylonJS.
  75440. * This is based on the available WebRTC functionalities of the browser.
  75441. *
  75442. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  75443. */
  75444. export class VideoRecorder {
  75445. private static readonly _defaultOptions;
  75446. /**
  75447. * Returns whether or not the VideoRecorder is available in your browser.
  75448. * @param engine Defines the Babylon Engine.
  75449. * @returns true if supported otherwise false.
  75450. */
  75451. static IsSupported(engine: Engine): boolean;
  75452. private readonly _options;
  75453. private _canvas;
  75454. private _mediaRecorder;
  75455. private _recordedChunks;
  75456. private _fileName;
  75457. private _resolve;
  75458. private _reject;
  75459. /**
  75460. * True when a recording is already in progress.
  75461. */
  75462. get isRecording(): boolean;
  75463. /**
  75464. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  75465. * @param engine Defines the BabylonJS Engine you wish to record.
  75466. * @param options Defines options that can be used to customize the capture.
  75467. */
  75468. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  75469. /**
  75470. * Stops the current recording before the default capture timeout passed in the startRecording function.
  75471. */
  75472. stopRecording(): void;
  75473. /**
  75474. * Starts recording the canvas for a max duration specified in parameters.
  75475. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  75476. * If null no automatic download will start and you can rely on the promise to get the data back.
  75477. * @param maxDuration Defines the maximum recording time in seconds.
  75478. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  75479. * @return A promise callback at the end of the recording with the video data in Blob.
  75480. */
  75481. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  75482. /**
  75483. * Releases internal resources used during the recording.
  75484. */
  75485. dispose(): void;
  75486. private _handleDataAvailable;
  75487. private _handleError;
  75488. private _handleStop;
  75489. }
  75490. }
  75491. declare module BABYLON {
  75492. /**
  75493. * Class containing a set of static utilities functions for screenshots
  75494. */
  75495. export class ScreenshotTools {
  75496. /**
  75497. * Captures a screenshot of the current rendering
  75498. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  75499. * @param engine defines the rendering engine
  75500. * @param camera defines the source camera
  75501. * @param size This parameter can be set to a single number or to an object with the
  75502. * following (optional) properties: precision, width, height. If a single number is passed,
  75503. * it will be used for both width and height. If an object is passed, the screenshot size
  75504. * will be derived from the parameters. The precision property is a multiplier allowing
  75505. * rendering at a higher or lower resolution
  75506. * @param successCallback defines the callback receives a single parameter which contains the
  75507. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  75508. * src parameter of an <img> to display it
  75509. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  75510. * Check your browser for supported MIME types
  75511. */
  75512. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  75513. /**
  75514. * Captures a screenshot of the current rendering
  75515. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  75516. * @param engine defines the rendering engine
  75517. * @param camera defines the source camera
  75518. * @param size This parameter can be set to a single number or to an object with the
  75519. * following (optional) properties: precision, width, height. If a single number is passed,
  75520. * it will be used for both width and height. If an object is passed, the screenshot size
  75521. * will be derived from the parameters. The precision property is a multiplier allowing
  75522. * rendering at a higher or lower resolution
  75523. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  75524. * Check your browser for supported MIME types
  75525. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  75526. * to the src parameter of an <img> to display it
  75527. */
  75528. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  75529. /**
  75530. * Generates an image screenshot from the specified camera.
  75531. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  75532. * @param engine The engine to use for rendering
  75533. * @param camera The camera to use for rendering
  75534. * @param size This parameter can be set to a single number or to an object with the
  75535. * following (optional) properties: precision, width, height. If a single number is passed,
  75536. * it will be used for both width and height. If an object is passed, the screenshot size
  75537. * will be derived from the parameters. The precision property is a multiplier allowing
  75538. * rendering at a higher or lower resolution
  75539. * @param successCallback The callback receives a single parameter which contains the
  75540. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  75541. * src parameter of an <img> to display it
  75542. * @param mimeType The MIME type of the screenshot image (default: image/png).
  75543. * Check your browser for supported MIME types
  75544. * @param samples Texture samples (default: 1)
  75545. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  75546. * @param fileName A name for for the downloaded file.
  75547. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  75548. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  75549. */
  75550. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean, enableStencilBuffer?: boolean): void;
  75551. /**
  75552. * Generates an image screenshot from the specified camera.
  75553. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  75554. * @param engine The engine to use for rendering
  75555. * @param camera The camera to use for rendering
  75556. * @param size This parameter can be set to a single number or to an object with the
  75557. * following (optional) properties: precision, width, height. If a single number is passed,
  75558. * it will be used for both width and height. If an object is passed, the screenshot size
  75559. * will be derived from the parameters. The precision property is a multiplier allowing
  75560. * rendering at a higher or lower resolution
  75561. * @param mimeType The MIME type of the screenshot image (default: image/png).
  75562. * Check your browser for supported MIME types
  75563. * @param samples Texture samples (default: 1)
  75564. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  75565. * @param fileName A name for for the downloaded file.
  75566. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  75567. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  75568. * to the src parameter of an <img> to display it
  75569. */
  75570. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  75571. /**
  75572. * Gets height and width for screenshot size
  75573. * @private
  75574. */
  75575. private static _getScreenshotSize;
  75576. }
  75577. }
  75578. declare module BABYLON {
  75579. /**
  75580. * Interface for a data buffer
  75581. */
  75582. export interface IDataBuffer {
  75583. /**
  75584. * Reads bytes from the data buffer.
  75585. * @param byteOffset The byte offset to read
  75586. * @param byteLength The byte length to read
  75587. * @returns A promise that resolves when the bytes are read
  75588. */
  75589. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  75590. /**
  75591. * The byte length of the buffer.
  75592. */
  75593. readonly byteLength: number;
  75594. }
  75595. /**
  75596. * Utility class for reading from a data buffer
  75597. */
  75598. export class DataReader {
  75599. /**
  75600. * The data buffer associated with this data reader.
  75601. */
  75602. readonly buffer: IDataBuffer;
  75603. /**
  75604. * The current byte offset from the beginning of the data buffer.
  75605. */
  75606. byteOffset: number;
  75607. private _dataView;
  75608. private _dataByteOffset;
  75609. /**
  75610. * Constructor
  75611. * @param buffer The buffer to read
  75612. */
  75613. constructor(buffer: IDataBuffer);
  75614. /**
  75615. * Loads the given byte length.
  75616. * @param byteLength The byte length to load
  75617. * @returns A promise that resolves when the load is complete
  75618. */
  75619. loadAsync(byteLength: number): Promise<void>;
  75620. /**
  75621. * Read a unsigned 32-bit integer from the currently loaded data range.
  75622. * @returns The 32-bit integer read
  75623. */
  75624. readUint32(): number;
  75625. /**
  75626. * Read a byte array from the currently loaded data range.
  75627. * @param byteLength The byte length to read
  75628. * @returns The byte array read
  75629. */
  75630. readUint8Array(byteLength: number): Uint8Array;
  75631. /**
  75632. * Read a string from the currently loaded data range.
  75633. * @param byteLength The byte length to read
  75634. * @returns The string read
  75635. */
  75636. readString(byteLength: number): string;
  75637. /**
  75638. * Skips the given byte length the currently loaded data range.
  75639. * @param byteLength The byte length to skip
  75640. */
  75641. skipBytes(byteLength: number): void;
  75642. }
  75643. }
  75644. declare module BABYLON {
  75645. /**
  75646. * Class for storing data to local storage if available or in-memory storage otherwise
  75647. */
  75648. export class DataStorage {
  75649. private static _Storage;
  75650. private static _GetStorage;
  75651. /**
  75652. * Reads a string from the data storage
  75653. * @param key The key to read
  75654. * @param defaultValue The value if the key doesn't exist
  75655. * @returns The string value
  75656. */
  75657. static ReadString(key: string, defaultValue: string): string;
  75658. /**
  75659. * Writes a string to the data storage
  75660. * @param key The key to write
  75661. * @param value The value to write
  75662. */
  75663. static WriteString(key: string, value: string): void;
  75664. /**
  75665. * Reads a boolean from the data storage
  75666. * @param key The key to read
  75667. * @param defaultValue The value if the key doesn't exist
  75668. * @returns The boolean value
  75669. */
  75670. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  75671. /**
  75672. * Writes a boolean to the data storage
  75673. * @param key The key to write
  75674. * @param value The value to write
  75675. */
  75676. static WriteBoolean(key: string, value: boolean): void;
  75677. /**
  75678. * Reads a number from the data storage
  75679. * @param key The key to read
  75680. * @param defaultValue The value if the key doesn't exist
  75681. * @returns The number value
  75682. */
  75683. static ReadNumber(key: string, defaultValue: number): number;
  75684. /**
  75685. * Writes a number to the data storage
  75686. * @param key The key to write
  75687. * @param value The value to write
  75688. */
  75689. static WriteNumber(key: string, value: number): void;
  75690. }
  75691. }
  75692. declare module BABYLON {
  75693. /**
  75694. * Class used to record delta files between 2 scene states
  75695. */
  75696. export class SceneRecorder {
  75697. private _trackedScene;
  75698. private _savedJSON;
  75699. /**
  75700. * Track a given scene. This means the current scene state will be considered the original state
  75701. * @param scene defines the scene to track
  75702. */
  75703. track(scene: Scene): void;
  75704. /**
  75705. * Get the delta between current state and original state
  75706. * @returns a string containing the delta
  75707. */
  75708. getDelta(): any;
  75709. private _compareArray;
  75710. private _compareObjects;
  75711. private _compareCollections;
  75712. private static GetShadowGeneratorById;
  75713. /**
  75714. * Apply a given delta to a given scene
  75715. * @param deltaJSON defines the JSON containing the delta
  75716. * @param scene defines the scene to apply the delta to
  75717. */
  75718. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  75719. private static _ApplyPropertiesToEntity;
  75720. private static _ApplyDeltaForEntity;
  75721. }
  75722. }
  75723. declare module BABYLON {
  75724. /**
  75725. * A 3D trajectory consisting of an order list of vectors describing a
  75726. * path of motion through 3D space.
  75727. */
  75728. export class Trajectory {
  75729. private _points;
  75730. private readonly _segmentLength;
  75731. /**
  75732. * Serialize to JSON.
  75733. * @returns serialized JSON string
  75734. */
  75735. serialize(): string;
  75736. /**
  75737. * Deserialize from JSON.
  75738. * @param json serialized JSON string
  75739. * @returns deserialized Trajectory
  75740. */
  75741. static Deserialize(json: string): Trajectory;
  75742. /**
  75743. * Create a new empty Trajectory.
  75744. * @param segmentLength radius of discretization for Trajectory points
  75745. */
  75746. constructor(segmentLength?: number);
  75747. /**
  75748. * Get the length of the Trajectory.
  75749. * @returns length of the Trajectory
  75750. */
  75751. getLength(): number;
  75752. /**
  75753. * Append a new point to the Trajectory.
  75754. * NOTE: This implementation has many allocations.
  75755. * @param point point to append to the Trajectory
  75756. */
  75757. add(point: DeepImmutable<Vector3>): void;
  75758. /**
  75759. * Create a new Trajectory with a segment length chosen to make it
  75760. * probable that the new Trajectory will have a specified number of
  75761. * segments. This operation is imprecise.
  75762. * @param targetResolution number of segments desired
  75763. * @returns new Trajectory with approximately the requested number of segments
  75764. */
  75765. resampleAtTargetResolution(targetResolution: number): Trajectory;
  75766. /**
  75767. * Convert Trajectory segments into tokenized representation. This
  75768. * representation is an array of numbers where each nth number is the
  75769. * index of the token which is most similar to the nth segment of the
  75770. * Trajectory.
  75771. * @param tokens list of vectors which serve as discrete tokens
  75772. * @returns list of indices of most similar token per segment
  75773. */
  75774. tokenize(tokens: DeepImmutable<Vector3[]>): number[];
  75775. private static _forwardDir;
  75776. private static _inverseFromVec;
  75777. private static _upDir;
  75778. private static _fromToVec;
  75779. private static _lookMatrix;
  75780. /**
  75781. * Transform the rotation (i.e., direction) of a segment to isolate
  75782. * the relative transformation represented by the segment. This operation
  75783. * may or may not succeed due to singularities in the equations that define
  75784. * motion relativity in this context.
  75785. * @param priorVec the origin of the prior segment
  75786. * @param fromVec the origin of the current segment
  75787. * @param toVec the destination of the current segment
  75788. * @param result reference to output variable
  75789. * @returns whether or not transformation was successful
  75790. */
  75791. private static _transformSegmentDirToRef;
  75792. private static _bestMatch;
  75793. private static _score;
  75794. private static _bestScore;
  75795. /**
  75796. * Determine which token vector is most similar to the
  75797. * segment vector.
  75798. * @param segment segment vector
  75799. * @param tokens token vector list
  75800. * @returns index of the most similar token to the segment
  75801. */
  75802. private static _tokenizeSegment;
  75803. }
  75804. /**
  75805. * Class representing a set of known, named trajectories to which Trajectories can be
  75806. * added and using which Trajectories can be recognized.
  75807. */
  75808. export class TrajectoryClassifier {
  75809. private _maximumAllowableMatchCost;
  75810. private _vector3Alphabet;
  75811. private _levenshteinAlphabet;
  75812. private _nameToDescribedTrajectory;
  75813. /**
  75814. * Serialize to JSON.
  75815. * @returns JSON serialization
  75816. */
  75817. serialize(): string;
  75818. /**
  75819. * Deserialize from JSON.
  75820. * @param json JSON serialization
  75821. * @returns deserialized TrajectorySet
  75822. */
  75823. static Deserialize(json: string): TrajectoryClassifier;
  75824. /**
  75825. * Initialize a new empty TrajectorySet with auto-generated Alphabets.
  75826. * VERY naive, need to be generating these things from known
  75827. * sets. Better version later, probably eliminating this one.
  75828. * @returns auto-generated TrajectorySet
  75829. */
  75830. static Generate(): TrajectoryClassifier;
  75831. private constructor();
  75832. /**
  75833. * Add a new Trajectory to the set with a given name.
  75834. * @param trajectory new Trajectory to be added
  75835. * @param classification name to which to add the Trajectory
  75836. */
  75837. addTrajectoryToClassification(trajectory: Trajectory, classification: string): void;
  75838. /**
  75839. * Remove a known named trajectory and all Trajectories associated with it.
  75840. * @param classification name to remove
  75841. * @returns whether anything was removed
  75842. */
  75843. deleteClassification(classification: string): boolean;
  75844. /**
  75845. * Attempt to recognize a Trajectory from among all the classifications
  75846. * already known to the classifier.
  75847. * @param trajectory Trajectory to be recognized
  75848. * @returns classification of Trajectory if recognized, null otherwise
  75849. */
  75850. classifyTrajectory(trajectory: Trajectory): Nullable<string>;
  75851. }
  75852. }
  75853. declare module BABYLON {
  75854. /**
  75855. * An interface for all Hit test features
  75856. */
  75857. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  75858. /**
  75859. * Triggered when new babylon (transformed) hit test results are available
  75860. */
  75861. onHitTestResultObservable: Observable<T[]>;
  75862. }
  75863. /**
  75864. * Options used for hit testing
  75865. */
  75866. export interface IWebXRLegacyHitTestOptions {
  75867. /**
  75868. * Only test when user interacted with the scene. Default - hit test every frame
  75869. */
  75870. testOnPointerDownOnly?: boolean;
  75871. /**
  75872. * The node to use to transform the local results to world coordinates
  75873. */
  75874. worldParentNode?: TransformNode;
  75875. }
  75876. /**
  75877. * Interface defining the babylon result of raycasting/hit-test
  75878. */
  75879. export interface IWebXRLegacyHitResult {
  75880. /**
  75881. * Transformation matrix that can be applied to a node that will put it in the hit point location
  75882. */
  75883. transformationMatrix: Matrix;
  75884. /**
  75885. * The native hit test result
  75886. */
  75887. xrHitResult: XRHitResult | XRHitTestResult;
  75888. }
  75889. /**
  75890. * The currently-working hit-test module.
  75891. * Hit test (or Ray-casting) is used to interact with the real world.
  75892. * For further information read here - https://github.com/immersive-web/hit-test
  75893. */
  75894. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  75895. /**
  75896. * options to use when constructing this feature
  75897. */
  75898. readonly options: IWebXRLegacyHitTestOptions;
  75899. private _direction;
  75900. private _mat;
  75901. private _onSelectEnabled;
  75902. private _origin;
  75903. /**
  75904. * The module's name
  75905. */
  75906. static readonly Name: string;
  75907. /**
  75908. * The (Babylon) version of this module.
  75909. * This is an integer representing the implementation version.
  75910. * This number does not correspond to the WebXR specs version
  75911. */
  75912. static readonly Version: number;
  75913. /**
  75914. * Populated with the last native XR Hit Results
  75915. */
  75916. lastNativeXRHitResults: XRHitResult[];
  75917. /**
  75918. * Triggered when new babylon (transformed) hit test results are available
  75919. */
  75920. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  75921. /**
  75922. * Creates a new instance of the (legacy version) hit test feature
  75923. * @param _xrSessionManager an instance of WebXRSessionManager
  75924. * @param options options to use when constructing this feature
  75925. */
  75926. constructor(_xrSessionManager: WebXRSessionManager,
  75927. /**
  75928. * options to use when constructing this feature
  75929. */
  75930. options?: IWebXRLegacyHitTestOptions);
  75931. /**
  75932. * execute a hit test with an XR Ray
  75933. *
  75934. * @param xrSession a native xrSession that will execute this hit test
  75935. * @param xrRay the ray (position and direction) to use for ray-casting
  75936. * @param referenceSpace native XR reference space to use for the hit-test
  75937. * @param filter filter function that will filter the results
  75938. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  75939. */
  75940. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  75941. /**
  75942. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  75943. * @param event the (select) event to use to select with
  75944. * @param referenceSpace the reference space to use for this hit test
  75945. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  75946. */
  75947. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  75948. /**
  75949. * attach this feature
  75950. * Will usually be called by the features manager
  75951. *
  75952. * @returns true if successful.
  75953. */
  75954. attach(): boolean;
  75955. /**
  75956. * detach this feature.
  75957. * Will usually be called by the features manager
  75958. *
  75959. * @returns true if successful.
  75960. */
  75961. detach(): boolean;
  75962. /**
  75963. * Dispose this feature and all of the resources attached
  75964. */
  75965. dispose(): void;
  75966. protected _onXRFrame(frame: XRFrame): void;
  75967. private _onHitTestResults;
  75968. private _onSelect;
  75969. }
  75970. }
  75971. declare module BABYLON {
  75972. /**
  75973. * Options used for hit testing (version 2)
  75974. */
  75975. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  75976. /**
  75977. * Do not create a permanent hit test. Will usually be used when only
  75978. * transient inputs are needed.
  75979. */
  75980. disablePermanentHitTest?: boolean;
  75981. /**
  75982. * Enable transient (for example touch-based) hit test inspections
  75983. */
  75984. enableTransientHitTest?: boolean;
  75985. /**
  75986. * Offset ray for the permanent hit test
  75987. */
  75988. offsetRay?: Vector3;
  75989. /**
  75990. * Offset ray for the transient hit test
  75991. */
  75992. transientOffsetRay?: Vector3;
  75993. /**
  75994. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  75995. */
  75996. useReferenceSpace?: boolean;
  75997. /**
  75998. * Override the default entity type(s) of the hit-test result
  75999. */
  76000. entityTypes?: XRHitTestTrackableType[];
  76001. }
  76002. /**
  76003. * Interface defining the babylon result of hit-test
  76004. */
  76005. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  76006. /**
  76007. * The input source that generated this hit test (if transient)
  76008. */
  76009. inputSource?: XRInputSource;
  76010. /**
  76011. * Is this a transient hit test
  76012. */
  76013. isTransient?: boolean;
  76014. /**
  76015. * Position of the hit test result
  76016. */
  76017. position: Vector3;
  76018. /**
  76019. * Rotation of the hit test result
  76020. */
  76021. rotationQuaternion: Quaternion;
  76022. /**
  76023. * The native hit test result
  76024. */
  76025. xrHitResult: XRHitTestResult;
  76026. }
  76027. /**
  76028. * The currently-working hit-test module.
  76029. * Hit test (or Ray-casting) is used to interact with the real world.
  76030. * For further information read here - https://github.com/immersive-web/hit-test
  76031. *
  76032. * Tested on chrome (mobile) 80.
  76033. */
  76034. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  76035. /**
  76036. * options to use when constructing this feature
  76037. */
  76038. readonly options: IWebXRHitTestOptions;
  76039. private _tmpMat;
  76040. private _tmpPos;
  76041. private _tmpQuat;
  76042. private _transientXrHitTestSource;
  76043. private _xrHitTestSource;
  76044. private initHitTestSource;
  76045. /**
  76046. * The module's name
  76047. */
  76048. static readonly Name: string;
  76049. /**
  76050. * The (Babylon) version of this module.
  76051. * This is an integer representing the implementation version.
  76052. * This number does not correspond to the WebXR specs version
  76053. */
  76054. static readonly Version: number;
  76055. /**
  76056. * When set to true, each hit test will have its own position/rotation objects
  76057. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  76058. * the developers will clone them or copy them as they see fit.
  76059. */
  76060. autoCloneTransformation: boolean;
  76061. /**
  76062. * Triggered when new babylon (transformed) hit test results are available
  76063. * Note - this will be called when results come back from the device. It can be an empty array!!
  76064. */
  76065. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  76066. /**
  76067. * Use this to temporarily pause hit test checks.
  76068. */
  76069. paused: boolean;
  76070. /**
  76071. * Creates a new instance of the hit test feature
  76072. * @param _xrSessionManager an instance of WebXRSessionManager
  76073. * @param options options to use when constructing this feature
  76074. */
  76075. constructor(_xrSessionManager: WebXRSessionManager,
  76076. /**
  76077. * options to use when constructing this feature
  76078. */
  76079. options?: IWebXRHitTestOptions);
  76080. /**
  76081. * attach this feature
  76082. * Will usually be called by the features manager
  76083. *
  76084. * @returns true if successful.
  76085. */
  76086. attach(): boolean;
  76087. /**
  76088. * detach this feature.
  76089. * Will usually be called by the features manager
  76090. *
  76091. * @returns true if successful.
  76092. */
  76093. detach(): boolean;
  76094. /**
  76095. * Dispose this feature and all of the resources attached
  76096. */
  76097. dispose(): void;
  76098. protected _onXRFrame(frame: XRFrame): void;
  76099. private _processWebXRHitTestResult;
  76100. }
  76101. }
  76102. declare module BABYLON {
  76103. /**
  76104. * Configuration options of the anchor system
  76105. */
  76106. export interface IWebXRAnchorSystemOptions {
  76107. /**
  76108. * a node that will be used to convert local to world coordinates
  76109. */
  76110. worldParentNode?: TransformNode;
  76111. /**
  76112. * If set to true a reference of the created anchors will be kept until the next session starts
  76113. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  76114. */
  76115. doNotRemoveAnchorsOnSessionEnded?: boolean;
  76116. }
  76117. /**
  76118. * A babylon container for an XR Anchor
  76119. */
  76120. export interface IWebXRAnchor {
  76121. /**
  76122. * A babylon-assigned ID for this anchor
  76123. */
  76124. id: number;
  76125. /**
  76126. * Transformation matrix to apply to an object attached to this anchor
  76127. */
  76128. transformationMatrix: Matrix;
  76129. /**
  76130. * The native anchor object
  76131. */
  76132. xrAnchor: XRAnchor;
  76133. /**
  76134. * if defined, this object will be constantly updated by the anchor's position and rotation
  76135. */
  76136. attachedNode?: TransformNode;
  76137. /**
  76138. * Remove this anchor from the scene
  76139. */
  76140. remove(): void;
  76141. }
  76142. /**
  76143. * An implementation of the anchor system for WebXR.
  76144. * For further information see https://github.com/immersive-web/anchors/
  76145. */
  76146. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  76147. private _options;
  76148. private _lastFrameDetected;
  76149. private _trackedAnchors;
  76150. private _referenceSpaceForFrameAnchors;
  76151. private _futureAnchors;
  76152. /**
  76153. * The module's name
  76154. */
  76155. static readonly Name: string;
  76156. /**
  76157. * The (Babylon) version of this module.
  76158. * This is an integer representing the implementation version.
  76159. * This number does not correspond to the WebXR specs version
  76160. */
  76161. static readonly Version: number;
  76162. /**
  76163. * Observers registered here will be executed when a new anchor was added to the session
  76164. */
  76165. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  76166. /**
  76167. * Observers registered here will be executed when an anchor was removed from the session
  76168. */
  76169. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  76170. /**
  76171. * Observers registered here will be executed when an existing anchor updates
  76172. * This can execute N times every frame
  76173. */
  76174. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  76175. /**
  76176. * Set the reference space to use for anchor creation, when not using a hit test.
  76177. * Will default to the session's reference space if not defined
  76178. */
  76179. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  76180. /**
  76181. * constructs a new anchor system
  76182. * @param _xrSessionManager an instance of WebXRSessionManager
  76183. * @param _options configuration object for this feature
  76184. */
  76185. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  76186. private _tmpVector;
  76187. private _tmpQuaternion;
  76188. private _populateTmpTransformation;
  76189. /**
  76190. * Create a new anchor point using a hit test result at a specific point in the scene
  76191. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  76192. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  76193. *
  76194. * @param hitTestResult The hit test result to use for this anchor creation
  76195. * @param position an optional position offset for this anchor
  76196. * @param rotationQuaternion an optional rotation offset for this anchor
  76197. * @returns A promise that fulfills when babylon has created the corresponding WebXRAnchor object and tracking has begun
  76198. */
  76199. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<IWebXRAnchor>;
  76200. /**
  76201. * Add a new anchor at a specific position and rotation
  76202. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  76203. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  76204. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  76205. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  76206. *
  76207. * @param position the position in which to add an anchor
  76208. * @param rotationQuaternion an optional rotation for the anchor transformation
  76209. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  76210. * @returns A promise that fulfills when babylon has created the corresponding WebXRAnchor object and tracking has begun
  76211. */
  76212. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<IWebXRAnchor>;
  76213. /**
  76214. * Get the list of anchors currently being tracked by the system
  76215. */
  76216. get anchors(): IWebXRAnchor[];
  76217. /**
  76218. * detach this feature.
  76219. * Will usually be called by the features manager
  76220. *
  76221. * @returns true if successful.
  76222. */
  76223. detach(): boolean;
  76224. /**
  76225. * Dispose this feature and all of the resources attached
  76226. */
  76227. dispose(): void;
  76228. protected _onXRFrame(frame: XRFrame): void;
  76229. /**
  76230. * avoiding using Array.find for global support.
  76231. * @param xrAnchor the plane to find in the array
  76232. */
  76233. private _findIndexInAnchorArray;
  76234. private _updateAnchorWithXRFrame;
  76235. private _createAnchorAtTransformation;
  76236. }
  76237. }
  76238. declare module BABYLON {
  76239. /**
  76240. * Options used in the plane detector module
  76241. */
  76242. export interface IWebXRPlaneDetectorOptions {
  76243. /**
  76244. * The node to use to transform the local results to world coordinates
  76245. */
  76246. worldParentNode?: TransformNode;
  76247. /**
  76248. * If set to true a reference of the created planes will be kept until the next session starts
  76249. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  76250. */
  76251. doNotRemovePlanesOnSessionEnded?: boolean;
  76252. }
  76253. /**
  76254. * A babylon interface for a WebXR plane.
  76255. * A Plane is actually a polygon, built from N points in space
  76256. *
  76257. * Supported in chrome 79, not supported in canary 81 ATM
  76258. */
  76259. export interface IWebXRPlane {
  76260. /**
  76261. * a babylon-assigned ID for this polygon
  76262. */
  76263. id: number;
  76264. /**
  76265. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  76266. */
  76267. polygonDefinition: Array<Vector3>;
  76268. /**
  76269. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  76270. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  76271. */
  76272. transformationMatrix: Matrix;
  76273. /**
  76274. * the native xr-plane object
  76275. */
  76276. xrPlane: XRPlane;
  76277. }
  76278. /**
  76279. * The plane detector is used to detect planes in the real world when in AR
  76280. * For more information see https://github.com/immersive-web/real-world-geometry/
  76281. */
  76282. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  76283. private _options;
  76284. private _detectedPlanes;
  76285. private _enabled;
  76286. private _lastFrameDetected;
  76287. /**
  76288. * The module's name
  76289. */
  76290. static readonly Name: string;
  76291. /**
  76292. * The (Babylon) version of this module.
  76293. * This is an integer representing the implementation version.
  76294. * This number does not correspond to the WebXR specs version
  76295. */
  76296. static readonly Version: number;
  76297. /**
  76298. * Observers registered here will be executed when a new plane was added to the session
  76299. */
  76300. onPlaneAddedObservable: Observable<IWebXRPlane>;
  76301. /**
  76302. * Observers registered here will be executed when a plane is no longer detected in the session
  76303. */
  76304. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  76305. /**
  76306. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  76307. * This can execute N times every frame
  76308. */
  76309. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  76310. /**
  76311. * construct a new Plane Detector
  76312. * @param _xrSessionManager an instance of xr Session manager
  76313. * @param _options configuration to use when constructing this feature
  76314. */
  76315. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  76316. /**
  76317. * detach this feature.
  76318. * Will usually be called by the features manager
  76319. *
  76320. * @returns true if successful.
  76321. */
  76322. detach(): boolean;
  76323. /**
  76324. * Dispose this feature and all of the resources attached
  76325. */
  76326. dispose(): void;
  76327. /**
  76328. * Check if the needed objects are defined.
  76329. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  76330. */
  76331. isCompatible(): boolean;
  76332. protected _onXRFrame(frame: XRFrame): void;
  76333. private _init;
  76334. private _updatePlaneWithXRPlane;
  76335. /**
  76336. * avoiding using Array.find for global support.
  76337. * @param xrPlane the plane to find in the array
  76338. */
  76339. private findIndexInPlaneArray;
  76340. }
  76341. }
  76342. declare module BABYLON {
  76343. /**
  76344. * Options interface for the background remover plugin
  76345. */
  76346. export interface IWebXRBackgroundRemoverOptions {
  76347. /**
  76348. * Further background meshes to disable when entering AR
  76349. */
  76350. backgroundMeshes?: AbstractMesh[];
  76351. /**
  76352. * flags to configure the removal of the environment helper.
  76353. * If not set, the entire background will be removed. If set, flags should be set as well.
  76354. */
  76355. environmentHelperRemovalFlags?: {
  76356. /**
  76357. * Should the skybox be removed (default false)
  76358. */
  76359. skyBox?: boolean;
  76360. /**
  76361. * Should the ground be removed (default false)
  76362. */
  76363. ground?: boolean;
  76364. };
  76365. /**
  76366. * don't disable the environment helper
  76367. */
  76368. ignoreEnvironmentHelper?: boolean;
  76369. }
  76370. /**
  76371. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  76372. */
  76373. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  76374. /**
  76375. * read-only options to be used in this module
  76376. */
  76377. readonly options: IWebXRBackgroundRemoverOptions;
  76378. /**
  76379. * The module's name
  76380. */
  76381. static readonly Name: string;
  76382. /**
  76383. * The (Babylon) version of this module.
  76384. * This is an integer representing the implementation version.
  76385. * This number does not correspond to the WebXR specs version
  76386. */
  76387. static readonly Version: number;
  76388. /**
  76389. * registered observers will be triggered when the background state changes
  76390. */
  76391. onBackgroundStateChangedObservable: Observable<boolean>;
  76392. /**
  76393. * constructs a new background remover module
  76394. * @param _xrSessionManager the session manager for this module
  76395. * @param options read-only options to be used in this module
  76396. */
  76397. constructor(_xrSessionManager: WebXRSessionManager,
  76398. /**
  76399. * read-only options to be used in this module
  76400. */
  76401. options?: IWebXRBackgroundRemoverOptions);
  76402. /**
  76403. * attach this feature
  76404. * Will usually be called by the features manager
  76405. *
  76406. * @returns true if successful.
  76407. */
  76408. attach(): boolean;
  76409. /**
  76410. * detach this feature.
  76411. * Will usually be called by the features manager
  76412. *
  76413. * @returns true if successful.
  76414. */
  76415. detach(): boolean;
  76416. /**
  76417. * Dispose this feature and all of the resources attached
  76418. */
  76419. dispose(): void;
  76420. protected _onXRFrame(_xrFrame: XRFrame): void;
  76421. private _setBackgroundState;
  76422. }
  76423. }
  76424. declare module BABYLON {
  76425. /**
  76426. * Options for the controller physics feature
  76427. */
  76428. export class IWebXRControllerPhysicsOptions {
  76429. /**
  76430. * Should the headset get its own impostor
  76431. */
  76432. enableHeadsetImpostor?: boolean;
  76433. /**
  76434. * Optional parameters for the headset impostor
  76435. */
  76436. headsetImpostorParams?: {
  76437. /**
  76438. * The type of impostor to create. Default is sphere
  76439. */
  76440. impostorType: number;
  76441. /**
  76442. * the size of the impostor. Defaults to 10cm
  76443. */
  76444. impostorSize?: number | {
  76445. width: number;
  76446. height: number;
  76447. depth: number;
  76448. };
  76449. /**
  76450. * Friction definitions
  76451. */
  76452. friction?: number;
  76453. /**
  76454. * Restitution
  76455. */
  76456. restitution?: number;
  76457. };
  76458. /**
  76459. * The physics properties of the future impostors
  76460. */
  76461. physicsProperties?: {
  76462. /**
  76463. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  76464. * Note that this requires a physics engine that supports mesh impostors!
  76465. */
  76466. useControllerMesh?: boolean;
  76467. /**
  76468. * The type of impostor to create. Default is sphere
  76469. */
  76470. impostorType?: number;
  76471. /**
  76472. * the size of the impostor. Defaults to 10cm
  76473. */
  76474. impostorSize?: number | {
  76475. width: number;
  76476. height: number;
  76477. depth: number;
  76478. };
  76479. /**
  76480. * Friction definitions
  76481. */
  76482. friction?: number;
  76483. /**
  76484. * Restitution
  76485. */
  76486. restitution?: number;
  76487. };
  76488. /**
  76489. * the xr input to use with this pointer selection
  76490. */
  76491. xrInput: WebXRInput;
  76492. }
  76493. /**
  76494. * Add physics impostor to your webxr controllers,
  76495. * including naive calculation of their linear and angular velocity
  76496. */
  76497. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  76498. private readonly _options;
  76499. private _attachController;
  76500. private _controllers;
  76501. private _debugMode;
  76502. private _delta;
  76503. private _headsetImpostor?;
  76504. private _headsetMesh?;
  76505. private _lastTimestamp;
  76506. private _tmpQuaternion;
  76507. private _tmpVector;
  76508. /**
  76509. * The module's name
  76510. */
  76511. static readonly Name: string;
  76512. /**
  76513. * The (Babylon) version of this module.
  76514. * This is an integer representing the implementation version.
  76515. * This number does not correspond to the webxr specs version
  76516. */
  76517. static readonly Version: number;
  76518. /**
  76519. * Construct a new Controller Physics Feature
  76520. * @param _xrSessionManager the corresponding xr session manager
  76521. * @param _options options to create this feature with
  76522. */
  76523. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  76524. /**
  76525. * @hidden
  76526. * enable debugging - will show console outputs and the impostor mesh
  76527. */
  76528. _enablePhysicsDebug(): void;
  76529. /**
  76530. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  76531. * @param xrController the controller to add
  76532. */
  76533. addController(xrController: WebXRInputSource): void;
  76534. /**
  76535. * attach this feature
  76536. * Will usually be called by the features manager
  76537. *
  76538. * @returns true if successful.
  76539. */
  76540. attach(): boolean;
  76541. /**
  76542. * detach this feature.
  76543. * Will usually be called by the features manager
  76544. *
  76545. * @returns true if successful.
  76546. */
  76547. detach(): boolean;
  76548. /**
  76549. * Get the headset impostor, if enabled
  76550. * @returns the impostor
  76551. */
  76552. getHeadsetImpostor(): PhysicsImpostor | undefined;
  76553. /**
  76554. * Get the physics impostor of a specific controller.
  76555. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  76556. * @param controller the controller or the controller id of which to get the impostor
  76557. * @returns the impostor or null
  76558. */
  76559. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  76560. /**
  76561. * Update the physics properties provided in the constructor
  76562. * @param newProperties the new properties object
  76563. */
  76564. setPhysicsProperties(newProperties: {
  76565. impostorType?: number;
  76566. impostorSize?: number | {
  76567. width: number;
  76568. height: number;
  76569. depth: number;
  76570. };
  76571. friction?: number;
  76572. restitution?: number;
  76573. }): void;
  76574. protected _onXRFrame(_xrFrame: any): void;
  76575. private _detachController;
  76576. }
  76577. }
  76578. declare module BABYLON {
  76579. /**
  76580. * A babylon interface for a "WebXR" feature point.
  76581. * Represents the position and confidence value of a given feature point.
  76582. */
  76583. export interface IWebXRFeaturePoint {
  76584. /**
  76585. * Represents the position of the feature point in world space.
  76586. */
  76587. position: Vector3;
  76588. /**
  76589. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  76590. */
  76591. confidenceValue: number;
  76592. }
  76593. /**
  76594. * The feature point system is used to detect feature points from real world geometry.
  76595. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  76596. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  76597. */
  76598. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  76599. private _enabled;
  76600. private _featurePointCloud;
  76601. /**
  76602. * The module's name
  76603. */
  76604. static readonly Name: string;
  76605. /**
  76606. * The (Babylon) version of this module.
  76607. * This is an integer representing the implementation version.
  76608. * This number does not correspond to the WebXR specs version
  76609. */
  76610. static readonly Version: number;
  76611. /**
  76612. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  76613. * Will notify the observers about which feature points have been added.
  76614. */
  76615. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  76616. /**
  76617. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  76618. * Will notify the observers about which feature points have been updated.
  76619. */
  76620. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  76621. /**
  76622. * The current feature point cloud maintained across frames.
  76623. */
  76624. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  76625. /**
  76626. * construct the feature point system
  76627. * @param _xrSessionManager an instance of xr Session manager
  76628. */
  76629. constructor(_xrSessionManager: WebXRSessionManager);
  76630. /**
  76631. * Detach this feature.
  76632. * Will usually be called by the features manager
  76633. *
  76634. * @returns true if successful.
  76635. */
  76636. detach(): boolean;
  76637. /**
  76638. * Dispose this feature and all of the resources attached
  76639. */
  76640. dispose(): void;
  76641. /**
  76642. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  76643. */
  76644. protected _onXRFrame(frame: XRFrame): void;
  76645. /**
  76646. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  76647. */
  76648. private _init;
  76649. }
  76650. }
  76651. declare module BABYLON {
  76652. /**
  76653. * Configuration interface for the hand tracking feature
  76654. */
  76655. export interface IWebXRHandTrackingOptions {
  76656. /**
  76657. * The xrInput that will be used as source for new hands
  76658. */
  76659. xrInput: WebXRInput;
  76660. /**
  76661. * Configuration object for the joint meshes
  76662. */
  76663. jointMeshes?: {
  76664. /**
  76665. * Should the meshes created be invisible (defaults to false)
  76666. */
  76667. invisible?: boolean;
  76668. /**
  76669. * A source mesh to be used to create instances. Defaults to a sphere.
  76670. * This mesh will be the source for all other (25) meshes.
  76671. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  76672. */
  76673. sourceMesh?: Mesh;
  76674. /**
  76675. * This function will be called after a mesh was created for a specific joint.
  76676. * Using this function you can either manipulate the instance or return a new mesh.
  76677. * When returning a new mesh the instance created before will be disposed
  76678. */
  76679. onHandJointMeshGenerated?: (meshInstance: InstancedMesh, jointId: number, controllerId: string) => Mesh | undefined;
  76680. /**
  76681. * Should the source mesh stay visible. Defaults to false
  76682. */
  76683. keepOriginalVisible?: boolean;
  76684. /**
  76685. * Scale factor for all instances (defaults to 2)
  76686. */
  76687. scaleFactor?: number;
  76688. /**
  76689. * Should each instance have its own physics impostor
  76690. */
  76691. enablePhysics?: boolean;
  76692. /**
  76693. * If enabled, override default physics properties
  76694. */
  76695. physicsProps?: {
  76696. friction?: number;
  76697. restitution?: number;
  76698. impostorType?: number;
  76699. };
  76700. /**
  76701. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  76702. */
  76703. handMesh?: AbstractMesh;
  76704. };
  76705. }
  76706. /**
  76707. * Parts of the hands divided to writs and finger names
  76708. */
  76709. export const enum HandPart {
  76710. /**
  76711. * HandPart - Wrist
  76712. */
  76713. WRIST = "wrist",
  76714. /**
  76715. * HandPart - The THumb
  76716. */
  76717. THUMB = "thumb",
  76718. /**
  76719. * HandPart - Index finger
  76720. */
  76721. INDEX = "index",
  76722. /**
  76723. * HandPart - Middle finger
  76724. */
  76725. MIDDLE = "middle",
  76726. /**
  76727. * HandPart - Ring finger
  76728. */
  76729. RING = "ring",
  76730. /**
  76731. * HandPart - Little finger
  76732. */
  76733. LITTLE = "little"
  76734. }
  76735. /**
  76736. * Representing a single hand (with its corresponding native XRHand object)
  76737. */
  76738. export class WebXRHand implements IDisposable {
  76739. /** the controller to which the hand correlates */
  76740. readonly xrController: WebXRInputSource;
  76741. /** the meshes to be used to track the hand joints */
  76742. readonly trackedMeshes: AbstractMesh[];
  76743. /**
  76744. * Hand-parts definition (key is HandPart)
  76745. */
  76746. handPartsDefinition: {
  76747. [key: string]: number[];
  76748. };
  76749. /**
  76750. * Populate the HandPartsDefinition object.
  76751. * This is called as a side effect since certain browsers don't have XRHand defined.
  76752. */
  76753. private generateHandPartsDefinition;
  76754. /**
  76755. * Construct a new hand object
  76756. * @param xrController the controller to which the hand correlates
  76757. * @param trackedMeshes the meshes to be used to track the hand joints
  76758. */
  76759. constructor(
  76760. /** the controller to which the hand correlates */
  76761. xrController: WebXRInputSource,
  76762. /** the meshes to be used to track the hand joints */
  76763. trackedMeshes: AbstractMesh[]);
  76764. /**
  76765. * Update this hand from the latest xr frame
  76766. * @param xrFrame xrFrame to update from
  76767. * @param referenceSpace The current viewer reference space
  76768. * @param scaleFactor optional scale factor for the meshes
  76769. */
  76770. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  76771. /**
  76772. * Get meshes of part of the hand
  76773. * @param part the part of hand to get
  76774. * @returns An array of meshes that correlate to the hand part requested
  76775. */
  76776. getHandPartMeshes(part: HandPart): AbstractMesh[];
  76777. /**
  76778. * Dispose this Hand object
  76779. */
  76780. dispose(): void;
  76781. }
  76782. /**
  76783. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  76784. */
  76785. export class WebXRHandTracking extends WebXRAbstractFeature {
  76786. /**
  76787. * options to use when constructing this feature
  76788. */
  76789. readonly options: IWebXRHandTrackingOptions;
  76790. private static _idCounter;
  76791. /**
  76792. * The module's name
  76793. */
  76794. static readonly Name: string;
  76795. /**
  76796. * The (Babylon) version of this module.
  76797. * This is an integer representing the implementation version.
  76798. * This number does not correspond to the WebXR specs version
  76799. */
  76800. static readonly Version: number;
  76801. /**
  76802. * This observable will notify registered observers when a new hand object was added and initialized
  76803. */
  76804. onHandAddedObservable: Observable<WebXRHand>;
  76805. /**
  76806. * This observable will notify its observers right before the hand object is disposed
  76807. */
  76808. onHandRemovedObservable: Observable<WebXRHand>;
  76809. private _hands;
  76810. /**
  76811. * Creates a new instance of the hit test feature
  76812. * @param _xrSessionManager an instance of WebXRSessionManager
  76813. * @param options options to use when constructing this feature
  76814. */
  76815. constructor(_xrSessionManager: WebXRSessionManager,
  76816. /**
  76817. * options to use when constructing this feature
  76818. */
  76819. options: IWebXRHandTrackingOptions);
  76820. /**
  76821. * Check if the needed objects are defined.
  76822. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  76823. */
  76824. isCompatible(): boolean;
  76825. /**
  76826. * attach this feature
  76827. * Will usually be called by the features manager
  76828. *
  76829. * @returns true if successful.
  76830. */
  76831. attach(): boolean;
  76832. /**
  76833. * detach this feature.
  76834. * Will usually be called by the features manager
  76835. *
  76836. * @returns true if successful.
  76837. */
  76838. detach(): boolean;
  76839. /**
  76840. * Dispose this feature and all of the resources attached
  76841. */
  76842. dispose(): void;
  76843. /**
  76844. * Get the hand object according to the controller id
  76845. * @param controllerId the controller id to which we want to get the hand
  76846. * @returns null if not found or the WebXRHand object if found
  76847. */
  76848. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  76849. /**
  76850. * Get a hand object according to the requested handedness
  76851. * @param handedness the handedness to request
  76852. * @returns null if not found or the WebXRHand object if found
  76853. */
  76854. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  76855. protected _onXRFrame(_xrFrame: XRFrame): void;
  76856. private _attachHand;
  76857. private _detachHand;
  76858. }
  76859. }
  76860. declare module BABYLON {
  76861. /**
  76862. * The motion controller class for all microsoft mixed reality controllers
  76863. */
  76864. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  76865. protected readonly _mapping: {
  76866. defaultButton: {
  76867. valueNodeName: string;
  76868. unpressedNodeName: string;
  76869. pressedNodeName: string;
  76870. };
  76871. defaultAxis: {
  76872. valueNodeName: string;
  76873. minNodeName: string;
  76874. maxNodeName: string;
  76875. };
  76876. buttons: {
  76877. "xr-standard-trigger": {
  76878. rootNodeName: string;
  76879. componentProperty: string;
  76880. states: string[];
  76881. };
  76882. "xr-standard-squeeze": {
  76883. rootNodeName: string;
  76884. componentProperty: string;
  76885. states: string[];
  76886. };
  76887. "xr-standard-touchpad": {
  76888. rootNodeName: string;
  76889. labelAnchorNodeName: string;
  76890. touchPointNodeName: string;
  76891. };
  76892. "xr-standard-thumbstick": {
  76893. rootNodeName: string;
  76894. componentProperty: string;
  76895. states: string[];
  76896. };
  76897. };
  76898. axes: {
  76899. "xr-standard-touchpad": {
  76900. "x-axis": {
  76901. rootNodeName: string;
  76902. };
  76903. "y-axis": {
  76904. rootNodeName: string;
  76905. };
  76906. };
  76907. "xr-standard-thumbstick": {
  76908. "x-axis": {
  76909. rootNodeName: string;
  76910. };
  76911. "y-axis": {
  76912. rootNodeName: string;
  76913. };
  76914. };
  76915. };
  76916. };
  76917. /**
  76918. * The base url used to load the left and right controller models
  76919. */
  76920. static MODEL_BASE_URL: string;
  76921. /**
  76922. * The name of the left controller model file
  76923. */
  76924. static MODEL_LEFT_FILENAME: string;
  76925. /**
  76926. * The name of the right controller model file
  76927. */
  76928. static MODEL_RIGHT_FILENAME: string;
  76929. profileId: string;
  76930. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  76931. protected _getFilenameAndPath(): {
  76932. filename: string;
  76933. path: string;
  76934. };
  76935. protected _getModelLoadingConstraints(): boolean;
  76936. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  76937. protected _setRootMesh(meshes: AbstractMesh[]): void;
  76938. protected _updateModel(): void;
  76939. }
  76940. }
  76941. declare module BABYLON {
  76942. /**
  76943. * The motion controller class for oculus touch (quest, rift).
  76944. * This class supports legacy mapping as well the standard xr mapping
  76945. */
  76946. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  76947. private _forceLegacyControllers;
  76948. private _modelRootNode;
  76949. /**
  76950. * The base url used to load the left and right controller models
  76951. */
  76952. static MODEL_BASE_URL: string;
  76953. /**
  76954. * The name of the left controller model file
  76955. */
  76956. static MODEL_LEFT_FILENAME: string;
  76957. /**
  76958. * The name of the right controller model file
  76959. */
  76960. static MODEL_RIGHT_FILENAME: string;
  76961. /**
  76962. * Base Url for the Quest controller model.
  76963. */
  76964. static QUEST_MODEL_BASE_URL: string;
  76965. profileId: string;
  76966. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  76967. protected _getFilenameAndPath(): {
  76968. filename: string;
  76969. path: string;
  76970. };
  76971. protected _getModelLoadingConstraints(): boolean;
  76972. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  76973. protected _setRootMesh(meshes: AbstractMesh[]): void;
  76974. protected _updateModel(): void;
  76975. /**
  76976. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  76977. * between the touch and touch 2.
  76978. */
  76979. private _isQuest;
  76980. }
  76981. }
  76982. declare module BABYLON {
  76983. /**
  76984. * The motion controller class for the standard HTC-Vive controllers
  76985. */
  76986. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  76987. private _modelRootNode;
  76988. /**
  76989. * The base url used to load the left and right controller models
  76990. */
  76991. static MODEL_BASE_URL: string;
  76992. /**
  76993. * File name for the controller model.
  76994. */
  76995. static MODEL_FILENAME: string;
  76996. profileId: string;
  76997. /**
  76998. * Create a new Vive motion controller object
  76999. * @param scene the scene to use to create this controller
  77000. * @param gamepadObject the corresponding gamepad object
  77001. * @param handedness the handedness of the controller
  77002. */
  77003. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  77004. protected _getFilenameAndPath(): {
  77005. filename: string;
  77006. path: string;
  77007. };
  77008. protected _getModelLoadingConstraints(): boolean;
  77009. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  77010. protected _setRootMesh(meshes: AbstractMesh[]): void;
  77011. protected _updateModel(): void;
  77012. }
  77013. }
  77014. declare module BABYLON {
  77015. /**
  77016. * A cursor which tracks a point on a path
  77017. */
  77018. export class PathCursor {
  77019. private path;
  77020. /**
  77021. * Stores path cursor callbacks for when an onchange event is triggered
  77022. */
  77023. private _onchange;
  77024. /**
  77025. * The value of the path cursor
  77026. */
  77027. value: number;
  77028. /**
  77029. * The animation array of the path cursor
  77030. */
  77031. animations: Animation[];
  77032. /**
  77033. * Initializes the path cursor
  77034. * @param path The path to track
  77035. */
  77036. constructor(path: Path2);
  77037. /**
  77038. * Gets the cursor point on the path
  77039. * @returns A point on the path cursor at the cursor location
  77040. */
  77041. getPoint(): Vector3;
  77042. /**
  77043. * Moves the cursor ahead by the step amount
  77044. * @param step The amount to move the cursor forward
  77045. * @returns This path cursor
  77046. */
  77047. moveAhead(step?: number): PathCursor;
  77048. /**
  77049. * Moves the cursor behind by the step amount
  77050. * @param step The amount to move the cursor back
  77051. * @returns This path cursor
  77052. */
  77053. moveBack(step?: number): PathCursor;
  77054. /**
  77055. * Moves the cursor by the step amount
  77056. * If the step amount is greater than one, an exception is thrown
  77057. * @param step The amount to move the cursor
  77058. * @returns This path cursor
  77059. */
  77060. move(step: number): PathCursor;
  77061. /**
  77062. * Ensures that the value is limited between zero and one
  77063. * @returns This path cursor
  77064. */
  77065. private ensureLimits;
  77066. /**
  77067. * Runs onchange callbacks on change (used by the animation engine)
  77068. * @returns This path cursor
  77069. */
  77070. private raiseOnChange;
  77071. /**
  77072. * Executes a function on change
  77073. * @param f A path cursor onchange callback
  77074. * @returns This path cursor
  77075. */
  77076. onchange(f: (cursor: PathCursor) => void): PathCursor;
  77077. }
  77078. }
  77079. declare module BABYLON {
  77080. /** @hidden */
  77081. export var blurPixelShader: {
  77082. name: string;
  77083. shader: string;
  77084. };
  77085. }
  77086. declare module BABYLON {
  77087. /** @hidden */
  77088. export var pointCloudVertexDeclaration: {
  77089. name: string;
  77090. shader: string;
  77091. };
  77092. }
  77093. // Mixins
  77094. interface Window {
  77095. mozIndexedDB: IDBFactory;
  77096. webkitIndexedDB: IDBFactory;
  77097. msIndexedDB: IDBFactory;
  77098. webkitURL: typeof URL;
  77099. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  77100. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  77101. WebGLRenderingContext: WebGLRenderingContext;
  77102. MSGesture: MSGesture;
  77103. CANNON: any;
  77104. AudioContext: AudioContext;
  77105. webkitAudioContext: AudioContext;
  77106. PointerEvent: any;
  77107. Math: Math;
  77108. Uint8Array: Uint8ArrayConstructor;
  77109. Float32Array: Float32ArrayConstructor;
  77110. mozURL: typeof URL;
  77111. msURL: typeof URL;
  77112. VRFrameData: any; // WebVR, from specs 1.1
  77113. DracoDecoderModule: any;
  77114. setImmediate(handler: (...args: any[]) => void): number;
  77115. }
  77116. interface HTMLCanvasElement {
  77117. requestPointerLock(): void;
  77118. msRequestPointerLock?(): void;
  77119. mozRequestPointerLock?(): void;
  77120. webkitRequestPointerLock?(): void;
  77121. /** Track wether a record is in progress */
  77122. isRecording: boolean;
  77123. /** Capture Stream method defined by some browsers */
  77124. captureStream(fps?: number): MediaStream;
  77125. }
  77126. interface CanvasRenderingContext2D {
  77127. msImageSmoothingEnabled: boolean;
  77128. }
  77129. interface MouseEvent {
  77130. mozMovementX: number;
  77131. mozMovementY: number;
  77132. webkitMovementX: number;
  77133. webkitMovementY: number;
  77134. msMovementX: number;
  77135. msMovementY: number;
  77136. }
  77137. interface Navigator {
  77138. mozGetVRDevices: (any: any) => any;
  77139. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  77140. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  77141. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  77142. webkitGetGamepads(): Gamepad[];
  77143. msGetGamepads(): Gamepad[];
  77144. webkitGamepads(): Gamepad[];
  77145. }
  77146. interface HTMLVideoElement {
  77147. mozSrcObject: any;
  77148. }
  77149. interface Math {
  77150. fround(x: number): number;
  77151. imul(a: number, b: number): number;
  77152. }
  77153. interface WebGLRenderingContext {
  77154. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  77155. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  77156. vertexAttribDivisor(index: number, divisor: number): void;
  77157. createVertexArray(): any;
  77158. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  77159. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  77160. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  77161. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  77162. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  77163. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  77164. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  77165. // Queries
  77166. createQuery(): WebGLQuery;
  77167. deleteQuery(query: WebGLQuery): void;
  77168. beginQuery(target: number, query: WebGLQuery): void;
  77169. endQuery(target: number): void;
  77170. getQueryParameter(query: WebGLQuery, pname: number): any;
  77171. getQuery(target: number, pname: number): any;
  77172. MAX_SAMPLES: number;
  77173. RGBA8: number;
  77174. READ_FRAMEBUFFER: number;
  77175. DRAW_FRAMEBUFFER: number;
  77176. UNIFORM_BUFFER: number;
  77177. HALF_FLOAT_OES: number;
  77178. RGBA16F: number;
  77179. RGBA32F: number;
  77180. R32F: number;
  77181. RG32F: number;
  77182. RGB32F: number;
  77183. R16F: number;
  77184. RG16F: number;
  77185. RGB16F: number;
  77186. RED: number;
  77187. RG: number;
  77188. R8: number;
  77189. RG8: number;
  77190. UNSIGNED_INT_24_8: number;
  77191. DEPTH24_STENCIL8: number;
  77192. MIN: number;
  77193. MAX: number;
  77194. /* Multiple Render Targets */
  77195. drawBuffers(buffers: number[]): void;
  77196. readBuffer(src: number): void;
  77197. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  77198. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  77199. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  77200. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  77201. // Occlusion Query
  77202. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  77203. ANY_SAMPLES_PASSED: number;
  77204. QUERY_RESULT_AVAILABLE: number;
  77205. QUERY_RESULT: number;
  77206. }
  77207. interface WebGLProgram {
  77208. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  77209. }
  77210. interface EXT_disjoint_timer_query {
  77211. QUERY_COUNTER_BITS_EXT: number;
  77212. TIME_ELAPSED_EXT: number;
  77213. TIMESTAMP_EXT: number;
  77214. GPU_DISJOINT_EXT: number;
  77215. QUERY_RESULT_EXT: number;
  77216. QUERY_RESULT_AVAILABLE_EXT: number;
  77217. queryCounterEXT(query: WebGLQuery, target: number): void;
  77218. createQueryEXT(): WebGLQuery;
  77219. beginQueryEXT(target: number, query: WebGLQuery): void;
  77220. endQueryEXT(target: number): void;
  77221. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  77222. deleteQueryEXT(query: WebGLQuery): void;
  77223. }
  77224. interface WebGLUniformLocation {
  77225. _currentState: any;
  77226. }
  77227. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  77228. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  77229. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  77230. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  77231. interface WebGLRenderingContext {
  77232. readonly RASTERIZER_DISCARD: number;
  77233. readonly DEPTH_COMPONENT24: number;
  77234. readonly TEXTURE_3D: number;
  77235. readonly TEXTURE_2D_ARRAY: number;
  77236. readonly TEXTURE_COMPARE_FUNC: number;
  77237. readonly TEXTURE_COMPARE_MODE: number;
  77238. readonly COMPARE_REF_TO_TEXTURE: number;
  77239. readonly TEXTURE_WRAP_R: number;
  77240. readonly HALF_FLOAT: number;
  77241. readonly RGB8: number;
  77242. readonly RED_INTEGER: number;
  77243. readonly RG_INTEGER: number;
  77244. readonly RGB_INTEGER: number;
  77245. readonly RGBA_INTEGER: number;
  77246. readonly R8_SNORM: number;
  77247. readonly RG8_SNORM: number;
  77248. readonly RGB8_SNORM: number;
  77249. readonly RGBA8_SNORM: number;
  77250. readonly R8I: number;
  77251. readonly RG8I: number;
  77252. readonly RGB8I: number;
  77253. readonly RGBA8I: number;
  77254. readonly R8UI: number;
  77255. readonly RG8UI: number;
  77256. readonly RGB8UI: number;
  77257. readonly RGBA8UI: number;
  77258. readonly R16I: number;
  77259. readonly RG16I: number;
  77260. readonly RGB16I: number;
  77261. readonly RGBA16I: number;
  77262. readonly R16UI: number;
  77263. readonly RG16UI: number;
  77264. readonly RGB16UI: number;
  77265. readonly RGBA16UI: number;
  77266. readonly R32I: number;
  77267. readonly RG32I: number;
  77268. readonly RGB32I: number;
  77269. readonly RGBA32I: number;
  77270. readonly R32UI: number;
  77271. readonly RG32UI: number;
  77272. readonly RGB32UI: number;
  77273. readonly RGBA32UI: number;
  77274. readonly RGB10_A2UI: number;
  77275. readonly R11F_G11F_B10F: number;
  77276. readonly RGB9_E5: number;
  77277. readonly RGB10_A2: number;
  77278. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  77279. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  77280. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  77281. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  77282. readonly DEPTH_COMPONENT32F: number;
  77283. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  77284. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  77285. 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;
  77286. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  77287. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  77288. readonly TRANSFORM_FEEDBACK: number;
  77289. readonly INTERLEAVED_ATTRIBS: number;
  77290. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  77291. createTransformFeedback(): WebGLTransformFeedback;
  77292. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  77293. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  77294. beginTransformFeedback(primitiveMode: number): void;
  77295. endTransformFeedback(): void;
  77296. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  77297. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  77298. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  77299. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  77300. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  77301. }
  77302. interface ImageBitmap {
  77303. readonly width: number;
  77304. readonly height: number;
  77305. close(): void;
  77306. }
  77307. interface WebGLQuery extends WebGLObject {
  77308. }
  77309. declare var WebGLQuery: {
  77310. prototype: WebGLQuery;
  77311. new(): WebGLQuery;
  77312. };
  77313. interface WebGLSampler extends WebGLObject {
  77314. }
  77315. declare var WebGLSampler: {
  77316. prototype: WebGLSampler;
  77317. new(): WebGLSampler;
  77318. };
  77319. interface WebGLSync extends WebGLObject {
  77320. }
  77321. declare var WebGLSync: {
  77322. prototype: WebGLSync;
  77323. new(): WebGLSync;
  77324. };
  77325. interface WebGLTransformFeedback extends WebGLObject {
  77326. }
  77327. declare var WebGLTransformFeedback: {
  77328. prototype: WebGLTransformFeedback;
  77329. new(): WebGLTransformFeedback;
  77330. };
  77331. interface WebGLVertexArrayObject extends WebGLObject {
  77332. }
  77333. declare var WebGLVertexArrayObject: {
  77334. prototype: WebGLVertexArrayObject;
  77335. new(): WebGLVertexArrayObject;
  77336. };
  77337. // Type definitions for WebVR API
  77338. // Project: https://w3c.github.io/webvr/
  77339. // Definitions by: six a <https://github.com/lostfictions>
  77340. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  77341. interface VRDisplay extends EventTarget {
  77342. /**
  77343. * Dictionary of capabilities describing the VRDisplay.
  77344. */
  77345. readonly capabilities: VRDisplayCapabilities;
  77346. /**
  77347. * z-depth defining the far plane of the eye view frustum
  77348. * enables mapping of values in the render target depth
  77349. * attachment to scene coordinates. Initially set to 10000.0.
  77350. */
  77351. depthFar: number;
  77352. /**
  77353. * z-depth defining the near plane of the eye view frustum
  77354. * enables mapping of values in the render target depth
  77355. * attachment to scene coordinates. Initially set to 0.01.
  77356. */
  77357. depthNear: number;
  77358. /**
  77359. * An identifier for this distinct VRDisplay. Used as an
  77360. * association point in the Gamepad API.
  77361. */
  77362. readonly displayId: number;
  77363. /**
  77364. * A display name, a user-readable name identifying it.
  77365. */
  77366. readonly displayName: string;
  77367. readonly isConnected: boolean;
  77368. readonly isPresenting: boolean;
  77369. /**
  77370. * If this VRDisplay supports room-scale experiences, the optional
  77371. * stage attribute contains details on the room-scale parameters.
  77372. */
  77373. readonly stageParameters: VRStageParameters | null;
  77374. /**
  77375. * Passing the value returned by `requestAnimationFrame` to
  77376. * `cancelAnimationFrame` will unregister the callback.
  77377. * @param handle Define the hanle of the request to cancel
  77378. */
  77379. cancelAnimationFrame(handle: number): void;
  77380. /**
  77381. * Stops presenting to the VRDisplay.
  77382. * @returns a promise to know when it stopped
  77383. */
  77384. exitPresent(): Promise<void>;
  77385. /**
  77386. * Return the current VREyeParameters for the given eye.
  77387. * @param whichEye Define the eye we want the parameter for
  77388. * @returns the eye parameters
  77389. */
  77390. getEyeParameters(whichEye: string): VREyeParameters;
  77391. /**
  77392. * Populates the passed VRFrameData with the information required to render
  77393. * the current frame.
  77394. * @param frameData Define the data structure to populate
  77395. * @returns true if ok otherwise false
  77396. */
  77397. getFrameData(frameData: VRFrameData): boolean;
  77398. /**
  77399. * Get the layers currently being presented.
  77400. * @returns the list of VR layers
  77401. */
  77402. getLayers(): VRLayer[];
  77403. /**
  77404. * Return a VRPose containing the future predicted pose of the VRDisplay
  77405. * when the current frame will be presented. The value returned will not
  77406. * change until JavaScript has returned control to the browser.
  77407. *
  77408. * The VRPose will contain the position, orientation, velocity,
  77409. * and acceleration of each of these properties.
  77410. * @returns the pose object
  77411. */
  77412. getPose(): VRPose;
  77413. /**
  77414. * Return the current instantaneous pose of the VRDisplay, with no
  77415. * prediction applied.
  77416. * @returns the current instantaneous pose
  77417. */
  77418. getImmediatePose(): VRPose;
  77419. /**
  77420. * The callback passed to `requestAnimationFrame` will be called
  77421. * any time a new frame should be rendered. When the VRDisplay is
  77422. * presenting the callback will be called at the native refresh
  77423. * rate of the HMD. When not presenting this function acts
  77424. * identically to how window.requestAnimationFrame acts. Content should
  77425. * make no assumptions of frame rate or vsync behavior as the HMD runs
  77426. * asynchronously from other displays and at differing refresh rates.
  77427. * @param callback Define the eaction to run next frame
  77428. * @returns the request handle it
  77429. */
  77430. requestAnimationFrame(callback: FrameRequestCallback): number;
  77431. /**
  77432. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  77433. * Repeat calls while already presenting will update the VRLayers being displayed.
  77434. * @param layers Define the list of layer to present
  77435. * @returns a promise to know when the request has been fulfilled
  77436. */
  77437. requestPresent(layers: VRLayer[]): Promise<void>;
  77438. /**
  77439. * Reset the pose for this display, treating its current position and
  77440. * orientation as the "origin/zero" values. VRPose.position,
  77441. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  77442. * updated when calling resetPose(). This should be called in only
  77443. * sitting-space experiences.
  77444. */
  77445. resetPose(): void;
  77446. /**
  77447. * The VRLayer provided to the VRDisplay will be captured and presented
  77448. * in the HMD. Calling this function has the same effect on the source
  77449. * canvas as any other operation that uses its source image, and canvases
  77450. * created without preserveDrawingBuffer set to true will be cleared.
  77451. * @param pose Define the pose to submit
  77452. */
  77453. submitFrame(pose?: VRPose): void;
  77454. }
  77455. declare var VRDisplay: {
  77456. prototype: VRDisplay;
  77457. new(): VRDisplay;
  77458. };
  77459. interface VRLayer {
  77460. leftBounds?: number[] | Float32Array | null;
  77461. rightBounds?: number[] | Float32Array | null;
  77462. source?: HTMLCanvasElement | null;
  77463. }
  77464. interface VRDisplayCapabilities {
  77465. readonly canPresent: boolean;
  77466. readonly hasExternalDisplay: boolean;
  77467. readonly hasOrientation: boolean;
  77468. readonly hasPosition: boolean;
  77469. readonly maxLayers: number;
  77470. }
  77471. interface VREyeParameters {
  77472. /** @deprecated */
  77473. readonly fieldOfView: VRFieldOfView;
  77474. readonly offset: Float32Array;
  77475. readonly renderHeight: number;
  77476. readonly renderWidth: number;
  77477. }
  77478. interface VRFieldOfView {
  77479. readonly downDegrees: number;
  77480. readonly leftDegrees: number;
  77481. readonly rightDegrees: number;
  77482. readonly upDegrees: number;
  77483. }
  77484. interface VRFrameData {
  77485. readonly leftProjectionMatrix: Float32Array;
  77486. readonly leftViewMatrix: Float32Array;
  77487. readonly pose: VRPose;
  77488. readonly rightProjectionMatrix: Float32Array;
  77489. readonly rightViewMatrix: Float32Array;
  77490. readonly timestamp: number;
  77491. }
  77492. interface VRPose {
  77493. readonly angularAcceleration: Float32Array | null;
  77494. readonly angularVelocity: Float32Array | null;
  77495. readonly linearAcceleration: Float32Array | null;
  77496. readonly linearVelocity: Float32Array | null;
  77497. readonly orientation: Float32Array | null;
  77498. readonly position: Float32Array | null;
  77499. readonly timestamp: number;
  77500. }
  77501. interface VRStageParameters {
  77502. sittingToStandingTransform?: Float32Array;
  77503. sizeX?: number;
  77504. sizeY?: number;
  77505. }
  77506. interface Navigator {
  77507. getVRDisplays(): Promise<VRDisplay[]>;
  77508. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  77509. }
  77510. interface Window {
  77511. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  77512. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  77513. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  77514. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  77515. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  77516. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  77517. }
  77518. interface Gamepad {
  77519. readonly displayId: number;
  77520. }
  77521. /**
  77522. * Available session modes
  77523. */
  77524. type XRSessionMode = "inline" | "immersive-vr" | "immersive-ar";
  77525. /**
  77526. * Reference space types
  77527. */
  77528. type XRReferenceSpaceType = "viewer" | "local" | "local-floor" | "bounded-floor" | "unbounded";
  77529. type XREnvironmentBlendMode = "opaque" | "additive" | "alpha-blend";
  77530. type XRVisibilityState = "visible" | "visible-blurred" | "hidden";
  77531. /**
  77532. * Handedness types
  77533. */
  77534. type XRHandedness = "none" | "left" | "right";
  77535. /**
  77536. * InputSource target ray modes
  77537. */
  77538. type XRTargetRayMode = "gaze" | "tracked-pointer" | "screen";
  77539. /**
  77540. * Eye types
  77541. */
  77542. type XREye = "none" | "left" | "right";
  77543. /**
  77544. * Type of XR events available
  77545. */
  77546. type XREventType = "devicechange" | "visibilitychange" | "end" | "inputsourceschange" | "select" | "selectstart" | "selectend" | "squeeze" | "squeezestart" | "squeezeend" | "reset";
  77547. type XRFrameRequestCallback = (time: DOMHighResTimeStamp, frame: XRFrame) => void;
  77548. type XRPlaneSet = Set<XRPlane>;
  77549. type XRAnchorSet = Set<XRAnchor>;
  77550. type XREventHandler = (callback: any) => void;
  77551. interface XRLayer extends EventTarget {}
  77552. interface XRSessionInit {
  77553. optionalFeatures?: string[];
  77554. requiredFeatures?: string[];
  77555. }
  77556. interface XRSessionEvent extends Event {
  77557. readonly session: XRSession;
  77558. }
  77559. interface XRSystem {
  77560. isSessionSupported: (sessionMode: XRSessionMode) => Promise<boolean>;
  77561. requestSession: (sessionMode: XRSessionMode, sessionInit?: any) => Promise<XRSession>;
  77562. }
  77563. interface XRViewport {
  77564. readonly x: number;
  77565. readonly y: number;
  77566. readonly width: number;
  77567. readonly height: number;
  77568. }
  77569. interface XRWebGLLayerInit {
  77570. antialias?: boolean;
  77571. depth?: boolean;
  77572. stencil?: boolean;
  77573. alpha?: boolean;
  77574. multiview?: boolean;
  77575. framebufferScaleFactor?: number;
  77576. }
  77577. declare class XRWebGLLayer {
  77578. static getNativeFramebufferScaleFactor(session: XRSession): number;
  77579. constructor(session: XRSession, context: WebGLRenderingContext | WebGL2RenderingContext, layerInit?: XRWebGLLayerInit);
  77580. readonly antialias: boolean;
  77581. readonly framebuffer: WebGLFramebuffer;
  77582. readonly framebufferWidth: number;
  77583. readonly framebufferHeight: number;
  77584. readonly ignoreDepthValues: boolean;
  77585. getViewport: (view: XRView) => XRViewport;
  77586. }
  77587. // tslint:disable-next-line no-empty-interface
  77588. interface XRSpace extends EventTarget {}
  77589. interface XRRenderState {
  77590. readonly baseLayer?: XRWebGLLayer;
  77591. readonly depthFar: number;
  77592. readonly depthNear: number;
  77593. readonly inlineVerticalFieldOfView?: number;
  77594. }
  77595. interface XRRenderStateInit extends XRRenderState {
  77596. baseLayer: XRWebGLLayer;
  77597. depthFar: number;
  77598. depthNear: number;
  77599. inlineVerticalFieldOfView?: number;
  77600. layers?: XRLayer[];
  77601. }
  77602. interface XRReferenceSpace extends XRSpace {
  77603. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  77604. onreset: XREventHandler;
  77605. }
  77606. interface XRBoundedReferenceSpace extends XRSpace {
  77607. readonly boundsGeometry: DOMPointReadOnly[];
  77608. }
  77609. interface XRInputSource {
  77610. readonly handedness: XRHandedness;
  77611. readonly targetRayMode: XRTargetRayMode;
  77612. readonly targetRaySpace: XRSpace;
  77613. readonly gripSpace?: XRSpace;
  77614. readonly gamepad?: Gamepad;
  77615. readonly profiles: Array<string>;
  77616. readonly hand?: XRHand;
  77617. }
  77618. interface XRPose {
  77619. readonly transform: XRRigidTransform;
  77620. readonly emulatedPosition: boolean;
  77621. }
  77622. interface XRFrame {
  77623. readonly session: XRSession;
  77624. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  77625. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  77626. // AR
  77627. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult>;
  77628. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  77629. // Anchors
  77630. trackedAnchors?: XRAnchorSet;
  77631. createAnchor?(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  77632. // Planes
  77633. worldInformation?: {
  77634. detectedPlanes?: XRPlaneSet;
  77635. };
  77636. // Hand tracking
  77637. getJointPose?(joint: XRJointSpace, baseSpace: XRSpace): XRJointPose;
  77638. }
  77639. interface XRInputSourceEvent extends Event {
  77640. readonly frame: XRFrame;
  77641. readonly inputSource: XRInputSource;
  77642. }
  77643. type XRInputSourceArray = XRInputSource[];
  77644. interface XRSession {
  77645. addEventListener(type: XREventType, listener: XREventHandler, options?: boolean | AddEventListenerOptions): void;
  77646. removeEventListener(type: XREventType, listener: XREventHandler, options?: boolean | EventListenerOptions): void;
  77647. /**
  77648. * Returns a list of this session's XRInputSources, each representing an input device
  77649. * used to control the camera and/or scene.
  77650. */
  77651. readonly inputSources: Array<XRInputSource>;
  77652. /**
  77653. * object which contains options affecting how the imagery is rendered.
  77654. * This includes things such as the near and far clipping planes
  77655. */
  77656. readonly renderState: XRRenderState;
  77657. readonly visibilityState: XRVisibilityState;
  77658. /**
  77659. * Removes a callback from the animation frame painting callback from
  77660. * XRSession's set of animation frame rendering callbacks, given the
  77661. * identifying handle returned by a previous call to requestAnimationFrame().
  77662. */
  77663. cancelAnimationFrame: (handle: number) => void;
  77664. /**
  77665. * Ends the WebXR session. Returns a promise which resolves when the
  77666. * session has been shut down.
  77667. */
  77668. end(): Promise<void>;
  77669. /**
  77670. * Schedules the specified method to be called the next time the user agent
  77671. * is working on rendering an animation frame for the WebXR device. Returns an
  77672. * integer value which can be used to identify the request for the purposes of
  77673. * canceling the callback using cancelAnimationFrame(). This method is comparable
  77674. * to the Window.requestAnimationFrame() method.
  77675. */
  77676. requestAnimationFrame: XRFrameRequestCallback;
  77677. /**
  77678. * Requests that a new XRReferenceSpace of the specified type be created.
  77679. * Returns a promise which resolves with the XRReferenceSpace or
  77680. * XRBoundedReferenceSpace which was requested, or throws a NotSupportedError if
  77681. * the requested space type isn't supported by the device.
  77682. */
  77683. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace | XRBoundedReferenceSpace>;
  77684. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  77685. onend: XREventHandler;
  77686. oninputsourceschange: XREventHandler;
  77687. onselect: XREventHandler;
  77688. onselectstart: XREventHandler;
  77689. onselectend: XREventHandler;
  77690. onsqueeze: XREventHandler;
  77691. onsqueezestart: XREventHandler;
  77692. onsqueezeend: XREventHandler;
  77693. onvisibilitychange: XREventHandler;
  77694. // hit test
  77695. requestHitTestSource?(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  77696. requestHitTestSourceForTransientInput?(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  77697. // legacy AR hit test
  77698. requestHitTest?(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  77699. // legacy plane detection
  77700. updateWorldTrackingState?(options: { planeDetectionState?: { enabled: boolean } }): void;
  77701. }
  77702. interface XRViewerPose extends XRPose {
  77703. readonly views: Array<XRView>;
  77704. }
  77705. declare class XRRigidTransform {
  77706. constructor(position?: DOMPointInit, direction?: DOMPointInit);
  77707. position: DOMPointReadOnly;
  77708. orientation: DOMPointReadOnly;
  77709. matrix: Float32Array;
  77710. inverse: XRRigidTransform;
  77711. }
  77712. interface XRView {
  77713. readonly eye: XREye;
  77714. readonly projectionMatrix: Float32Array;
  77715. readonly transform: XRRigidTransform;
  77716. readonly recommendedViewportScale?: number;
  77717. requestViewportScale(scale: number): void;
  77718. }
  77719. interface XRInputSourceChangeEvent extends Event {
  77720. session: XRSession;
  77721. removed: Array<XRInputSource>;
  77722. added: Array<XRInputSource>;
  77723. }
  77724. // Experimental/Draft features
  77725. declare class XRRay {
  77726. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  77727. origin: DOMPointReadOnly;
  77728. direction: DOMPointReadOnly;
  77729. matrix: Float32Array;
  77730. }
  77731. declare enum XRHitTestTrackableType {
  77732. "point",
  77733. "plane",
  77734. "mesh",
  77735. }
  77736. interface XRHitResult {
  77737. hitMatrix: Float32Array;
  77738. }
  77739. interface XRTransientInputHitTestResult {
  77740. readonly inputSource: XRInputSource;
  77741. readonly results: Array<XRHitTestResult>;
  77742. }
  77743. interface XRHitTestResult {
  77744. getPose(baseSpace: XRSpace): XRPose | undefined;
  77745. // When anchor system is enabled
  77746. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  77747. }
  77748. interface XRHitTestSource {
  77749. cancel(): void;
  77750. }
  77751. interface XRTransientInputHitTestSource {
  77752. cancel(): void;
  77753. }
  77754. interface XRHitTestOptionsInit {
  77755. space: XRSpace;
  77756. entityTypes?: Array<XRHitTestTrackableType>;
  77757. offsetRay?: XRRay;
  77758. }
  77759. interface XRTransientInputHitTestOptionsInit {
  77760. profile: string;
  77761. entityTypes?: Array<XRHitTestTrackableType>;
  77762. offsetRay?: XRRay;
  77763. }
  77764. interface XRAnchor {
  77765. anchorSpace: XRSpace;
  77766. delete(): void;
  77767. }
  77768. interface XRPlane {
  77769. orientation: "Horizontal" | "Vertical";
  77770. planeSpace: XRSpace;
  77771. polygon: Array<DOMPointReadOnly>;
  77772. lastChangedTime: number;
  77773. }
  77774. interface XRJointSpace extends XRSpace {}
  77775. interface XRJointPose extends XRPose {
  77776. radius: number | undefined;
  77777. }
  77778. interface XRHand extends Iterable<XRJointSpace> {
  77779. readonly length: number;
  77780. [index: number]: XRJointSpace;
  77781. readonly WRIST: number;
  77782. readonly THUMB_METACARPAL: number;
  77783. readonly THUMB_PHALANX_PROXIMAL: number;
  77784. readonly THUMB_PHALANX_DISTAL: number;
  77785. readonly THUMB_PHALANX_TIP: number;
  77786. readonly INDEX_METACARPAL: number;
  77787. readonly INDEX_PHALANX_PROXIMAL: number;
  77788. readonly INDEX_PHALANX_INTERMEDIATE: number;
  77789. readonly INDEX_PHALANX_DISTAL: number;
  77790. readonly INDEX_PHALANX_TIP: number;
  77791. readonly MIDDLE_METACARPAL: number;
  77792. readonly MIDDLE_PHALANX_PROXIMAL: number;
  77793. readonly MIDDLE_PHALANX_INTERMEDIATE: number;
  77794. readonly MIDDLE_PHALANX_DISTAL: number;
  77795. readonly MIDDLE_PHALANX_TIP: number;
  77796. readonly RING_METACARPAL: number;
  77797. readonly RING_PHALANX_PROXIMAL: number;
  77798. readonly RING_PHALANX_INTERMEDIATE: number;
  77799. readonly RING_PHALANX_DISTAL: number;
  77800. readonly RING_PHALANX_TIP: number;
  77801. readonly LITTLE_METACARPAL: number;
  77802. readonly LITTLE_PHALANX_PROXIMAL: number;
  77803. readonly LITTLE_PHALANX_INTERMEDIATE: number;
  77804. readonly LITTLE_PHALANX_DISTAL: number;
  77805. readonly LITTLE_PHALANX_TIP: number;
  77806. }
  77807. // This file contains native only extensions for WebXR These APIs are not supported in the browser yet.
  77808. // They are intended for use with either Babylon Native https://github.com/BabylonJS/BabylonNative or
  77809. // Babylon React Native: https://github.com/BabylonJS/BabylonReactNative
  77810. interface XRSession {
  77811. trySetFeaturePointCloudEnabled(enabled: boolean): boolean;
  77812. }
  77813. interface XRFrame {
  77814. featurePointCloud? : Array<number>;
  77815. }
  77816. /**
  77817. * @ignore
  77818. */
  77819. declare module BABYLON.GLTF2.Exporter {
  77820. }
  77821. /**
  77822. * @ignore
  77823. */
  77824. declare module BABYLON.GLTF1 {
  77825. }
  77826. declare module BABYLON.GUI {
  77827. /**
  77828. * Class used to specific a value and its associated unit
  77829. */
  77830. export class ValueAndUnit {
  77831. /** defines the unit to store */
  77832. unit: number;
  77833. /** defines a boolean indicating if the value can be negative */
  77834. negativeValueAllowed: boolean;
  77835. private _value;
  77836. private _originalUnit;
  77837. /**
  77838. * Gets or sets a value indicating that this value will not scale accordingly with adaptive scaling property
  77839. * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
  77840. */
  77841. ignoreAdaptiveScaling: boolean;
  77842. /**
  77843. * Creates a new ValueAndUnit
  77844. * @param value defines the value to store
  77845. * @param unit defines the unit to store
  77846. * @param negativeValueAllowed defines a boolean indicating if the value can be negative
  77847. */
  77848. constructor(value: number,
  77849. /** defines the unit to store */
  77850. unit?: number,
  77851. /** defines a boolean indicating if the value can be negative */
  77852. negativeValueAllowed?: boolean);
  77853. /** Gets a boolean indicating if the value is a percentage */
  77854. get isPercentage(): boolean;
  77855. /** Gets a boolean indicating if the value is store as pixel */
  77856. get isPixel(): boolean;
  77857. /** Gets direct internal value */
  77858. get internalValue(): number;
  77859. /**
  77860. * Gets value as pixel
  77861. * @param host defines the root host
  77862. * @param refValue defines the reference value for percentages
  77863. * @returns the value as pixel
  77864. */
  77865. getValueInPixel(host: AdvancedDynamicTexture, refValue: number): number;
  77866. /**
  77867. * Update the current value and unit. This should be done cautiously as the GUi won't be marked as dirty with this function.
  77868. * @param value defines the value to store
  77869. * @param unit defines the unit to store
  77870. * @returns the current ValueAndUnit
  77871. */
  77872. updateInPlace(value: number, unit?: number): ValueAndUnit;
  77873. /**
  77874. * Gets the value accordingly to its unit
  77875. * @param host defines the root host
  77876. * @returns the value
  77877. */
  77878. getValue(host: AdvancedDynamicTexture): number;
  77879. /**
  77880. * Gets a string representation of the value
  77881. * @param host defines the root host
  77882. * @param decimals defines an optional number of decimals to display
  77883. * @returns a string
  77884. */
  77885. toString(host: AdvancedDynamicTexture, decimals?: number): string;
  77886. /**
  77887. * Store a value parsed from a string
  77888. * @param source defines the source string
  77889. * @returns true if the value was successfully parsed
  77890. */
  77891. fromString(source: string | number): boolean;
  77892. private static _Regex;
  77893. private static _UNITMODE_PERCENTAGE;
  77894. private static _UNITMODE_PIXEL;
  77895. /** UNITMODE_PERCENTAGE */
  77896. static get UNITMODE_PERCENTAGE(): number;
  77897. /** UNITMODE_PIXEL */
  77898. static get UNITMODE_PIXEL(): number;
  77899. }
  77900. }
  77901. declare module BABYLON.GUI {
  77902. /**
  77903. * Define a style used by control to automatically setup properties based on a template.
  77904. * Only support font related properties so far
  77905. */
  77906. export class Style implements BABYLON.IDisposable {
  77907. private _fontFamily;
  77908. private _fontStyle;
  77909. private _fontWeight;
  77910. /** @hidden */
  77911. _host: AdvancedDynamicTexture;
  77912. /** @hidden */
  77913. _fontSize: ValueAndUnit;
  77914. /**
  77915. * BABYLON.Observable raised when the style values are changed
  77916. */
  77917. onChangedObservable: BABYLON.Observable<Style>;
  77918. /**
  77919. * Creates a new style object
  77920. * @param host defines the AdvancedDynamicTexture which hosts this style
  77921. */
  77922. constructor(host: AdvancedDynamicTexture);
  77923. /**
  77924. * Gets or sets the font size
  77925. */
  77926. get fontSize(): string | number;
  77927. set fontSize(value: string | number);
  77928. /**
  77929. * Gets or sets the font family
  77930. */
  77931. get fontFamily(): string;
  77932. set fontFamily(value: string);
  77933. /**
  77934. * Gets or sets the font style
  77935. */
  77936. get fontStyle(): string;
  77937. set fontStyle(value: string);
  77938. /** Gets or sets font weight */
  77939. get fontWeight(): string;
  77940. set fontWeight(value: string);
  77941. /** Dispose all associated resources */
  77942. dispose(): void;
  77943. }
  77944. }
  77945. declare module BABYLON.GUI {
  77946. /**
  77947. * Class used to transport BABYLON.Vector2 information for pointer events
  77948. */
  77949. export class Vector2WithInfo extends BABYLON.Vector2 {
  77950. /** defines the current mouse button index */
  77951. buttonIndex: number;
  77952. /**
  77953. * Creates a new Vector2WithInfo
  77954. * @param source defines the vector2 data to transport
  77955. * @param buttonIndex defines the current mouse button index
  77956. */
  77957. constructor(source: BABYLON.Vector2,
  77958. /** defines the current mouse button index */
  77959. buttonIndex?: number);
  77960. }
  77961. /** Class used to provide 2D matrix features */
  77962. export class Matrix2D {
  77963. /** Gets the internal array of 6 floats used to store matrix data */
  77964. m: Float32Array;
  77965. /**
  77966. * Creates a new matrix
  77967. * @param m00 defines value for (0, 0)
  77968. * @param m01 defines value for (0, 1)
  77969. * @param m10 defines value for (1, 0)
  77970. * @param m11 defines value for (1, 1)
  77971. * @param m20 defines value for (2, 0)
  77972. * @param m21 defines value for (2, 1)
  77973. */
  77974. constructor(m00: number, m01: number, m10: number, m11: number, m20: number, m21: number);
  77975. /**
  77976. * Fills the matrix from direct values
  77977. * @param m00 defines value for (0, 0)
  77978. * @param m01 defines value for (0, 1)
  77979. * @param m10 defines value for (1, 0)
  77980. * @param m11 defines value for (1, 1)
  77981. * @param m20 defines value for (2, 0)
  77982. * @param m21 defines value for (2, 1)
  77983. * @returns the current modified matrix
  77984. */
  77985. fromValues(m00: number, m01: number, m10: number, m11: number, m20: number, m21: number): Matrix2D;
  77986. /**
  77987. * Gets matrix determinant
  77988. * @returns the determinant
  77989. */
  77990. determinant(): number;
  77991. /**
  77992. * Inverses the matrix and stores it in a target matrix
  77993. * @param result defines the target matrix
  77994. * @returns the current matrix
  77995. */
  77996. invertToRef(result: Matrix2D): Matrix2D;
  77997. /**
  77998. * Multiplies the current matrix with another one
  77999. * @param other defines the second operand
  78000. * @param result defines the target matrix
  78001. * @returns the current matrix
  78002. */
  78003. multiplyToRef(other: Matrix2D, result: Matrix2D): Matrix2D;
  78004. /**
  78005. * Applies the current matrix to a set of 2 floats and stores the result in a vector2
  78006. * @param x defines the x coordinate to transform
  78007. * @param y defines the x coordinate to transform
  78008. * @param result defines the target vector2
  78009. * @returns the current matrix
  78010. */
  78011. transformCoordinates(x: number, y: number, result: BABYLON.Vector2): Matrix2D;
  78012. /**
  78013. * Creates an identity matrix
  78014. * @returns a new matrix
  78015. */
  78016. static Identity(): Matrix2D;
  78017. /**
  78018. * Creates a translation matrix and stores it in a target matrix
  78019. * @param x defines the x coordinate of the translation
  78020. * @param y defines the y coordinate of the translation
  78021. * @param result defines the target matrix
  78022. */
  78023. static TranslationToRef(x: number, y: number, result: Matrix2D): void;
  78024. /**
  78025. * Creates a scaling matrix and stores it in a target matrix
  78026. * @param x defines the x coordinate of the scaling
  78027. * @param y defines the y coordinate of the scaling
  78028. * @param result defines the target matrix
  78029. */
  78030. static ScalingToRef(x: number, y: number, result: Matrix2D): void;
  78031. /**
  78032. * Creates a rotation matrix and stores it in a target matrix
  78033. * @param angle defines the rotation angle
  78034. * @param result defines the target matrix
  78035. */
  78036. static RotationToRef(angle: number, result: Matrix2D): void;
  78037. private static _TempPreTranslationMatrix;
  78038. private static _TempPostTranslationMatrix;
  78039. private static _TempRotationMatrix;
  78040. private static _TempScalingMatrix;
  78041. private static _TempCompose0;
  78042. private static _TempCompose1;
  78043. private static _TempCompose2;
  78044. /**
  78045. * Composes a matrix from translation, rotation, scaling and parent matrix and stores it in a target matrix
  78046. * @param tx defines the x coordinate of the translation
  78047. * @param ty defines the y coordinate of the translation
  78048. * @param angle defines the rotation angle
  78049. * @param scaleX defines the x coordinate of the scaling
  78050. * @param scaleY defines the y coordinate of the scaling
  78051. * @param parentMatrix defines the parent matrix to multiply by (can be null)
  78052. * @param result defines the target matrix
  78053. */
  78054. static ComposeToRef(tx: number, ty: number, angle: number, scaleX: number, scaleY: number, parentMatrix: BABYLON.Nullable<Matrix2D>, result: Matrix2D): void;
  78055. }
  78056. }
  78057. declare module BABYLON.GUI {
  78058. /**
  78059. * Class used to store 2D control sizes
  78060. */
  78061. export class Measure {
  78062. /** defines left coordinate */
  78063. left: number;
  78064. /** defines top coordinate */
  78065. top: number;
  78066. /** defines width dimension */
  78067. width: number;
  78068. /** defines height dimension */
  78069. height: number;
  78070. /**
  78071. * Creates a new measure
  78072. * @param left defines left coordinate
  78073. * @param top defines top coordinate
  78074. * @param width defines width dimension
  78075. * @param height defines height dimension
  78076. */
  78077. constructor(
  78078. /** defines left coordinate */
  78079. left: number,
  78080. /** defines top coordinate */
  78081. top: number,
  78082. /** defines width dimension */
  78083. width: number,
  78084. /** defines height dimension */
  78085. height: number);
  78086. /**
  78087. * Copy from another measure
  78088. * @param other defines the other measure to copy from
  78089. */
  78090. copyFrom(other: Measure): void;
  78091. /**
  78092. * Copy from a group of 4 floats
  78093. * @param left defines left coordinate
  78094. * @param top defines top coordinate
  78095. * @param width defines width dimension
  78096. * @param height defines height dimension
  78097. */
  78098. copyFromFloats(left: number, top: number, width: number, height: number): void;
  78099. /**
  78100. * Computes the axis aligned bounding box measure for two given measures
  78101. * @param a Input measure
  78102. * @param b Input measure
  78103. * @param result the resulting bounding measure
  78104. */
  78105. static CombineToRef(a: Measure, b: Measure, result: Measure): void;
  78106. /**
  78107. * Computes the axis aligned bounding box of the measure after it is modified by a given transform
  78108. * @param transform the matrix to transform the measure before computing the AABB
  78109. * @param addX number to add to left
  78110. * @param addY number to add to top
  78111. * @param addWidth number to add to width
  78112. * @param addHeight number to add to height
  78113. * @param result the resulting AABB
  78114. */
  78115. addAndTransformToRef(transform: Matrix2D, addX: number, addY: number, addWidth: number, addHeight: number, result: Measure): void;
  78116. /**
  78117. * Computes the axis aligned bounding box of the measure after it is modified by a given transform
  78118. * @param transform the matrix to transform the measure before computing the AABB
  78119. * @param result the resulting AABB
  78120. */
  78121. transformToRef(transform: Matrix2D, result: Measure): void;
  78122. /**
  78123. * Check equality between this measure and another one
  78124. * @param other defines the other measures
  78125. * @returns true if both measures are equals
  78126. */
  78127. isEqualsTo(other: Measure): boolean;
  78128. /**
  78129. * Creates an empty measure
  78130. * @returns a new measure
  78131. */
  78132. static Empty(): Measure;
  78133. }
  78134. }
  78135. declare module BABYLON.GUI {
  78136. /**
  78137. * Interface used to define a control that can receive focus
  78138. */
  78139. export interface IFocusableControl {
  78140. /**
  78141. * Function called when the control receives the focus
  78142. */
  78143. onFocus(): void;
  78144. /**
  78145. * Function called when the control loses the focus
  78146. */
  78147. onBlur(): void;
  78148. /**
  78149. * Function called to let the control handle keyboard events
  78150. * @param evt defines the current keyboard event
  78151. */
  78152. processKeyboard(evt: KeyboardEvent): void;
  78153. /**
  78154. * Function called to get the list of controls that should not steal the focus from this control
  78155. * @returns an array of controls
  78156. */
  78157. keepsFocusWith(): BABYLON.Nullable<Control[]>;
  78158. }
  78159. /**
  78160. * Class used to create texture to support 2D GUI elements
  78161. * @see https://doc.babylonjs.com/how_to/gui
  78162. */
  78163. export class AdvancedDynamicTexture extends BABYLON.DynamicTexture {
  78164. private _isDirty;
  78165. private _renderObserver;
  78166. private _resizeObserver;
  78167. private _preKeyboardObserver;
  78168. private _pointerMoveObserver;
  78169. private _pointerObserver;
  78170. private _canvasPointerOutObserver;
  78171. private _canvasBlurObserver;
  78172. private _background;
  78173. /** @hidden */
  78174. _rootContainer: Container;
  78175. /** @hidden */
  78176. _lastPickedControl: Control;
  78177. /** @hidden */
  78178. _lastControlOver: {
  78179. [pointerId: number]: Control;
  78180. };
  78181. /** @hidden */
  78182. _lastControlDown: {
  78183. [pointerId: number]: Control;
  78184. };
  78185. /** @hidden */
  78186. _capturingControl: {
  78187. [pointerId: number]: Control;
  78188. };
  78189. /** @hidden */
  78190. _shouldBlockPointer: boolean;
  78191. /** @hidden */
  78192. _layerToDispose: BABYLON.Nullable<BABYLON.Layer>;
  78193. /** @hidden */
  78194. _linkedControls: Control[];
  78195. private _isFullscreen;
  78196. private _fullscreenViewport;
  78197. private _idealWidth;
  78198. private _idealHeight;
  78199. private _useSmallestIdeal;
  78200. private _renderAtIdealSize;
  78201. private _focusedControl;
  78202. private _blockNextFocusCheck;
  78203. private _renderScale;
  78204. private _rootElement;
  78205. private _cursorChanged;
  78206. private _defaultMousePointerId;
  78207. /** @hidden */
  78208. _numLayoutCalls: number;
  78209. /** Gets the number of layout calls made the last time the ADT has been rendered */
  78210. get numLayoutCalls(): number;
  78211. /** @hidden */
  78212. _numRenderCalls: number;
  78213. /** Gets the number of render calls made the last time the ADT has been rendered */
  78214. get numRenderCalls(): number;
  78215. /**
  78216. * Define type to string to ensure compatibility across browsers
  78217. * Safari doesn't support DataTransfer constructor
  78218. */
  78219. private _clipboardData;
  78220. /**
  78221. * BABYLON.Observable event triggered each time an clipboard event is received from the rendering canvas
  78222. */
  78223. onClipboardObservable: BABYLON.Observable<BABYLON.ClipboardInfo>;
  78224. /**
  78225. * BABYLON.Observable event triggered each time a pointer down is intercepted by a control
  78226. */
  78227. onControlPickedObservable: BABYLON.Observable<Control>;
  78228. /**
  78229. * BABYLON.Observable event triggered before layout is evaluated
  78230. */
  78231. onBeginLayoutObservable: BABYLON.Observable<AdvancedDynamicTexture>;
  78232. /**
  78233. * BABYLON.Observable event triggered after the layout was evaluated
  78234. */
  78235. onEndLayoutObservable: BABYLON.Observable<AdvancedDynamicTexture>;
  78236. /**
  78237. * BABYLON.Observable event triggered before the texture is rendered
  78238. */
  78239. onBeginRenderObservable: BABYLON.Observable<AdvancedDynamicTexture>;
  78240. /**
  78241. * BABYLON.Observable event triggered after the texture was rendered
  78242. */
  78243. onEndRenderObservable: BABYLON.Observable<AdvancedDynamicTexture>;
  78244. /**
  78245. * Gets or sets a boolean defining if alpha is stored as premultiplied
  78246. */
  78247. premulAlpha: boolean;
  78248. /**
  78249. * Gets or sets a number used to scale rendering size (2 means that the texture will be twice bigger).
  78250. * Useful when you want more antialiasing
  78251. */
  78252. get renderScale(): number;
  78253. set renderScale(value: number);
  78254. /** Gets or sets the background color */
  78255. get background(): string;
  78256. set background(value: string);
  78257. /**
  78258. * Gets or sets the ideal width used to design controls.
  78259. * The GUI will then rescale everything accordingly
  78260. * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
  78261. */
  78262. get idealWidth(): number;
  78263. set idealWidth(value: number);
  78264. /**
  78265. * Gets or sets the ideal height used to design controls.
  78266. * The GUI will then rescale everything accordingly
  78267. * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
  78268. */
  78269. get idealHeight(): number;
  78270. set idealHeight(value: number);
  78271. /**
  78272. * Gets or sets a boolean indicating if the smallest ideal value must be used if idealWidth and idealHeight are both set
  78273. * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
  78274. */
  78275. get useSmallestIdeal(): boolean;
  78276. set useSmallestIdeal(value: boolean);
  78277. /**
  78278. * Gets or sets a boolean indicating if adaptive scaling must be used
  78279. * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
  78280. */
  78281. get renderAtIdealSize(): boolean;
  78282. set renderAtIdealSize(value: boolean);
  78283. /**
  78284. * Gets the ratio used when in "ideal mode"
  78285. * @see https://doc.babylonjs.com/how_to/gui#adaptive-scaling
  78286. * */
  78287. get idealRatio(): number;
  78288. /**
  78289. * Gets the underlying layer used to render the texture when in fullscreen mode
  78290. */
  78291. get layer(): BABYLON.Nullable<BABYLON.Layer>;
  78292. /**
  78293. * Gets the root container control
  78294. */
  78295. get rootContainer(): Container;
  78296. /**
  78297. * Returns an array containing the root container.
  78298. * This is mostly used to let the Inspector introspects the ADT
  78299. * @returns an array containing the rootContainer
  78300. */
  78301. getChildren(): Array<Container>;
  78302. /**
  78303. * Will return all controls that are inside this texture
  78304. * @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
  78305. * @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
  78306. * @return all child controls
  78307. */
  78308. getDescendants(directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): Control[];
  78309. /**
  78310. * Gets or sets the current focused control
  78311. */
  78312. get focusedControl(): BABYLON.Nullable<IFocusableControl>;
  78313. set focusedControl(control: BABYLON.Nullable<IFocusableControl>);
  78314. /**
  78315. * Gets or sets a boolean indicating if the texture must be rendered in background or foreground when in fullscreen mode
  78316. */
  78317. get isForeground(): boolean;
  78318. set isForeground(value: boolean);
  78319. /**
  78320. * Gets or set information about clipboardData
  78321. */
  78322. get clipboardData(): string;
  78323. set clipboardData(value: string);
  78324. /**
  78325. * Creates a new AdvancedDynamicTexture
  78326. * @param name defines the name of the texture
  78327. * @param width defines the width of the texture
  78328. * @param height defines the height of the texture
  78329. * @param scene defines the hosting scene
  78330. * @param generateMipMaps defines a boolean indicating if mipmaps must be generated (false by default)
  78331. * @param samplingMode defines the texture sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  78332. * @param invertY defines if the texture needs to be inverted on the y axis during loading (true by default)
  78333. */
  78334. constructor(name: string, width: number | undefined, height: number | undefined, scene: BABYLON.Nullable<BABYLON.Scene>, generateMipMaps?: boolean, samplingMode?: number, invertY?: boolean);
  78335. /**
  78336. * Get the current class name of the texture useful for serialization or dynamic coding.
  78337. * @returns "AdvancedDynamicTexture"
  78338. */
  78339. getClassName(): string;
  78340. /**
  78341. * Function used to execute a function on all controls
  78342. * @param func defines the function to execute
  78343. * @param container defines the container where controls belong. If null the root container will be used
  78344. */
  78345. executeOnAllControls(func: (control: Control) => void, container?: Container): void;
  78346. private _useInvalidateRectOptimization;
  78347. /**
  78348. * Gets or sets a boolean indicating if the InvalidateRect optimization should be turned on
  78349. */
  78350. get useInvalidateRectOptimization(): boolean;
  78351. set useInvalidateRectOptimization(value: boolean);
  78352. private _invalidatedRectangle;
  78353. /**
  78354. * Invalidates a rectangle area on the gui texture
  78355. * @param invalidMinX left most position of the rectangle to invalidate in the texture
  78356. * @param invalidMinY top most position of the rectangle to invalidate in the texture
  78357. * @param invalidMaxX right most position of the rectangle to invalidate in the texture
  78358. * @param invalidMaxY bottom most position of the rectangle to invalidate in the texture
  78359. */
  78360. invalidateRect(invalidMinX: number, invalidMinY: number, invalidMaxX: number, invalidMaxY: number): void;
  78361. /**
  78362. * Marks the texture as dirty forcing a complete update
  78363. */
  78364. markAsDirty(): void;
  78365. /**
  78366. * Helper function used to create a new style
  78367. * @returns a new style
  78368. * @see https://doc.babylonjs.com/how_to/gui#styles
  78369. */
  78370. createStyle(): Style;
  78371. /**
  78372. * Adds a new control to the root container
  78373. * @param control defines the control to add
  78374. * @returns the current texture
  78375. */
  78376. addControl(control: Control): AdvancedDynamicTexture;
  78377. /**
  78378. * Removes a control from the root container
  78379. * @param control defines the control to remove
  78380. * @returns the current texture
  78381. */
  78382. removeControl(control: Control): AdvancedDynamicTexture;
  78383. /**
  78384. * Release all resources
  78385. */
  78386. dispose(): void;
  78387. private _onResize;
  78388. /** @hidden */
  78389. _getGlobalViewport(scene: BABYLON.Scene): BABYLON.Viewport;
  78390. /**
  78391. * Get screen coordinates for a vector3
  78392. * @param position defines the position to project
  78393. * @param worldMatrix defines the world matrix to use
  78394. * @returns the projected position
  78395. */
  78396. getProjectedPosition(position: BABYLON.Vector3, worldMatrix: BABYLON.Matrix): BABYLON.Vector2;
  78397. /**
  78398. * Get screen coordinates for a vector3
  78399. * @param position defines the position to project
  78400. * @param worldMatrix defines the world matrix to use
  78401. * @returns the projected position with Z
  78402. */
  78403. getProjectedPositionWithZ(position: BABYLON.Vector3, worldMatrix: BABYLON.Matrix): BABYLON.Vector3;
  78404. private _checkUpdate;
  78405. private _clearMeasure;
  78406. private _render;
  78407. /** @hidden */
  78408. _changeCursor(cursor: string): void;
  78409. /** @hidden */
  78410. _registerLastControlDown(control: Control, pointerId: number): void;
  78411. private _doPicking;
  78412. /** @hidden */
  78413. _cleanControlAfterRemovalFromList(list: {
  78414. [pointerId: number]: Control;
  78415. }, control: Control): void;
  78416. /** @hidden */
  78417. _cleanControlAfterRemoval(control: Control): void;
  78418. /** Attach to all scene events required to support pointer events */
  78419. attach(): void;
  78420. /** @hidden */
  78421. private onClipboardCopy;
  78422. /** @hidden */
  78423. private onClipboardCut;
  78424. /** @hidden */
  78425. private onClipboardPaste;
  78426. /**
  78427. * Register the clipboard Events onto the canvas
  78428. */
  78429. registerClipboardEvents(): void;
  78430. /**
  78431. * Unregister the clipboard Events from the canvas
  78432. */
  78433. unRegisterClipboardEvents(): void;
  78434. /**
  78435. * Connect the texture to a hosting mesh to enable interactions
  78436. * @param mesh defines the mesh to attach to
  78437. * @param supportPointerMove defines a boolean indicating if pointer move events must be catched as well
  78438. */
  78439. attachToMesh(mesh: BABYLON.AbstractMesh, supportPointerMove?: boolean): void;
  78440. /**
  78441. * Move the focus to a specific control
  78442. * @param control defines the control which will receive the focus
  78443. */
  78444. moveFocusToControl(control: IFocusableControl): void;
  78445. private _manageFocus;
  78446. private _attachToOnPointerOut;
  78447. private _attachToOnBlur;
  78448. /**
  78449. * Creates a new AdvancedDynamicTexture in projected mode (ie. attached to a mesh)
  78450. * @param mesh defines the mesh which will receive the texture
  78451. * @param width defines the texture width (1024 by default)
  78452. * @param height defines the texture height (1024 by default)
  78453. * @param supportPointerMove defines a boolean indicating if the texture must capture move events (true by default)
  78454. * @param onlyAlphaTesting defines a boolean indicating that alpha blending will not be used (only alpha testing) (false by default)
  78455. * @param invertY defines if the texture needs to be inverted on the y axis during loading (true by default)
  78456. * @returns a new AdvancedDynamicTexture
  78457. */
  78458. static CreateForMesh(mesh: BABYLON.AbstractMesh, width?: number, height?: number, supportPointerMove?: boolean, onlyAlphaTesting?: boolean, invertY?: boolean): AdvancedDynamicTexture;
  78459. /**
  78460. * Creates a new AdvancedDynamicTexture in fullscreen mode.
  78461. * In this mode the texture will rely on a layer for its rendering.
  78462. * This allows it to be treated like any other layer.
  78463. * As such, if you have a multi camera setup, you can set the layerMask on the GUI as well.
  78464. * LayerMask is set through advancedTexture.layer.layerMask
  78465. * @param name defines name for the texture
  78466. * @param foreground defines a boolean indicating if the texture must be rendered in foreground (default is true)
  78467. * @param scene defines the hsoting scene
  78468. * @param sampling defines the texture sampling mode (Texture.BILINEAR_SAMPLINGMODE by default)
  78469. * @returns a new AdvancedDynamicTexture
  78470. */
  78471. static CreateFullscreenUI(name: string, foreground?: boolean, scene?: BABYLON.Nullable<BABYLON.Scene>, sampling?: number): AdvancedDynamicTexture;
  78472. }
  78473. }
  78474. declare module BABYLON.GUI {
  78475. /**
  78476. * Root class used for all 2D controls
  78477. * @see https://doc.babylonjs.com/how_to/gui#controls
  78478. */
  78479. export class Control {
  78480. /** defines the name of the control */
  78481. name?: string | undefined;
  78482. /**
  78483. * Gets or sets a boolean indicating if alpha must be an inherited value (false by default)
  78484. */
  78485. static AllowAlphaInheritance: boolean;
  78486. private _alpha;
  78487. private _alphaSet;
  78488. private _zIndex;
  78489. /** @hidden */
  78490. _host: AdvancedDynamicTexture;
  78491. /** Gets or sets the control parent */
  78492. parent: BABYLON.Nullable<Container>;
  78493. /** @hidden */
  78494. _currentMeasure: Measure;
  78495. private _fontFamily;
  78496. private _fontStyle;
  78497. private _fontWeight;
  78498. private _fontSize;
  78499. private _font;
  78500. /** @hidden */
  78501. _width: ValueAndUnit;
  78502. /** @hidden */
  78503. _height: ValueAndUnit;
  78504. /** @hidden */
  78505. protected _fontOffset: {
  78506. ascent: number;
  78507. height: number;
  78508. descent: number;
  78509. };
  78510. private _color;
  78511. private _style;
  78512. private _styleObserver;
  78513. /** @hidden */
  78514. protected _horizontalAlignment: number;
  78515. /** @hidden */
  78516. protected _verticalAlignment: number;
  78517. /** @hidden */
  78518. protected _isDirty: boolean;
  78519. /** @hidden */
  78520. protected _wasDirty: boolean;
  78521. /** @hidden */
  78522. _tempParentMeasure: Measure;
  78523. /** @hidden */
  78524. _prevCurrentMeasureTransformedIntoGlobalSpace: Measure;
  78525. /** @hidden */
  78526. protected _cachedParentMeasure: Measure;
  78527. private _paddingLeft;
  78528. private _paddingRight;
  78529. private _paddingTop;
  78530. private _paddingBottom;
  78531. /** @hidden */
  78532. _left: ValueAndUnit;
  78533. /** @hidden */
  78534. _top: ValueAndUnit;
  78535. private _scaleX;
  78536. private _scaleY;
  78537. private _rotation;
  78538. private _transformCenterX;
  78539. private _transformCenterY;
  78540. /** @hidden */
  78541. _transformMatrix: Matrix2D;
  78542. /** @hidden */
  78543. protected _invertTransformMatrix: Matrix2D;
  78544. /** @hidden */
  78545. protected _transformedPosition: BABYLON.Vector2;
  78546. private _isMatrixDirty;
  78547. private _cachedOffsetX;
  78548. private _cachedOffsetY;
  78549. private _isVisible;
  78550. private _isHighlighted;
  78551. /** @hidden */
  78552. _linkedMesh: BABYLON.Nullable<BABYLON.TransformNode>;
  78553. private _fontSet;
  78554. private _dummyVector2;
  78555. private _downCount;
  78556. private _enterCount;
  78557. private _doNotRender;
  78558. private _downPointerIds;
  78559. protected _isEnabled: boolean;
  78560. protected _disabledColor: string;
  78561. protected _disabledColorItem: string;
  78562. /** @hidden */
  78563. protected _rebuildLayout: boolean;
  78564. /** @hidden */
  78565. _customData: any;
  78566. /** @hidden */
  78567. _isClipped: boolean;
  78568. /** @hidden */
  78569. _automaticSize: boolean;
  78570. /** @hidden */
  78571. _tag: any;
  78572. /**
  78573. * Gets or sets the unique id of the node. Please note that this number will be updated when the control is added to a container
  78574. */
  78575. uniqueId: number;
  78576. /**
  78577. * Gets or sets an object used to store user defined information for the node
  78578. */
  78579. metadata: any;
  78580. /** Gets or sets a boolean indicating if the control can be hit with pointer events */
  78581. isHitTestVisible: boolean;
  78582. /** Gets or sets a boolean indicating if the control can block pointer events */
  78583. isPointerBlocker: boolean;
  78584. /** Gets or sets a boolean indicating if the control can be focusable */
  78585. isFocusInvisible: boolean;
  78586. /**
  78587. * Gets or sets a boolean indicating if the children are clipped to the current control bounds.
  78588. * Please note that not clipping children may generate issues with adt.useInvalidateRectOptimization so it is recommended to turn this optimization off if you want to use unclipped children
  78589. */
  78590. clipChildren: boolean;
  78591. /**
  78592. * Gets or sets a boolean indicating that control content must be clipped
  78593. * Please note that not clipping children may generate issues with adt.useInvalidateRectOptimization so it is recommended to turn this optimization off if you want to use unclipped children
  78594. */
  78595. clipContent: boolean;
  78596. /**
  78597. * Gets or sets a boolean indicating that the current control should cache its rendering (useful when the control does not change often)
  78598. */
  78599. useBitmapCache: boolean;
  78600. private _cacheData;
  78601. private _shadowOffsetX;
  78602. /** Gets or sets a value indicating the offset to apply on X axis to render the shadow */
  78603. get shadowOffsetX(): number;
  78604. set shadowOffsetX(value: number);
  78605. private _shadowOffsetY;
  78606. /** Gets or sets a value indicating the offset to apply on Y axis to render the shadow */
  78607. get shadowOffsetY(): number;
  78608. set shadowOffsetY(value: number);
  78609. private _shadowBlur;
  78610. /** Gets or sets a value indicating the amount of blur to use to render the shadow */
  78611. get shadowBlur(): number;
  78612. set shadowBlur(value: number);
  78613. private _shadowColor;
  78614. /** Gets or sets a value indicating the color of the shadow (black by default ie. "#000") */
  78615. get shadowColor(): string;
  78616. set shadowColor(value: string);
  78617. /** Gets or sets the cursor to use when the control is hovered */
  78618. hoverCursor: string;
  78619. /** @hidden */
  78620. protected _linkOffsetX: ValueAndUnit;
  78621. /** @hidden */
  78622. protected _linkOffsetY: ValueAndUnit;
  78623. /** Gets the control type name */
  78624. get typeName(): string;
  78625. /**
  78626. * Get the current class name of the control.
  78627. * @returns current class name
  78628. */
  78629. getClassName(): string;
  78630. /**
  78631. * An event triggered when pointer wheel is scrolled
  78632. */
  78633. onWheelObservable: BABYLON.Observable<BABYLON.Vector2>;
  78634. /**
  78635. * An event triggered when the pointer move over the control.
  78636. */
  78637. onPointerMoveObservable: BABYLON.Observable<BABYLON.Vector2>;
  78638. /**
  78639. * An event triggered when the pointer move out of the control.
  78640. */
  78641. onPointerOutObservable: BABYLON.Observable<Control>;
  78642. /**
  78643. * An event triggered when the pointer taps the control
  78644. */
  78645. onPointerDownObservable: BABYLON.Observable<Vector2WithInfo>;
  78646. /**
  78647. * An event triggered when pointer up
  78648. */
  78649. onPointerUpObservable: BABYLON.Observable<Vector2WithInfo>;
  78650. /**
  78651. * An event triggered when a control is clicked on
  78652. */
  78653. onPointerClickObservable: BABYLON.Observable<Vector2WithInfo>;
  78654. /**
  78655. * An event triggered when pointer enters the control
  78656. */
  78657. onPointerEnterObservable: BABYLON.Observable<Control>;
  78658. /**
  78659. * An event triggered when the control is marked as dirty
  78660. */
  78661. onDirtyObservable: BABYLON.Observable<Control>;
  78662. /**
  78663. * An event triggered before drawing the control
  78664. */
  78665. onBeforeDrawObservable: BABYLON.Observable<Control>;
  78666. /**
  78667. * An event triggered after the control was drawn
  78668. */
  78669. onAfterDrawObservable: BABYLON.Observable<Control>;
  78670. /**
  78671. * An event triggered when the control has been disposed
  78672. */
  78673. onDisposeObservable: BABYLON.Observable<Control>;
  78674. /**
  78675. * Get the hosting AdvancedDynamicTexture
  78676. */
  78677. get host(): AdvancedDynamicTexture;
  78678. /** Gets or set information about font offsets (used to render and align text) */
  78679. get fontOffset(): {
  78680. ascent: number;
  78681. height: number;
  78682. descent: number;
  78683. };
  78684. set fontOffset(offset: {
  78685. ascent: number;
  78686. height: number;
  78687. descent: number;
  78688. });
  78689. /** Gets or sets alpha value for the control (1 means opaque and 0 means entirely transparent) */
  78690. get alpha(): number;
  78691. set alpha(value: number);
  78692. /**
  78693. * Gets or sets a boolean indicating that we want to highlight the control (mostly for debugging purpose)
  78694. */
  78695. get isHighlighted(): boolean;
  78696. set isHighlighted(value: boolean);
  78697. /** Gets or sets a value indicating the scale factor on X axis (1 by default)
  78698. * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
  78699. */
  78700. get scaleX(): number;
  78701. set scaleX(value: number);
  78702. /** Gets or sets a value indicating the scale factor on Y axis (1 by default)
  78703. * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
  78704. */
  78705. get scaleY(): number;
  78706. set scaleY(value: number);
  78707. /** Gets or sets the rotation angle (0 by default)
  78708. * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
  78709. */
  78710. get rotation(): number;
  78711. set rotation(value: number);
  78712. /** Gets or sets the transformation center on Y axis (0 by default)
  78713. * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
  78714. */
  78715. get transformCenterY(): number;
  78716. set transformCenterY(value: number);
  78717. /** Gets or sets the transformation center on X axis (0 by default)
  78718. * @see https://doc.babylonjs.com/how_to/gui#rotation-and-scaling
  78719. */
  78720. get transformCenterX(): number;
  78721. set transformCenterX(value: number);
  78722. /**
  78723. * Gets or sets the horizontal alignment
  78724. * @see https://doc.babylonjs.com/how_to/gui#alignments
  78725. */
  78726. get horizontalAlignment(): number;
  78727. set horizontalAlignment(value: number);
  78728. /**
  78729. * Gets or sets the vertical alignment
  78730. * @see https://doc.babylonjs.com/how_to/gui#alignments
  78731. */
  78732. get verticalAlignment(): number;
  78733. set verticalAlignment(value: number);
  78734. /**
  78735. * Gets or sets a fixed ratio for this control.
  78736. * When different from 0, the ratio is used to compute the "second" dimension.
  78737. * The first dimension used in the computation is the last one set (by setting width / widthInPixels or height / heightInPixels), and the
  78738. * second dimension is computed as first dimension * fixedRatio
  78739. */
  78740. fixedRatio: number;
  78741. private _fixedRatioMasterIsWidth;
  78742. /**
  78743. * Gets or sets control width
  78744. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78745. */
  78746. get width(): string | number;
  78747. set width(value: string | number);
  78748. /**
  78749. * Gets or sets the control width in pixel
  78750. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78751. */
  78752. get widthInPixels(): number;
  78753. set widthInPixels(value: number);
  78754. /**
  78755. * Gets or sets control height
  78756. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78757. */
  78758. get height(): string | number;
  78759. set height(value: string | number);
  78760. /**
  78761. * Gets or sets control height in pixel
  78762. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78763. */
  78764. get heightInPixels(): number;
  78765. set heightInPixels(value: number);
  78766. /** Gets or set font family */
  78767. get fontFamily(): string;
  78768. set fontFamily(value: string);
  78769. /** Gets or sets font style */
  78770. get fontStyle(): string;
  78771. set fontStyle(value: string);
  78772. /** Gets or sets font weight */
  78773. get fontWeight(): string;
  78774. set fontWeight(value: string);
  78775. /**
  78776. * Gets or sets style
  78777. * @see https://doc.babylonjs.com/how_to/gui#styles
  78778. */
  78779. get style(): BABYLON.Nullable<Style>;
  78780. set style(value: BABYLON.Nullable<Style>);
  78781. /** @hidden */
  78782. get _isFontSizeInPercentage(): boolean;
  78783. /** Gets or sets font size in pixels */
  78784. get fontSizeInPixels(): number;
  78785. set fontSizeInPixels(value: number);
  78786. /** Gets or sets font size */
  78787. get fontSize(): string | number;
  78788. set fontSize(value: string | number);
  78789. /** Gets or sets foreground color */
  78790. get color(): string;
  78791. set color(value: string);
  78792. /** Gets or sets z index which is used to reorder controls on the z axis */
  78793. get zIndex(): number;
  78794. set zIndex(value: number);
  78795. /** Gets or sets a boolean indicating if the control can be rendered */
  78796. get notRenderable(): boolean;
  78797. set notRenderable(value: boolean);
  78798. /** Gets or sets a boolean indicating if the control is visible */
  78799. get isVisible(): boolean;
  78800. set isVisible(value: boolean);
  78801. /** Gets a boolean indicating that the control needs to update its rendering */
  78802. get isDirty(): boolean;
  78803. /**
  78804. * Gets the current linked mesh (or null if none)
  78805. */
  78806. get linkedMesh(): BABYLON.Nullable<BABYLON.TransformNode>;
  78807. /**
  78808. * Gets or sets a value indicating the padding to use on the left of the control
  78809. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78810. */
  78811. get paddingLeft(): string | number;
  78812. set paddingLeft(value: string | number);
  78813. /**
  78814. * Gets or sets a value indicating the padding in pixels to use on the left of the control
  78815. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78816. */
  78817. get paddingLeftInPixels(): number;
  78818. set paddingLeftInPixels(value: number);
  78819. /**
  78820. * Gets or sets a value indicating the padding to use on the right of the control
  78821. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78822. */
  78823. get paddingRight(): string | number;
  78824. set paddingRight(value: string | number);
  78825. /**
  78826. * Gets or sets a value indicating the padding in pixels to use on the right of the control
  78827. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78828. */
  78829. get paddingRightInPixels(): number;
  78830. set paddingRightInPixels(value: number);
  78831. /**
  78832. * Gets or sets a value indicating the padding to use on the top of the control
  78833. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78834. */
  78835. get paddingTop(): string | number;
  78836. set paddingTop(value: string | number);
  78837. /**
  78838. * Gets or sets a value indicating the padding in pixels to use on the top of the control
  78839. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78840. */
  78841. get paddingTopInPixels(): number;
  78842. set paddingTopInPixels(value: number);
  78843. /**
  78844. * Gets or sets a value indicating the padding to use on the bottom of the control
  78845. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78846. */
  78847. get paddingBottom(): string | number;
  78848. set paddingBottom(value: string | number);
  78849. /**
  78850. * Gets or sets a value indicating the padding in pixels to use on the bottom of the control
  78851. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78852. */
  78853. get paddingBottomInPixels(): number;
  78854. set paddingBottomInPixels(value: number);
  78855. /**
  78856. * Gets or sets a value indicating the left coordinate of the control
  78857. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78858. */
  78859. get left(): string | number;
  78860. set left(value: string | number);
  78861. /**
  78862. * Gets or sets a value indicating the left coordinate in pixels of the control
  78863. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78864. */
  78865. get leftInPixels(): number;
  78866. set leftInPixels(value: number);
  78867. /**
  78868. * Gets or sets a value indicating the top coordinate of the control
  78869. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78870. */
  78871. get top(): string | number;
  78872. set top(value: string | number);
  78873. /**
  78874. * Gets or sets a value indicating the top coordinate in pixels of the control
  78875. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  78876. */
  78877. get topInPixels(): number;
  78878. set topInPixels(value: number);
  78879. /**
  78880. * Gets or sets a value indicating the offset on X axis to the linked mesh
  78881. * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
  78882. */
  78883. get linkOffsetX(): string | number;
  78884. set linkOffsetX(value: string | number);
  78885. /**
  78886. * Gets or sets a value indicating the offset in pixels on X axis to the linked mesh
  78887. * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
  78888. */
  78889. get linkOffsetXInPixels(): number;
  78890. set linkOffsetXInPixels(value: number);
  78891. /**
  78892. * Gets or sets a value indicating the offset on Y axis to the linked mesh
  78893. * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
  78894. */
  78895. get linkOffsetY(): string | number;
  78896. set linkOffsetY(value: string | number);
  78897. /**
  78898. * Gets or sets a value indicating the offset in pixels on Y axis to the linked mesh
  78899. * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
  78900. */
  78901. get linkOffsetYInPixels(): number;
  78902. set linkOffsetYInPixels(value: number);
  78903. /** Gets the center coordinate on X axis */
  78904. get centerX(): number;
  78905. /** Gets the center coordinate on Y axis */
  78906. get centerY(): number;
  78907. /** Gets or sets if control is Enabled*/
  78908. get isEnabled(): boolean;
  78909. set isEnabled(value: boolean);
  78910. /** Gets or sets background color of control if it's disabled*/
  78911. get disabledColor(): string;
  78912. set disabledColor(value: string);
  78913. /** Gets or sets front color of control if it's disabled*/
  78914. get disabledColorItem(): string;
  78915. set disabledColorItem(value: string);
  78916. /**
  78917. * Creates a new control
  78918. * @param name defines the name of the control
  78919. */
  78920. constructor(
  78921. /** defines the name of the control */
  78922. name?: string | undefined);
  78923. /** @hidden */
  78924. protected _getTypeName(): string;
  78925. /**
  78926. * Gets the first ascendant in the hierarchy of the given type
  78927. * @param className defines the required type
  78928. * @returns the ascendant or null if not found
  78929. */
  78930. getAscendantOfClass(className: string): BABYLON.Nullable<Control>;
  78931. /** @hidden */
  78932. _resetFontCache(): void;
  78933. /**
  78934. * Determines if a container is an ascendant of the current control
  78935. * @param container defines the container to look for
  78936. * @returns true if the container is one of the ascendant of the control
  78937. */
  78938. isAscendant(container: Control): boolean;
  78939. /**
  78940. * Gets coordinates in local control space
  78941. * @param globalCoordinates defines the coordinates to transform
  78942. * @returns the new coordinates in local space
  78943. */
  78944. getLocalCoordinates(globalCoordinates: BABYLON.Vector2): BABYLON.Vector2;
  78945. /**
  78946. * Gets coordinates in local control space
  78947. * @param globalCoordinates defines the coordinates to transform
  78948. * @param result defines the target vector2 where to store the result
  78949. * @returns the current control
  78950. */
  78951. getLocalCoordinatesToRef(globalCoordinates: BABYLON.Vector2, result: BABYLON.Vector2): Control;
  78952. /**
  78953. * Gets coordinates in parent local control space
  78954. * @param globalCoordinates defines the coordinates to transform
  78955. * @returns the new coordinates in parent local space
  78956. */
  78957. getParentLocalCoordinates(globalCoordinates: BABYLON.Vector2): BABYLON.Vector2;
  78958. /**
  78959. * Move the current control to a vector3 position projected onto the screen.
  78960. * @param position defines the target position
  78961. * @param scene defines the hosting scene
  78962. */
  78963. moveToVector3(position: BABYLON.Vector3, scene: BABYLON.Scene): void;
  78964. /**
  78965. * Will store all controls that have this control as ascendant in a given array
  78966. * @param results defines the array where to store the descendants
  78967. * @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
  78968. * @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
  78969. */
  78970. getDescendantsToRef(results: Control[], directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): void;
  78971. /**
  78972. * Will return all controls that have this control as ascendant
  78973. * @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
  78974. * @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
  78975. * @return all child controls
  78976. */
  78977. getDescendants(directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): Control[];
  78978. /**
  78979. * Link current control with a target mesh
  78980. * @param mesh defines the mesh to link with
  78981. * @see https://doc.babylonjs.com/how_to/gui#tracking-positions
  78982. */
  78983. linkWithMesh(mesh: BABYLON.Nullable<BABYLON.TransformNode>): void;
  78984. /** @hidden */
  78985. _moveToProjectedPosition(projectedPosition: BABYLON.Vector3): void;
  78986. /** @hidden */
  78987. _offsetLeft(offset: number): void;
  78988. /** @hidden */
  78989. _offsetTop(offset: number): void;
  78990. /** @hidden */
  78991. _markMatrixAsDirty(): void;
  78992. /** @hidden */
  78993. _flagDescendantsAsMatrixDirty(): void;
  78994. /** @hidden */
  78995. _intersectsRect(rect: Measure): boolean;
  78996. /** @hidden */
  78997. protected invalidateRect(): void;
  78998. /** @hidden */
  78999. _markAsDirty(force?: boolean): void;
  79000. /** @hidden */
  79001. _markAllAsDirty(): void;
  79002. /** @hidden */
  79003. _link(host: AdvancedDynamicTexture): void;
  79004. /** @hidden */
  79005. protected _transform(context?: CanvasRenderingContext2D): void;
  79006. /** @hidden */
  79007. _renderHighlight(context: CanvasRenderingContext2D): void;
  79008. /** @hidden */
  79009. _renderHighlightSpecific(context: CanvasRenderingContext2D): void;
  79010. /** @hidden */
  79011. protected _applyStates(context: CanvasRenderingContext2D): void;
  79012. /** @hidden */
  79013. _layout(parentMeasure: Measure, context: CanvasRenderingContext2D): boolean;
  79014. /** @hidden */
  79015. protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  79016. protected _evaluateClippingState(parentMeasure: Measure): void;
  79017. /** @hidden */
  79018. _measure(): void;
  79019. /** @hidden */
  79020. protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  79021. /** @hidden */
  79022. protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  79023. /** @hidden */
  79024. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  79025. /** @hidden */
  79026. protected _clipForChildren(context: CanvasRenderingContext2D): void;
  79027. private static _ClipMeasure;
  79028. private _tmpMeasureA;
  79029. private _clip;
  79030. /** @hidden */
  79031. _render(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): boolean;
  79032. /** @hidden */
  79033. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  79034. /**
  79035. * Tests if a given coordinates belong to the current control
  79036. * @param x defines x coordinate to test
  79037. * @param y defines y coordinate to test
  79038. * @returns true if the coordinates are inside the control
  79039. */
  79040. contains(x: number, y: number): boolean;
  79041. /** @hidden */
  79042. _processPicking(x: number, y: number, pi: BABYLON.PointerInfoBase, type: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
  79043. /** @hidden */
  79044. _onPointerMove(target: Control, coordinates: BABYLON.Vector2, pointerId: number, pi: BABYLON.PointerInfoBase): void;
  79045. /** @hidden */
  79046. _onPointerEnter(target: Control, pi: BABYLON.PointerInfoBase): boolean;
  79047. /** @hidden */
  79048. _onPointerOut(target: Control, pi: BABYLON.Nullable<BABYLON.PointerInfoBase>, force?: boolean): void;
  79049. /** @hidden */
  79050. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
  79051. /** @hidden */
  79052. _onPointerUp(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean, pi?: BABYLON.PointerInfoBase): void;
  79053. /** @hidden */
  79054. _forcePointerUp(pointerId?: BABYLON.Nullable<number>): void;
  79055. /** @hidden */
  79056. _onWheelScroll(deltaX?: number, deltaY?: number): void;
  79057. /** @hidden */
  79058. _onCanvasBlur(): void;
  79059. /** @hidden */
  79060. _processObservables(type: number, x: number, y: number, pi: BABYLON.PointerInfoBase, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
  79061. private _prepareFont;
  79062. /** Releases associated resources */
  79063. dispose(): void;
  79064. private static _HORIZONTAL_ALIGNMENT_LEFT;
  79065. private static _HORIZONTAL_ALIGNMENT_RIGHT;
  79066. private static _HORIZONTAL_ALIGNMENT_CENTER;
  79067. private static _VERTICAL_ALIGNMENT_TOP;
  79068. private static _VERTICAL_ALIGNMENT_BOTTOM;
  79069. private static _VERTICAL_ALIGNMENT_CENTER;
  79070. /** HORIZONTAL_ALIGNMENT_LEFT */
  79071. static get HORIZONTAL_ALIGNMENT_LEFT(): number;
  79072. /** HORIZONTAL_ALIGNMENT_RIGHT */
  79073. static get HORIZONTAL_ALIGNMENT_RIGHT(): number;
  79074. /** HORIZONTAL_ALIGNMENT_CENTER */
  79075. static get HORIZONTAL_ALIGNMENT_CENTER(): number;
  79076. /** VERTICAL_ALIGNMENT_TOP */
  79077. static get VERTICAL_ALIGNMENT_TOP(): number;
  79078. /** VERTICAL_ALIGNMENT_BOTTOM */
  79079. static get VERTICAL_ALIGNMENT_BOTTOM(): number;
  79080. /** VERTICAL_ALIGNMENT_CENTER */
  79081. static get VERTICAL_ALIGNMENT_CENTER(): number;
  79082. private static _FontHeightSizes;
  79083. /** @hidden */
  79084. static _GetFontOffset(font: string): {
  79085. ascent: number;
  79086. height: number;
  79087. descent: number;
  79088. };
  79089. /**
  79090. * Creates a stack panel that can be used to render headers
  79091. * @param control defines the control to associate with the header
  79092. * @param text defines the text of the header
  79093. * @param size defines the size of the header
  79094. * @param options defines options used to configure the header
  79095. * @returns a new StackPanel
  79096. * @ignore
  79097. * @hidden
  79098. */
  79099. static AddHeader: (control: Control, text: string, size: string | number, options: {
  79100. isHorizontal: boolean;
  79101. controlFirst: boolean;
  79102. }) => any;
  79103. /** @hidden */
  79104. protected static drawEllipse(x: number, y: number, width: number, height: number, context: CanvasRenderingContext2D): void;
  79105. }
  79106. }
  79107. declare module BABYLON.GUI {
  79108. /**
  79109. * Root class for 2D containers
  79110. * @see https://doc.babylonjs.com/how_to/gui#containers
  79111. */
  79112. export class Container extends Control {
  79113. name?: string | undefined;
  79114. /** @hidden */
  79115. _children: Control[];
  79116. /** @hidden */
  79117. protected _measureForChildren: Measure;
  79118. /** @hidden */
  79119. protected _background: string;
  79120. /** @hidden */
  79121. protected _adaptWidthToChildren: boolean;
  79122. /** @hidden */
  79123. protected _adaptHeightToChildren: boolean;
  79124. /**
  79125. * Gets or sets a boolean indicating that layout cycle errors should be displayed on the console
  79126. */
  79127. logLayoutCycleErrors: boolean;
  79128. /**
  79129. * Gets or sets the number of layout cycles (a change involved by a control while evaluating the layout) allowed
  79130. */
  79131. maxLayoutCycle: number;
  79132. /** Gets or sets a boolean indicating if the container should try to adapt to its children height */
  79133. get adaptHeightToChildren(): boolean;
  79134. set adaptHeightToChildren(value: boolean);
  79135. /** Gets or sets a boolean indicating if the container should try to adapt to its children width */
  79136. get adaptWidthToChildren(): boolean;
  79137. set adaptWidthToChildren(value: boolean);
  79138. /** Gets or sets background color */
  79139. get background(): string;
  79140. set background(value: string);
  79141. /** Gets the list of children */
  79142. get children(): Control[];
  79143. /**
  79144. * Creates a new Container
  79145. * @param name defines the name of the container
  79146. */
  79147. constructor(name?: string | undefined);
  79148. protected _getTypeName(): string;
  79149. _flagDescendantsAsMatrixDirty(): void;
  79150. /**
  79151. * Gets a child using its name
  79152. * @param name defines the child name to look for
  79153. * @returns the child control if found
  79154. */
  79155. getChildByName(name: string): BABYLON.Nullable<Control>;
  79156. /**
  79157. * Gets a child using its type and its name
  79158. * @param name defines the child name to look for
  79159. * @param type defines the child type to look for
  79160. * @returns the child control if found
  79161. */
  79162. getChildByType(name: string, type: string): BABYLON.Nullable<Control>;
  79163. /**
  79164. * Search for a specific control in children
  79165. * @param control defines the control to look for
  79166. * @returns true if the control is in child list
  79167. */
  79168. containsControl(control: Control): boolean;
  79169. /**
  79170. * Adds a new control to the current container
  79171. * @param control defines the control to add
  79172. * @returns the current container
  79173. */
  79174. addControl(control: BABYLON.Nullable<Control>): Container;
  79175. /**
  79176. * Removes all controls from the current container
  79177. * @returns the current container
  79178. */
  79179. clearControls(): Container;
  79180. /**
  79181. * Removes a control from the current container
  79182. * @param control defines the control to remove
  79183. * @returns the current container
  79184. */
  79185. removeControl(control: Control): Container;
  79186. /** @hidden */
  79187. _reOrderControl(control: Control): void;
  79188. /** @hidden */
  79189. _offsetLeft(offset: number): void;
  79190. /** @hidden */
  79191. _offsetTop(offset: number): void;
  79192. /** @hidden */
  79193. _markAllAsDirty(): void;
  79194. /** @hidden */
  79195. protected _localDraw(context: CanvasRenderingContext2D): void;
  79196. /** @hidden */
  79197. _link(host: AdvancedDynamicTexture): void;
  79198. /** @hidden */
  79199. protected _beforeLayout(): void;
  79200. /** @hidden */
  79201. protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  79202. /** @hidden */
  79203. _layout(parentMeasure: Measure, context: CanvasRenderingContext2D): boolean;
  79204. protected _postMeasure(): void;
  79205. /** @hidden */
  79206. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Measure): void;
  79207. getDescendantsToRef(results: Control[], directDescendantsOnly?: boolean, predicate?: (control: Control) => boolean): void;
  79208. /** @hidden */
  79209. _processPicking(x: number, y: number, pi: BABYLON.PointerInfoBase, type: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
  79210. /** @hidden */
  79211. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  79212. /** Releases associated resources */
  79213. dispose(): void;
  79214. }
  79215. }
  79216. declare module BABYLON.GUI {
  79217. /** Class used to create rectangle container */
  79218. export class Rectangle extends Container {
  79219. name?: string | undefined;
  79220. private _thickness;
  79221. private _cornerRadius;
  79222. /** Gets or sets border thickness */
  79223. get thickness(): number;
  79224. set thickness(value: number);
  79225. /** Gets or sets the corner radius angle */
  79226. get cornerRadius(): number;
  79227. set cornerRadius(value: number);
  79228. /**
  79229. * Creates a new Rectangle
  79230. * @param name defines the control name
  79231. */
  79232. constructor(name?: string | undefined);
  79233. protected _getTypeName(): string;
  79234. protected _localDraw(context: CanvasRenderingContext2D): void;
  79235. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  79236. private _drawRoundedRect;
  79237. protected _clipForChildren(context: CanvasRenderingContext2D): void;
  79238. }
  79239. }
  79240. declare module BABYLON.GUI {
  79241. /**
  79242. * Enum that determines the text-wrapping mode to use.
  79243. */
  79244. export enum TextWrapping {
  79245. /**
  79246. * Clip the text when it's larger than Control.width; this is the default mode.
  79247. */
  79248. Clip = 0,
  79249. /**
  79250. * Wrap the text word-wise, i.e. try to add line-breaks at word boundary to fit within Control.width.
  79251. */
  79252. WordWrap = 1,
  79253. /**
  79254. * Ellipsize the text, i.e. shrink with trailing … when text is larger than Control.width.
  79255. */
  79256. Ellipsis = 2
  79257. }
  79258. /**
  79259. * Class used to create text block control
  79260. */
  79261. export class TextBlock extends Control {
  79262. /**
  79263. * Defines the name of the control
  79264. */
  79265. name?: string | undefined;
  79266. private _text;
  79267. private _textWrapping;
  79268. private _textHorizontalAlignment;
  79269. private _textVerticalAlignment;
  79270. private _lines;
  79271. private _resizeToFit;
  79272. private _lineSpacing;
  79273. private _outlineWidth;
  79274. private _outlineColor;
  79275. private _underline;
  79276. private _lineThrough;
  79277. /**
  79278. * An event triggered after the text is changed
  79279. */
  79280. onTextChangedObservable: BABYLON.Observable<TextBlock>;
  79281. /**
  79282. * An event triggered after the text was broken up into lines
  79283. */
  79284. onLinesReadyObservable: BABYLON.Observable<TextBlock>;
  79285. /**
  79286. * Function used to split a string into words. By default, a string is split at each space character found
  79287. */
  79288. wordSplittingFunction: BABYLON.Nullable<(line: string) => string[]>;
  79289. /**
  79290. * Return the line list (you may need to use the onLinesReadyObservable to make sure the list is ready)
  79291. */
  79292. get lines(): any[];
  79293. /**
  79294. * Gets or sets an boolean indicating that the TextBlock will be resized to fit container
  79295. */
  79296. get resizeToFit(): boolean;
  79297. /**
  79298. * Gets or sets an boolean indicating that the TextBlock will be resized to fit container
  79299. */
  79300. set resizeToFit(value: boolean);
  79301. /**
  79302. * Gets or sets a boolean indicating if text must be wrapped
  79303. */
  79304. get textWrapping(): TextWrapping | boolean;
  79305. /**
  79306. * Gets or sets a boolean indicating if text must be wrapped
  79307. */
  79308. set textWrapping(value: TextWrapping | boolean);
  79309. /**
  79310. * Gets or sets text to display
  79311. */
  79312. get text(): string;
  79313. /**
  79314. * Gets or sets text to display
  79315. */
  79316. set text(value: string);
  79317. /**
  79318. * Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
  79319. */
  79320. get textHorizontalAlignment(): number;
  79321. /**
  79322. * Gets or sets text horizontal alignment (BABYLON.GUI.Control.HORIZONTAL_ALIGNMENT_CENTER by default)
  79323. */
  79324. set textHorizontalAlignment(value: number);
  79325. /**
  79326. * Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
  79327. */
  79328. get textVerticalAlignment(): number;
  79329. /**
  79330. * Gets or sets text vertical alignment (BABYLON.GUI.Control.VERTICAL_ALIGNMENT_CENTER by default)
  79331. */
  79332. set textVerticalAlignment(value: number);
  79333. /**
  79334. * Gets or sets line spacing value
  79335. */
  79336. set lineSpacing(value: string | number);
  79337. /**
  79338. * Gets or sets line spacing value
  79339. */
  79340. get lineSpacing(): string | number;
  79341. /**
  79342. * Gets or sets outlineWidth of the text to display
  79343. */
  79344. get outlineWidth(): number;
  79345. /**
  79346. * Gets or sets outlineWidth of the text to display
  79347. */
  79348. set outlineWidth(value: number);
  79349. /**
  79350. * Gets or sets a boolean indicating that text must have underline
  79351. */
  79352. get underline(): boolean;
  79353. /**
  79354. * Gets or sets a boolean indicating that text must have underline
  79355. */
  79356. set underline(value: boolean);
  79357. /**
  79358. * Gets or sets an boolean indicating that text must be crossed out
  79359. */
  79360. get lineThrough(): boolean;
  79361. /**
  79362. * Gets or sets an boolean indicating that text must be crossed out
  79363. */
  79364. set lineThrough(value: boolean);
  79365. /**
  79366. * Gets or sets outlineColor of the text to display
  79367. */
  79368. get outlineColor(): string;
  79369. /**
  79370. * Gets or sets outlineColor of the text to display
  79371. */
  79372. set outlineColor(value: string);
  79373. /**
  79374. * Creates a new TextBlock object
  79375. * @param name defines the name of the control
  79376. * @param text defines the text to display (emptry string by default)
  79377. */
  79378. constructor(
  79379. /**
  79380. * Defines the name of the control
  79381. */
  79382. name?: string | undefined, text?: string);
  79383. protected _getTypeName(): string;
  79384. protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  79385. private _drawText;
  79386. /** @hidden */
  79387. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  79388. protected _applyStates(context: CanvasRenderingContext2D): void;
  79389. protected _breakLines(refWidth: number, context: CanvasRenderingContext2D): object[];
  79390. protected _parseLine(line: string | undefined, context: CanvasRenderingContext2D): object;
  79391. protected _parseLineEllipsis(line: string | undefined, width: number, context: CanvasRenderingContext2D): object;
  79392. protected _parseLineWordWrap(line: string | undefined, width: number, context: CanvasRenderingContext2D): object[];
  79393. protected _renderLines(context: CanvasRenderingContext2D): void;
  79394. /**
  79395. * Given a width constraint applied on the text block, find the expected height
  79396. * @returns expected height
  79397. */
  79398. computeExpectedHeight(): number;
  79399. dispose(): void;
  79400. }
  79401. }
  79402. declare module BABYLON.GUI {
  79403. /**
  79404. * Class used to create 2D images
  79405. */
  79406. export class Image extends Control {
  79407. name?: string | undefined;
  79408. private _workingCanvas;
  79409. private _domImage;
  79410. private _imageWidth;
  79411. private _imageHeight;
  79412. private _loaded;
  79413. private _stretch;
  79414. private _source;
  79415. private _autoScale;
  79416. private _sourceLeft;
  79417. private _sourceTop;
  79418. private _sourceWidth;
  79419. private _sourceHeight;
  79420. private _svgAttributesComputationCompleted;
  79421. private _isSVG;
  79422. private _cellWidth;
  79423. private _cellHeight;
  79424. private _cellId;
  79425. private _populateNinePatchSlicesFromImage;
  79426. private _sliceLeft;
  79427. private _sliceRight;
  79428. private _sliceTop;
  79429. private _sliceBottom;
  79430. private _detectPointerOnOpaqueOnly;
  79431. private _imageDataCache;
  79432. /**
  79433. * BABYLON.Observable notified when the content is loaded
  79434. */
  79435. onImageLoadedObservable: BABYLON.Observable<Image>;
  79436. /**
  79437. * BABYLON.Observable notified when _sourceLeft, _sourceTop, _sourceWidth and _sourceHeight are computed
  79438. */
  79439. onSVGAttributesComputedObservable: BABYLON.Observable<Image>;
  79440. /**
  79441. * Gets a boolean indicating that the content is loaded
  79442. */
  79443. get isLoaded(): boolean;
  79444. /**
  79445. * Gets or sets a boolean indicating if nine patch slices (left, top, right, bottom) should be read from image data
  79446. */
  79447. get populateNinePatchSlicesFromImage(): boolean;
  79448. set populateNinePatchSlicesFromImage(value: boolean);
  79449. /**
  79450. * Gets or sets a boolean indicating if pointers should only be validated on pixels with alpha > 0.
  79451. * Beware using this as this will comsume more memory as the image has to be stored twice
  79452. */
  79453. get detectPointerOnOpaqueOnly(): boolean;
  79454. set detectPointerOnOpaqueOnly(value: boolean);
  79455. /**
  79456. * Gets or sets the left value for slicing (9-patch)
  79457. */
  79458. get sliceLeft(): number;
  79459. set sliceLeft(value: number);
  79460. /**
  79461. * Gets or sets the right value for slicing (9-patch)
  79462. */
  79463. get sliceRight(): number;
  79464. set sliceRight(value: number);
  79465. /**
  79466. * Gets or sets the top value for slicing (9-patch)
  79467. */
  79468. get sliceTop(): number;
  79469. set sliceTop(value: number);
  79470. /**
  79471. * Gets or sets the bottom value for slicing (9-patch)
  79472. */
  79473. get sliceBottom(): number;
  79474. set sliceBottom(value: number);
  79475. /**
  79476. * Gets or sets the left coordinate in the source image
  79477. */
  79478. get sourceLeft(): number;
  79479. set sourceLeft(value: number);
  79480. /**
  79481. * Gets or sets the top coordinate in the source image
  79482. */
  79483. get sourceTop(): number;
  79484. set sourceTop(value: number);
  79485. /**
  79486. * Gets or sets the width to capture in the source image
  79487. */
  79488. get sourceWidth(): number;
  79489. set sourceWidth(value: number);
  79490. /**
  79491. * Gets or sets the height to capture in the source image
  79492. */
  79493. get sourceHeight(): number;
  79494. set sourceHeight(value: number);
  79495. /** Indicates if the format of the image is SVG */
  79496. get isSVG(): boolean;
  79497. /** Gets the status of the SVG attributes computation (sourceLeft, sourceTop, sourceWidth, sourceHeight) */
  79498. get svgAttributesComputationCompleted(): boolean;
  79499. /**
  79500. * Gets or sets a boolean indicating if the image can force its container to adapt its size
  79501. * @see https://doc.babylonjs.com/how_to/gui#image
  79502. */
  79503. get autoScale(): boolean;
  79504. set autoScale(value: boolean);
  79505. /** Gets or sets the streching mode used by the image */
  79506. get stretch(): number;
  79507. set stretch(value: number);
  79508. /** @hidden */
  79509. _rotate90(n: number, preserveProperties?: boolean): Image;
  79510. private _handleRotationForSVGImage;
  79511. private _rotate90SourceProperties;
  79512. /**
  79513. * Gets or sets the internal DOM image used to render the control
  79514. */
  79515. set domImage(value: HTMLImageElement);
  79516. get domImage(): HTMLImageElement;
  79517. private _onImageLoaded;
  79518. private _extractNinePatchSliceDataFromImage;
  79519. /**
  79520. * Gets or sets image source url
  79521. */
  79522. set source(value: BABYLON.Nullable<string>);
  79523. /**
  79524. * Checks for svg document with icon id present
  79525. */
  79526. private _svgCheck;
  79527. /**
  79528. * Sets sourceLeft, sourceTop, sourceWidth, sourceHeight automatically
  79529. * given external svg file and icon id
  79530. */
  79531. private _getSVGAttribs;
  79532. /**
  79533. * Gets or sets the cell width to use when animation sheet is enabled
  79534. * @see https://doc.babylonjs.com/how_to/gui#image
  79535. */
  79536. get cellWidth(): number;
  79537. set cellWidth(value: number);
  79538. /**
  79539. * Gets or sets the cell height to use when animation sheet is enabled
  79540. * @see https://doc.babylonjs.com/how_to/gui#image
  79541. */
  79542. get cellHeight(): number;
  79543. set cellHeight(value: number);
  79544. /**
  79545. * Gets or sets the cell id to use (this will turn on the animation sheet mode)
  79546. * @see https://doc.babylonjs.com/how_to/gui#image
  79547. */
  79548. get cellId(): number;
  79549. set cellId(value: number);
  79550. /**
  79551. * Creates a new Image
  79552. * @param name defines the control name
  79553. * @param url defines the image url
  79554. */
  79555. constructor(name?: string | undefined, url?: BABYLON.Nullable<string>);
  79556. /**
  79557. * Tests if a given coordinates belong to the current control
  79558. * @param x defines x coordinate to test
  79559. * @param y defines y coordinate to test
  79560. * @returns true if the coordinates are inside the control
  79561. */
  79562. contains(x: number, y: number): boolean;
  79563. protected _getTypeName(): string;
  79564. /** Force the control to synchronize with its content */
  79565. synchronizeSizeWithContent(): void;
  79566. protected _processMeasures(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  79567. private _prepareWorkingCanvasForOpaqueDetection;
  79568. private _drawImage;
  79569. _draw(context: CanvasRenderingContext2D): void;
  79570. private _renderCornerPatch;
  79571. private _renderNinePatch;
  79572. dispose(): void;
  79573. /** STRETCH_NONE */
  79574. static readonly STRETCH_NONE: number;
  79575. /** STRETCH_FILL */
  79576. static readonly STRETCH_FILL: number;
  79577. /** STRETCH_UNIFORM */
  79578. static readonly STRETCH_UNIFORM: number;
  79579. /** STRETCH_EXTEND */
  79580. static readonly STRETCH_EXTEND: number;
  79581. /** NINE_PATCH */
  79582. static readonly STRETCH_NINE_PATCH: number;
  79583. }
  79584. }
  79585. declare module BABYLON.GUI {
  79586. /**
  79587. * Class used to create 2D buttons
  79588. */
  79589. export class Button extends Rectangle {
  79590. name?: string | undefined;
  79591. /**
  79592. * Function called to generate a pointer enter animation
  79593. */
  79594. pointerEnterAnimation: () => void;
  79595. /**
  79596. * Function called to generate a pointer out animation
  79597. */
  79598. pointerOutAnimation: () => void;
  79599. /**
  79600. * Function called to generate a pointer down animation
  79601. */
  79602. pointerDownAnimation: () => void;
  79603. /**
  79604. * Function called to generate a pointer up animation
  79605. */
  79606. pointerUpAnimation: () => void;
  79607. /**
  79608. * Gets or sets a boolean indicating that the button will let internal controls handle picking instead of doing it directly using its bounding info
  79609. */
  79610. delegatePickingToChildren: boolean;
  79611. private _image;
  79612. /**
  79613. * Returns the image part of the button (if any)
  79614. */
  79615. get image(): BABYLON.Nullable<Image>;
  79616. private _textBlock;
  79617. /**
  79618. * Returns the image part of the button (if any)
  79619. */
  79620. get textBlock(): BABYLON.Nullable<TextBlock>;
  79621. /**
  79622. * Creates a new Button
  79623. * @param name defines the name of the button
  79624. */
  79625. constructor(name?: string | undefined);
  79626. protected _getTypeName(): string;
  79627. /** @hidden */
  79628. _processPicking(x: number, y: number, pi: BABYLON.PointerInfoBase, type: number, pointerId: number, buttonIndex: number, deltaX?: number, deltaY?: number): boolean;
  79629. /** @hidden */
  79630. _onPointerEnter(target: Control, pi: BABYLON.PointerInfoBase): boolean;
  79631. /** @hidden */
  79632. _onPointerOut(target: Control, pi: BABYLON.PointerInfoBase, force?: boolean): void;
  79633. /** @hidden */
  79634. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
  79635. /** @hidden */
  79636. _onPointerUp(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean, pi: BABYLON.PointerInfoBase): void;
  79637. /**
  79638. * Creates a new button made with an image and a text
  79639. * @param name defines the name of the button
  79640. * @param text defines the text of the button
  79641. * @param imageUrl defines the url of the image
  79642. * @returns a new Button
  79643. */
  79644. static CreateImageButton(name: string, text: string, imageUrl: string): Button;
  79645. /**
  79646. * Creates a new button made with an image
  79647. * @param name defines the name of the button
  79648. * @param imageUrl defines the url of the image
  79649. * @returns a new Button
  79650. */
  79651. static CreateImageOnlyButton(name: string, imageUrl: string): Button;
  79652. /**
  79653. * Creates a new button made with a text
  79654. * @param name defines the name of the button
  79655. * @param text defines the text of the button
  79656. * @returns a new Button
  79657. */
  79658. static CreateSimpleButton(name: string, text: string): Button;
  79659. /**
  79660. * Creates a new button made with an image and a centered text
  79661. * @param name defines the name of the button
  79662. * @param text defines the text of the button
  79663. * @param imageUrl defines the url of the image
  79664. * @returns a new Button
  79665. */
  79666. static CreateImageWithCenterTextButton(name: string, text: string, imageUrl: string): Button;
  79667. }
  79668. }
  79669. declare module BABYLON.GUI {
  79670. /**
  79671. * Class used to create a 2D stack panel container
  79672. */
  79673. export class StackPanel extends Container {
  79674. name?: string | undefined;
  79675. private _isVertical;
  79676. private _manualWidth;
  79677. private _manualHeight;
  79678. private _doNotTrackManualChanges;
  79679. /**
  79680. * Gets or sets a boolean indicating that layou warnings should be ignored
  79681. */
  79682. ignoreLayoutWarnings: boolean;
  79683. /** Gets or sets a boolean indicating if the stack panel is vertical or horizontal*/
  79684. get isVertical(): boolean;
  79685. set isVertical(value: boolean);
  79686. /**
  79687. * Gets or sets panel width.
  79688. * This value should not be set when in horizontal mode as it will be computed automatically
  79689. */
  79690. set width(value: string | number);
  79691. get width(): string | number;
  79692. /**
  79693. * Gets or sets panel height.
  79694. * This value should not be set when in vertical mode as it will be computed automatically
  79695. */
  79696. set height(value: string | number);
  79697. get height(): string | number;
  79698. /**
  79699. * Creates a new StackPanel
  79700. * @param name defines control name
  79701. */
  79702. constructor(name?: string | undefined);
  79703. protected _getTypeName(): string;
  79704. /** @hidden */
  79705. protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  79706. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  79707. protected _postMeasure(): void;
  79708. }
  79709. }
  79710. declare module BABYLON.GUI {
  79711. /**
  79712. * Class used to represent a 2D checkbox
  79713. */
  79714. export class Checkbox extends Control {
  79715. name?: string | undefined;
  79716. private _isChecked;
  79717. private _background;
  79718. private _checkSizeRatio;
  79719. private _thickness;
  79720. /** Gets or sets border thickness */
  79721. get thickness(): number;
  79722. set thickness(value: number);
  79723. /**
  79724. * BABYLON.Observable raised when isChecked property changes
  79725. */
  79726. onIsCheckedChangedObservable: BABYLON.Observable<boolean>;
  79727. /** Gets or sets a value indicating the ratio between overall size and check size */
  79728. get checkSizeRatio(): number;
  79729. set checkSizeRatio(value: number);
  79730. /** Gets or sets background color */
  79731. get background(): string;
  79732. set background(value: string);
  79733. /** Gets or sets a boolean indicating if the checkbox is checked or not */
  79734. get isChecked(): boolean;
  79735. set isChecked(value: boolean);
  79736. /**
  79737. * Creates a new CheckBox
  79738. * @param name defines the control name
  79739. */
  79740. constructor(name?: string | undefined);
  79741. protected _getTypeName(): string;
  79742. /** @hidden */
  79743. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  79744. /** @hidden */
  79745. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
  79746. /**
  79747. * Utility function to easily create a checkbox with a header
  79748. * @param title defines the label to use for the header
  79749. * @param onValueChanged defines the callback to call when value changes
  79750. * @returns a StackPanel containing the checkbox and a textBlock
  79751. */
  79752. static AddCheckBoxWithHeader(title: string, onValueChanged: (value: boolean) => void): StackPanel;
  79753. }
  79754. }
  79755. declare module BABYLON.GUI {
  79756. /**
  79757. * Class used to store key control properties
  79758. */
  79759. export class KeyPropertySet {
  79760. /** Width */
  79761. width?: string;
  79762. /** Height */
  79763. height?: string;
  79764. /** Left padding */
  79765. paddingLeft?: string;
  79766. /** Right padding */
  79767. paddingRight?: string;
  79768. /** Top padding */
  79769. paddingTop?: string;
  79770. /** Bottom padding */
  79771. paddingBottom?: string;
  79772. /** Foreground color */
  79773. color?: string;
  79774. /** Background color */
  79775. background?: string;
  79776. }
  79777. /**
  79778. * Class used to create virtual keyboard
  79779. */
  79780. export class VirtualKeyboard extends StackPanel {
  79781. /** BABYLON.Observable raised when a key is pressed */
  79782. onKeyPressObservable: BABYLON.Observable<string>;
  79783. /** Gets or sets default key button width */
  79784. defaultButtonWidth: string;
  79785. /** Gets or sets default key button height */
  79786. defaultButtonHeight: string;
  79787. /** Gets or sets default key button left padding */
  79788. defaultButtonPaddingLeft: string;
  79789. /** Gets or sets default key button right padding */
  79790. defaultButtonPaddingRight: string;
  79791. /** Gets or sets default key button top padding */
  79792. defaultButtonPaddingTop: string;
  79793. /** Gets or sets default key button bottom padding */
  79794. defaultButtonPaddingBottom: string;
  79795. /** Gets or sets default key button foreground color */
  79796. defaultButtonColor: string;
  79797. /** Gets or sets default key button background color */
  79798. defaultButtonBackground: string;
  79799. /** Gets or sets shift button foreground color */
  79800. shiftButtonColor: string;
  79801. /** Gets or sets shift button thickness*/
  79802. selectedShiftThickness: number;
  79803. /** Gets shift key state */
  79804. shiftState: number;
  79805. protected _getTypeName(): string;
  79806. private _createKey;
  79807. /**
  79808. * Adds a new row of keys
  79809. * @param keys defines the list of keys to add
  79810. * @param propertySets defines the associated property sets
  79811. */
  79812. addKeysRow(keys: Array<string>, propertySets?: Array<KeyPropertySet>): void;
  79813. /**
  79814. * Set the shift key to a specific state
  79815. * @param shiftState defines the new shift state
  79816. */
  79817. applyShiftState(shiftState: number): void;
  79818. private _currentlyConnectedInputText;
  79819. private _connectedInputTexts;
  79820. private _onKeyPressObserver;
  79821. /** Gets the input text control currently attached to the keyboard */
  79822. get connectedInputText(): BABYLON.Nullable<InputText>;
  79823. /**
  79824. * Connects the keyboard with an input text control
  79825. *
  79826. * @param input defines the target control
  79827. */
  79828. connect(input: InputText): void;
  79829. /**
  79830. * Disconnects the keyboard from connected InputText controls
  79831. *
  79832. * @param input optionally defines a target control, otherwise all are disconnected
  79833. */
  79834. disconnect(input?: InputText): void;
  79835. private _removeConnectedInputObservables;
  79836. /**
  79837. * Release all resources
  79838. */
  79839. dispose(): void;
  79840. /**
  79841. * Creates a new keyboard using a default layout
  79842. *
  79843. * @param name defines control name
  79844. * @returns a new VirtualKeyboard
  79845. */
  79846. static CreateDefaultLayout(name?: string): VirtualKeyboard;
  79847. }
  79848. }
  79849. declare module BABYLON.GUI {
  79850. /** @hidden */
  79851. export class TextWrapper {
  79852. private _text;
  79853. private _characters;
  79854. get text(): string;
  79855. set text(txt: string);
  79856. get length(): number;
  79857. removePart(idxStart: number, idxEnd: number, insertTxt?: string): void;
  79858. charAt(idx: number): string;
  79859. substr(from: number, length?: number): string;
  79860. substring(from: number, to?: number): string;
  79861. isWord(index: number): boolean;
  79862. }
  79863. }
  79864. declare module BABYLON.GUI {
  79865. /**
  79866. * Class used to create input text control
  79867. */
  79868. export class InputText extends Control implements IFocusableControl {
  79869. name?: string | undefined;
  79870. private _textWrapper;
  79871. private _placeholderText;
  79872. private _background;
  79873. private _focusedBackground;
  79874. private _focusedColor;
  79875. private _placeholderColor;
  79876. private _thickness;
  79877. private _margin;
  79878. private _autoStretchWidth;
  79879. private _maxWidth;
  79880. private _isFocused;
  79881. private _blinkTimeout;
  79882. private _blinkIsEven;
  79883. private _cursorOffset;
  79884. private _scrollLeft;
  79885. private _textWidth;
  79886. private _clickedCoordinate;
  79887. private _deadKey;
  79888. private _addKey;
  79889. private _currentKey;
  79890. private _isTextHighlightOn;
  79891. private _textHighlightColor;
  79892. private _highligherOpacity;
  79893. private _highlightedText;
  79894. private _startHighlightIndex;
  79895. private _endHighlightIndex;
  79896. private _cursorIndex;
  79897. private _onFocusSelectAll;
  79898. private _isPointerDown;
  79899. private _onClipboardObserver;
  79900. private _onPointerDblTapObserver;
  79901. /** @hidden */
  79902. _connectedVirtualKeyboard: BABYLON.Nullable<VirtualKeyboard>;
  79903. /** Gets or sets a string representing the message displayed on mobile when the control gets the focus */
  79904. promptMessage: string;
  79905. /** Force disable prompt on mobile device */
  79906. disableMobilePrompt: boolean;
  79907. /** BABYLON.Observable raised when the text changes */
  79908. onTextChangedObservable: BABYLON.Observable<InputText>;
  79909. /** BABYLON.Observable raised just before an entered character is to be added */
  79910. onBeforeKeyAddObservable: BABYLON.Observable<InputText>;
  79911. /** BABYLON.Observable raised when the control gets the focus */
  79912. onFocusObservable: BABYLON.Observable<InputText>;
  79913. /** BABYLON.Observable raised when the control loses the focus */
  79914. onBlurObservable: BABYLON.Observable<InputText>;
  79915. /**Observable raised when the text is highlighted */
  79916. onTextHighlightObservable: BABYLON.Observable<InputText>;
  79917. /**Observable raised when copy event is triggered */
  79918. onTextCopyObservable: BABYLON.Observable<InputText>;
  79919. /** BABYLON.Observable raised when cut event is triggered */
  79920. onTextCutObservable: BABYLON.Observable<InputText>;
  79921. /** BABYLON.Observable raised when paste event is triggered */
  79922. onTextPasteObservable: BABYLON.Observable<InputText>;
  79923. /** BABYLON.Observable raised when a key event was processed */
  79924. onKeyboardEventProcessedObservable: BABYLON.Observable<KeyboardEvent>;
  79925. /** Gets or sets the maximum width allowed by the control */
  79926. get maxWidth(): string | number;
  79927. /** Gets the maximum width allowed by the control in pixels */
  79928. get maxWidthInPixels(): number;
  79929. set maxWidth(value: string | number);
  79930. /** Gets or sets the text highlighter transparency; default: 0.4 */
  79931. get highligherOpacity(): number;
  79932. set highligherOpacity(value: number);
  79933. /** Gets or sets a boolean indicating whether to select complete text by default on input focus */
  79934. get onFocusSelectAll(): boolean;
  79935. set onFocusSelectAll(value: boolean);
  79936. /** Gets or sets the text hightlight color */
  79937. get textHighlightColor(): string;
  79938. set textHighlightColor(value: string);
  79939. /** Gets or sets control margin */
  79940. get margin(): string;
  79941. /** Gets control margin in pixels */
  79942. get marginInPixels(): number;
  79943. set margin(value: string);
  79944. /** Gets or sets a boolean indicating if the control can auto stretch its width to adapt to the text */
  79945. get autoStretchWidth(): boolean;
  79946. set autoStretchWidth(value: boolean);
  79947. /** Gets or sets border thickness */
  79948. get thickness(): number;
  79949. set thickness(value: number);
  79950. /** Gets or sets the background color when focused */
  79951. get focusedBackground(): string;
  79952. set focusedBackground(value: string);
  79953. /** Gets or sets the background color when focused */
  79954. get focusedColor(): string;
  79955. set focusedColor(value: string);
  79956. /** Gets or sets the background color */
  79957. get background(): string;
  79958. set background(value: string);
  79959. /** Gets or sets the placeholder color */
  79960. get placeholderColor(): string;
  79961. set placeholderColor(value: string);
  79962. /** Gets or sets the text displayed when the control is empty */
  79963. get placeholderText(): string;
  79964. set placeholderText(value: string);
  79965. /** Gets or sets the dead key flag */
  79966. get deadKey(): boolean;
  79967. set deadKey(flag: boolean);
  79968. /** Gets or sets the highlight text */
  79969. get highlightedText(): string;
  79970. set highlightedText(text: string);
  79971. /** Gets or sets if the current key should be added */
  79972. get addKey(): boolean;
  79973. set addKey(flag: boolean);
  79974. /** Gets or sets the value of the current key being entered */
  79975. get currentKey(): string;
  79976. set currentKey(key: string);
  79977. /** Gets or sets the text displayed in the control */
  79978. get text(): string;
  79979. set text(value: string);
  79980. private _textHasChanged;
  79981. /** Gets or sets control width */
  79982. get width(): string | number;
  79983. set width(value: string | number);
  79984. /**
  79985. * Creates a new InputText
  79986. * @param name defines the control name
  79987. * @param text defines the text of the control
  79988. */
  79989. constructor(name?: string | undefined, text?: string);
  79990. /** @hidden */
  79991. onBlur(): void;
  79992. /** @hidden */
  79993. onFocus(): void;
  79994. protected _getTypeName(): string;
  79995. /**
  79996. * Function called to get the list of controls that should not steal the focus from this control
  79997. * @returns an array of controls
  79998. */
  79999. keepsFocusWith(): BABYLON.Nullable<Control[]>;
  80000. /** @hidden */
  80001. processKey(keyCode: number, key?: string, evt?: KeyboardEvent): void;
  80002. /** @hidden */
  80003. private _updateValueFromCursorIndex;
  80004. /** @hidden */
  80005. private _processDblClick;
  80006. /** @hidden */
  80007. private _selectAllText;
  80008. /**
  80009. * Handles the keyboard event
  80010. * @param evt Defines the KeyboardEvent
  80011. */
  80012. processKeyboard(evt: KeyboardEvent): void;
  80013. /** @hidden */
  80014. private _onCopyText;
  80015. /** @hidden */
  80016. private _onCutText;
  80017. /** @hidden */
  80018. private _onPasteText;
  80019. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  80020. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
  80021. _onPointerMove(target: Control, coordinates: BABYLON.Vector2, pointerId: number, pi: BABYLON.PointerInfoBase): void;
  80022. _onPointerUp(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
  80023. protected _beforeRenderText(textWrapper: TextWrapper): TextWrapper;
  80024. dispose(): void;
  80025. }
  80026. }
  80027. declare module BABYLON.GUI {
  80028. /**
  80029. * Class used to create a 2D grid container
  80030. */
  80031. export class Grid extends Container {
  80032. name?: string | undefined;
  80033. private _rowDefinitions;
  80034. private _columnDefinitions;
  80035. private _cells;
  80036. private _childControls;
  80037. /**
  80038. * Gets the number of columns
  80039. */
  80040. get columnCount(): number;
  80041. /**
  80042. * Gets the number of rows
  80043. */
  80044. get rowCount(): number;
  80045. /** Gets the list of children */
  80046. get children(): Control[];
  80047. /** Gets the list of cells (e.g. the containers) */
  80048. get cells(): {
  80049. [key: string]: Container;
  80050. };
  80051. /**
  80052. * Gets the definition of a specific row
  80053. * @param index defines the index of the row
  80054. * @returns the row definition
  80055. */
  80056. getRowDefinition(index: number): BABYLON.Nullable<ValueAndUnit>;
  80057. /**
  80058. * Gets the definition of a specific column
  80059. * @param index defines the index of the column
  80060. * @returns the column definition
  80061. */
  80062. getColumnDefinition(index: number): BABYLON.Nullable<ValueAndUnit>;
  80063. /**
  80064. * Adds a new row to the grid
  80065. * @param height defines the height of the row (either in pixel or a value between 0 and 1)
  80066. * @param isPixel defines if the height is expressed in pixel (or in percentage)
  80067. * @returns the current grid
  80068. */
  80069. addRowDefinition(height: number, isPixel?: boolean): Grid;
  80070. /**
  80071. * Adds a new column to the grid
  80072. * @param width defines the width of the column (either in pixel or a value between 0 and 1)
  80073. * @param isPixel defines if the width is expressed in pixel (or in percentage)
  80074. * @returns the current grid
  80075. */
  80076. addColumnDefinition(width: number, isPixel?: boolean): Grid;
  80077. /**
  80078. * Update a row definition
  80079. * @param index defines the index of the row to update
  80080. * @param height defines the height of the row (either in pixel or a value between 0 and 1)
  80081. * @param isPixel defines if the weight is expressed in pixel (or in percentage)
  80082. * @returns the current grid
  80083. */
  80084. setRowDefinition(index: number, height: number, isPixel?: boolean): Grid;
  80085. /**
  80086. * Update a column definition
  80087. * @param index defines the index of the column to update
  80088. * @param width defines the width of the column (either in pixel or a value between 0 and 1)
  80089. * @param isPixel defines if the width is expressed in pixel (or in percentage)
  80090. * @returns the current grid
  80091. */
  80092. setColumnDefinition(index: number, width: number, isPixel?: boolean): Grid;
  80093. /**
  80094. * Gets the list of children stored in a specific cell
  80095. * @param row defines the row to check
  80096. * @param column defines the column to check
  80097. * @returns the list of controls
  80098. */
  80099. getChildrenAt(row: number, column: number): BABYLON.Nullable<Array<Control>>;
  80100. /**
  80101. * Gets a string representing the child cell info (row x column)
  80102. * @param child defines the control to get info from
  80103. * @returns a string containing the child cell info (row x column)
  80104. */
  80105. getChildCellInfo(child: Control): string;
  80106. private _removeCell;
  80107. private _offsetCell;
  80108. /**
  80109. * Remove a column definition at specified index
  80110. * @param index defines the index of the column to remove
  80111. * @returns the current grid
  80112. */
  80113. removeColumnDefinition(index: number): Grid;
  80114. /**
  80115. * Remove a row definition at specified index
  80116. * @param index defines the index of the row to remove
  80117. * @returns the current grid
  80118. */
  80119. removeRowDefinition(index: number): Grid;
  80120. /**
  80121. * Adds a new control to the current grid
  80122. * @param control defines the control to add
  80123. * @param row defines the row where to add the control (0 by default)
  80124. * @param column defines the column where to add the control (0 by default)
  80125. * @returns the current grid
  80126. */
  80127. addControl(control: Control, row?: number, column?: number): Grid;
  80128. /**
  80129. * Removes a control from the current container
  80130. * @param control defines the control to remove
  80131. * @returns the current container
  80132. */
  80133. removeControl(control: Control): Container;
  80134. /**
  80135. * Creates a new Grid
  80136. * @param name defines control name
  80137. */
  80138. constructor(name?: string | undefined);
  80139. protected _getTypeName(): string;
  80140. protected _getGridDefinitions(definitionCallback: (lefts: number[], tops: number[], widths: number[], heights: number[]) => void): void;
  80141. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  80142. _flagDescendantsAsMatrixDirty(): void;
  80143. _renderHighlightSpecific(context: CanvasRenderingContext2D): void;
  80144. /** Releases associated resources */
  80145. dispose(): void;
  80146. }
  80147. }
  80148. declare module BABYLON.GUI {
  80149. /** Class used to create color pickers */
  80150. export class ColorPicker extends Control {
  80151. name?: string | undefined;
  80152. private static _Epsilon;
  80153. private _colorWheelCanvas;
  80154. private _value;
  80155. private _tmpColor;
  80156. private _pointerStartedOnSquare;
  80157. private _pointerStartedOnWheel;
  80158. private _squareLeft;
  80159. private _squareTop;
  80160. private _squareSize;
  80161. private _h;
  80162. private _s;
  80163. private _v;
  80164. private _lastPointerDownID;
  80165. /**
  80166. * BABYLON.Observable raised when the value changes
  80167. */
  80168. onValueChangedObservable: BABYLON.Observable<BABYLON.Color3>;
  80169. /** Gets or sets the color of the color picker */
  80170. get value(): BABYLON.Color3;
  80171. set value(value: BABYLON.Color3);
  80172. /**
  80173. * Gets or sets control width
  80174. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  80175. */
  80176. get width(): string | number;
  80177. set width(value: string | number);
  80178. /**
  80179. * Gets or sets control height
  80180. * @see https://doc.babylonjs.com/how_to/gui#position-and-size
  80181. */
  80182. get height(): string | number;
  80183. /** Gets or sets control height */
  80184. set height(value: string | number);
  80185. /** Gets or sets control size */
  80186. get size(): string | number;
  80187. set size(value: string | number);
  80188. /**
  80189. * Creates a new ColorPicker
  80190. * @param name defines the control name
  80191. */
  80192. constructor(name?: string | undefined);
  80193. protected _getTypeName(): string;
  80194. /** @hidden */
  80195. protected _preMeasure(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  80196. private _updateSquareProps;
  80197. private _drawGradientSquare;
  80198. private _drawCircle;
  80199. private _createColorWheelCanvas;
  80200. /** @hidden */
  80201. _draw(context: CanvasRenderingContext2D): void;
  80202. private _pointerIsDown;
  80203. private _updateValueFromPointer;
  80204. private _isPointOnSquare;
  80205. private _isPointOnWheel;
  80206. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
  80207. _onPointerMove(target: Control, coordinates: BABYLON.Vector2, pointerId: number, pi: BABYLON.PointerInfoBase): void;
  80208. _onPointerUp(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean, pi: BABYLON.PointerInfoBase): void;
  80209. _onCanvasBlur(): void;
  80210. /**
  80211. * This function expands the color picker by creating a color picker dialog with manual
  80212. * color value input and the ability to save colors into an array to be used later in
  80213. * subsequent launches of the dialogue.
  80214. * @param advancedTexture defines the AdvancedDynamicTexture the dialog is assigned to
  80215. * @param options defines size for dialog and options for saved colors. Also accepts last color picked as hex string and saved colors array as hex strings.
  80216. * @returns picked color as a hex string and the saved colors array as hex strings.
  80217. */
  80218. static ShowPickerDialogAsync(advancedTexture: AdvancedDynamicTexture, options: {
  80219. pickerWidth?: string;
  80220. pickerHeight?: string;
  80221. headerHeight?: string;
  80222. lastColor?: string;
  80223. swatchLimit?: number;
  80224. numSwatchesPerLine?: number;
  80225. savedColors?: Array<string>;
  80226. }): Promise<{
  80227. savedColors?: string[];
  80228. pickedColor: string;
  80229. }>;
  80230. }
  80231. }
  80232. declare module BABYLON.GUI {
  80233. /** Class used to create 2D ellipse containers */
  80234. export class Ellipse extends Container {
  80235. name?: string | undefined;
  80236. private _thickness;
  80237. /** Gets or sets border thickness */
  80238. get thickness(): number;
  80239. set thickness(value: number);
  80240. /**
  80241. * Creates a new Ellipse
  80242. * @param name defines the control name
  80243. */
  80244. constructor(name?: string | undefined);
  80245. protected _getTypeName(): string;
  80246. protected _localDraw(context: CanvasRenderingContext2D): void;
  80247. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  80248. protected _clipForChildren(context: CanvasRenderingContext2D): void;
  80249. }
  80250. }
  80251. declare module BABYLON.GUI {
  80252. /**
  80253. * Class used to create a password control
  80254. */
  80255. export class InputPassword extends InputText {
  80256. protected _beforeRenderText(textWrapper: TextWrapper): TextWrapper;
  80257. }
  80258. }
  80259. declare module BABYLON.GUI {
  80260. /** Class used to render 2D lines */
  80261. export class Line extends Control {
  80262. name?: string | undefined;
  80263. private _lineWidth;
  80264. private _x1;
  80265. private _y1;
  80266. private _x2;
  80267. private _y2;
  80268. private _dash;
  80269. private _connectedControl;
  80270. private _connectedControlDirtyObserver;
  80271. /** Gets or sets the dash pattern */
  80272. get dash(): Array<number>;
  80273. set dash(value: Array<number>);
  80274. /** Gets or sets the control connected with the line end */
  80275. get connectedControl(): Control;
  80276. set connectedControl(value: Control);
  80277. /** Gets or sets start coordinates on X axis */
  80278. get x1(): string | number;
  80279. set x1(value: string | number);
  80280. /** Gets or sets start coordinates on Y axis */
  80281. get y1(): string | number;
  80282. set y1(value: string | number);
  80283. /** Gets or sets end coordinates on X axis */
  80284. get x2(): string | number;
  80285. set x2(value: string | number);
  80286. /** Gets or sets end coordinates on Y axis */
  80287. get y2(): string | number;
  80288. set y2(value: string | number);
  80289. /** Gets or sets line width */
  80290. get lineWidth(): number;
  80291. set lineWidth(value: number);
  80292. /** Gets or sets horizontal alignment */
  80293. set horizontalAlignment(value: number);
  80294. /** Gets or sets vertical alignment */
  80295. set verticalAlignment(value: number);
  80296. private get _effectiveX2();
  80297. private get _effectiveY2();
  80298. /**
  80299. * Creates a new Line
  80300. * @param name defines the control name
  80301. */
  80302. constructor(name?: string | undefined);
  80303. protected _getTypeName(): string;
  80304. _draw(context: CanvasRenderingContext2D): void;
  80305. _measure(): void;
  80306. protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  80307. /**
  80308. * Move one end of the line given 3D cartesian coordinates.
  80309. * @param position Targeted world position
  80310. * @param scene BABYLON.Scene
  80311. * @param end (opt) Set to true to assign x2 and y2 coordinates of the line. Default assign to x1 and y1.
  80312. */
  80313. moveToVector3(position: BABYLON.Vector3, scene: BABYLON.Scene, end?: boolean): void;
  80314. /**
  80315. * Move one end of the line to a position in screen absolute space.
  80316. * @param projectedPosition Position in screen absolute space (X, Y)
  80317. * @param end (opt) Set to true to assign x2 and y2 coordinates of the line. Default assign to x1 and y1.
  80318. */
  80319. _moveToProjectedPosition(projectedPosition: BABYLON.Vector3, end?: boolean): void;
  80320. }
  80321. }
  80322. declare module BABYLON.GUI {
  80323. /**
  80324. * Class used to store a point for a MultiLine object.
  80325. * The point can be pure 2D coordinates, a mesh or a control
  80326. */
  80327. export class MultiLinePoint {
  80328. private _multiLine;
  80329. private _x;
  80330. private _y;
  80331. private _control;
  80332. private _mesh;
  80333. private _controlObserver;
  80334. private _meshObserver;
  80335. /** @hidden */
  80336. _point: BABYLON.Vector3;
  80337. /**
  80338. * Creates a new MultiLinePoint
  80339. * @param multiLine defines the source MultiLine object
  80340. */
  80341. constructor(multiLine: MultiLine);
  80342. /** Gets or sets x coordinate */
  80343. get x(): string | number;
  80344. set x(value: string | number);
  80345. /** Gets or sets y coordinate */
  80346. get y(): string | number;
  80347. set y(value: string | number);
  80348. /** Gets or sets the control associated with this point */
  80349. get control(): BABYLON.Nullable<Control>;
  80350. set control(value: BABYLON.Nullable<Control>);
  80351. /** Gets or sets the mesh associated with this point */
  80352. get mesh(): BABYLON.Nullable<BABYLON.AbstractMesh>;
  80353. set mesh(value: BABYLON.Nullable<BABYLON.AbstractMesh>);
  80354. /** Resets links */
  80355. resetLinks(): void;
  80356. /**
  80357. * Gets a translation vector with Z component
  80358. * @returns the translation vector
  80359. */
  80360. translate(): BABYLON.Vector3;
  80361. private _translatePoint;
  80362. /** Release associated resources */
  80363. dispose(): void;
  80364. }
  80365. }
  80366. declare module BABYLON.GUI {
  80367. /**
  80368. * Class used to create multi line control
  80369. */
  80370. export class MultiLine extends Control {
  80371. name?: string | undefined;
  80372. private _lineWidth;
  80373. private _dash;
  80374. private _points;
  80375. private _minX;
  80376. private _minY;
  80377. private _maxX;
  80378. private _maxY;
  80379. /**
  80380. * Creates a new MultiLine
  80381. * @param name defines the control name
  80382. */
  80383. constructor(name?: string | undefined);
  80384. /** Gets or sets dash pattern */
  80385. get dash(): Array<number>;
  80386. set dash(value: Array<number>);
  80387. /**
  80388. * Gets point stored at specified index
  80389. * @param index defines the index to look for
  80390. * @returns the requested point if found
  80391. */
  80392. getAt(index: number): MultiLinePoint;
  80393. /** Function called when a point is updated */
  80394. onPointUpdate: () => void;
  80395. /**
  80396. * Adds new points to the point collection
  80397. * @param items defines the list of items (mesh, control or 2d coordiantes) to add
  80398. * @returns the list of created MultiLinePoint
  80399. */
  80400. add(...items: (AbstractMesh | Control | {
  80401. x: string | number;
  80402. y: string | number;
  80403. })[]): MultiLinePoint[];
  80404. /**
  80405. * Adds a new point to the point collection
  80406. * @param item defines the item (mesh, control or 2d coordiantes) to add
  80407. * @returns the created MultiLinePoint
  80408. */
  80409. push(item?: (AbstractMesh | Control | {
  80410. x: string | number;
  80411. y: string | number;
  80412. })): MultiLinePoint;
  80413. /**
  80414. * Remove a specific value or point from the active point collection
  80415. * @param value defines the value or point to remove
  80416. */
  80417. remove(value: number | MultiLinePoint): void;
  80418. /**
  80419. * Resets this object to initial state (no point)
  80420. */
  80421. reset(): void;
  80422. /**
  80423. * Resets all links
  80424. */
  80425. resetLinks(): void;
  80426. /** Gets or sets line width */
  80427. get lineWidth(): number;
  80428. set lineWidth(value: number);
  80429. set horizontalAlignment(value: number);
  80430. set verticalAlignment(value: number);
  80431. protected _getTypeName(): string;
  80432. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  80433. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  80434. _measure(): void;
  80435. protected _computeAlignment(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  80436. dispose(): void;
  80437. }
  80438. }
  80439. declare module BABYLON.GUI {
  80440. /**
  80441. * Class used to create radio button controls
  80442. */
  80443. export class RadioButton extends Control {
  80444. name?: string | undefined;
  80445. private _isChecked;
  80446. private _background;
  80447. private _checkSizeRatio;
  80448. private _thickness;
  80449. /** Gets or sets border thickness */
  80450. get thickness(): number;
  80451. set thickness(value: number);
  80452. /** Gets or sets group name */
  80453. group: string;
  80454. /** BABYLON.Observable raised when isChecked is changed */
  80455. onIsCheckedChangedObservable: BABYLON.Observable<boolean>;
  80456. /** Gets or sets a value indicating the ratio between overall size and check size */
  80457. get checkSizeRatio(): number;
  80458. set checkSizeRatio(value: number);
  80459. /** Gets or sets background color */
  80460. get background(): string;
  80461. set background(value: string);
  80462. /** Gets or sets a boolean indicating if the checkbox is checked or not */
  80463. get isChecked(): boolean;
  80464. set isChecked(value: boolean);
  80465. /**
  80466. * Creates a new RadioButton
  80467. * @param name defines the control name
  80468. */
  80469. constructor(name?: string | undefined);
  80470. protected _getTypeName(): string;
  80471. _draw(context: CanvasRenderingContext2D): void;
  80472. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
  80473. /**
  80474. * Utility function to easily create a radio button with a header
  80475. * @param title defines the label to use for the header
  80476. * @param group defines the group to use for the radio button
  80477. * @param isChecked defines the initial state of the radio button
  80478. * @param onValueChanged defines the callback to call when value changes
  80479. * @returns a StackPanel containing the radio button and a textBlock
  80480. */
  80481. static AddRadioButtonWithHeader(title: string, group: string, isChecked: boolean, onValueChanged: (button: RadioButton, value: boolean) => void): StackPanel;
  80482. }
  80483. }
  80484. declare module BABYLON.GUI {
  80485. /**
  80486. * Class used to create slider controls
  80487. */
  80488. export class BaseSlider extends Control {
  80489. name?: string | undefined;
  80490. protected _thumbWidth: ValueAndUnit;
  80491. private _minimum;
  80492. private _maximum;
  80493. private _value;
  80494. private _isVertical;
  80495. protected _barOffset: ValueAndUnit;
  80496. private _isThumbClamped;
  80497. protected _displayThumb: boolean;
  80498. private _step;
  80499. private _lastPointerDownID;
  80500. protected _effectiveBarOffset: number;
  80501. protected _renderLeft: number;
  80502. protected _renderTop: number;
  80503. protected _renderWidth: number;
  80504. protected _renderHeight: number;
  80505. protected _backgroundBoxLength: number;
  80506. protected _backgroundBoxThickness: number;
  80507. protected _effectiveThumbThickness: number;
  80508. /** BABYLON.Observable raised when the sldier value changes */
  80509. onValueChangedObservable: BABYLON.Observable<number>;
  80510. /** Gets or sets a boolean indicating if the thumb must be rendered */
  80511. get displayThumb(): boolean;
  80512. set displayThumb(value: boolean);
  80513. /** Gets or sets a step to apply to values (0 by default) */
  80514. get step(): number;
  80515. set step(value: number);
  80516. /** Gets or sets main bar offset (ie. the margin applied to the value bar) */
  80517. get barOffset(): string | number;
  80518. /** Gets main bar offset in pixels*/
  80519. get barOffsetInPixels(): number;
  80520. set barOffset(value: string | number);
  80521. /** Gets or sets thumb width */
  80522. get thumbWidth(): string | number;
  80523. /** Gets thumb width in pixels */
  80524. get thumbWidthInPixels(): number;
  80525. set thumbWidth(value: string | number);
  80526. /** Gets or sets minimum value */
  80527. get minimum(): number;
  80528. set minimum(value: number);
  80529. /** Gets or sets maximum value */
  80530. get maximum(): number;
  80531. set maximum(value: number);
  80532. /** Gets or sets current value */
  80533. get value(): number;
  80534. set value(value: number);
  80535. /**Gets or sets a boolean indicating if the slider should be vertical or horizontal */
  80536. get isVertical(): boolean;
  80537. set isVertical(value: boolean);
  80538. /** Gets or sets a value indicating if the thumb can go over main bar extends */
  80539. get isThumbClamped(): boolean;
  80540. set isThumbClamped(value: boolean);
  80541. /**
  80542. * Creates a new BaseSlider
  80543. * @param name defines the control name
  80544. */
  80545. constructor(name?: string | undefined);
  80546. protected _getTypeName(): string;
  80547. protected _getThumbPosition(): number;
  80548. protected _getThumbThickness(type: string): number;
  80549. protected _prepareRenderingData(type: string): void;
  80550. private _pointerIsDown;
  80551. /** @hidden */
  80552. protected _updateValueFromPointer(x: number, y: number): void;
  80553. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
  80554. _onPointerMove(target: Control, coordinates: BABYLON.Vector2, pointerId: number, pi: BABYLON.PointerInfoBase): void;
  80555. _onPointerUp(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
  80556. _onCanvasBlur(): void;
  80557. }
  80558. }
  80559. declare module BABYLON.GUI {
  80560. /**
  80561. * Class used to create slider controls
  80562. */
  80563. export class Slider extends BaseSlider {
  80564. name?: string | undefined;
  80565. private _background;
  80566. private _borderColor;
  80567. private _thumbColor;
  80568. private _isThumbCircle;
  80569. protected _displayValueBar: boolean;
  80570. /** Gets or sets a boolean indicating if the value bar must be rendered */
  80571. get displayValueBar(): boolean;
  80572. set displayValueBar(value: boolean);
  80573. /** Gets or sets border color */
  80574. get borderColor(): string;
  80575. set borderColor(value: string);
  80576. /** Gets or sets background color */
  80577. get background(): string;
  80578. set background(value: string);
  80579. /** Gets or sets thumb's color */
  80580. get thumbColor(): string;
  80581. set thumbColor(value: string);
  80582. /** Gets or sets a boolean indicating if the thumb should be round or square */
  80583. get isThumbCircle(): boolean;
  80584. set isThumbCircle(value: boolean);
  80585. /**
  80586. * Creates a new Slider
  80587. * @param name defines the control name
  80588. */
  80589. constructor(name?: string | undefined);
  80590. protected _getTypeName(): string;
  80591. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  80592. }
  80593. }
  80594. declare module BABYLON.GUI {
  80595. /** Class used to create a RadioGroup
  80596. * which contains groups of radio buttons
  80597. */
  80598. export class SelectorGroup {
  80599. /** name of SelectorGroup */
  80600. name: string;
  80601. private _groupPanel;
  80602. private _selectors;
  80603. private _groupHeader;
  80604. /**
  80605. * Creates a new SelectorGroup
  80606. * @param name of group, used as a group heading
  80607. */
  80608. constructor(
  80609. /** name of SelectorGroup */
  80610. name: string);
  80611. /** Gets the groupPanel of the SelectorGroup */
  80612. get groupPanel(): StackPanel;
  80613. /** Gets the selectors array */
  80614. get selectors(): StackPanel[];
  80615. /** Gets and sets the group header */
  80616. get header(): string;
  80617. set header(label: string);
  80618. /** @hidden */
  80619. private _addGroupHeader;
  80620. /** @hidden*/
  80621. _getSelector(selectorNb: number): StackPanel | undefined;
  80622. /** Removes the selector at the given position
  80623. * @param selectorNb the position of the selector within the group
  80624. */
  80625. removeSelector(selectorNb: number): void;
  80626. }
  80627. /** Class used to create a CheckboxGroup
  80628. * which contains groups of checkbox buttons
  80629. */
  80630. export class CheckboxGroup extends SelectorGroup {
  80631. /** Adds a checkbox as a control
  80632. * @param text is the label for the selector
  80633. * @param func is the function called when the Selector is checked
  80634. * @param checked is true when Selector is checked
  80635. */
  80636. addCheckbox(text: string, func?: (s: boolean) => void, checked?: boolean): void;
  80637. /** @hidden */
  80638. _setSelectorLabel(selectorNb: number, label: string): void;
  80639. /** @hidden */
  80640. _setSelectorLabelColor(selectorNb: number, color: string): void;
  80641. /** @hidden */
  80642. _setSelectorButtonColor(selectorNb: number, color: string): void;
  80643. /** @hidden */
  80644. _setSelectorButtonBackground(selectorNb: number, color: string): void;
  80645. }
  80646. /** Class used to create a RadioGroup
  80647. * which contains groups of radio buttons
  80648. */
  80649. export class RadioGroup extends SelectorGroup {
  80650. private _selectNb;
  80651. /** Adds a radio button as a control
  80652. * @param label is the label for the selector
  80653. * @param func is the function called when the Selector is checked
  80654. * @param checked is true when Selector is checked
  80655. */
  80656. addRadio(label: string, func?: (n: number) => void, checked?: boolean): void;
  80657. /** @hidden */
  80658. _setSelectorLabel(selectorNb: number, label: string): void;
  80659. /** @hidden */
  80660. _setSelectorLabelColor(selectorNb: number, color: string): void;
  80661. /** @hidden */
  80662. _setSelectorButtonColor(selectorNb: number, color: string): void;
  80663. /** @hidden */
  80664. _setSelectorButtonBackground(selectorNb: number, color: string): void;
  80665. }
  80666. /** Class used to create a SliderGroup
  80667. * which contains groups of slider buttons
  80668. */
  80669. export class SliderGroup extends SelectorGroup {
  80670. /**
  80671. * Adds a slider to the SelectorGroup
  80672. * @param label is the label for the SliderBar
  80673. * @param func is the function called when the Slider moves
  80674. * @param unit is a string describing the units used, eg degrees or metres
  80675. * @param min is the minimum value for the Slider
  80676. * @param max is the maximum value for the Slider
  80677. * @param value is the start value for the Slider between min and max
  80678. * @param onValueChange is the function used to format the value displayed, eg radians to degrees
  80679. */
  80680. addSlider(label: string, func?: (v: number) => void, unit?: string, min?: number, max?: number, value?: number, onValueChange?: (v: number) => number): void;
  80681. /** @hidden */
  80682. _setSelectorLabel(selectorNb: number, label: string): void;
  80683. /** @hidden */
  80684. _setSelectorLabelColor(selectorNb: number, color: string): void;
  80685. /** @hidden */
  80686. _setSelectorButtonColor(selectorNb: number, color: string): void;
  80687. /** @hidden */
  80688. _setSelectorButtonBackground(selectorNb: number, color: string): void;
  80689. }
  80690. /** Class used to hold the controls for the checkboxes, radio buttons and sliders
  80691. * @see https://doc.babylonjs.com/how_to/selector
  80692. */
  80693. export class SelectionPanel extends Rectangle {
  80694. /** name of SelectionPanel */
  80695. name: string;
  80696. /** an array of SelectionGroups */
  80697. groups: SelectorGroup[];
  80698. private _panel;
  80699. private _buttonColor;
  80700. private _buttonBackground;
  80701. private _headerColor;
  80702. private _barColor;
  80703. private _barHeight;
  80704. private _spacerHeight;
  80705. private _labelColor;
  80706. private _groups;
  80707. private _bars;
  80708. /**
  80709. * Creates a new SelectionPanel
  80710. * @param name of SelectionPanel
  80711. * @param groups is an array of SelectionGroups
  80712. */
  80713. constructor(
  80714. /** name of SelectionPanel */
  80715. name: string,
  80716. /** an array of SelectionGroups */
  80717. groups?: SelectorGroup[]);
  80718. protected _getTypeName(): string;
  80719. /** Gets the (stack) panel of the SelectionPanel */
  80720. get panel(): StackPanel;
  80721. /** Gets or sets the headerColor */
  80722. get headerColor(): string;
  80723. set headerColor(color: string);
  80724. private _setHeaderColor;
  80725. /** Gets or sets the button color */
  80726. get buttonColor(): string;
  80727. set buttonColor(color: string);
  80728. private _setbuttonColor;
  80729. /** Gets or sets the label color */
  80730. get labelColor(): string;
  80731. set labelColor(color: string);
  80732. private _setLabelColor;
  80733. /** Gets or sets the button background */
  80734. get buttonBackground(): string;
  80735. set buttonBackground(color: string);
  80736. private _setButtonBackground;
  80737. /** Gets or sets the color of separator bar */
  80738. get barColor(): string;
  80739. set barColor(color: string);
  80740. private _setBarColor;
  80741. /** Gets or sets the height of separator bar */
  80742. get barHeight(): string;
  80743. set barHeight(value: string);
  80744. private _setBarHeight;
  80745. /** Gets or sets the height of spacers*/
  80746. get spacerHeight(): string;
  80747. set spacerHeight(value: string);
  80748. private _setSpacerHeight;
  80749. /** Adds a bar between groups */
  80750. private _addSpacer;
  80751. /** Add a group to the selection panel
  80752. * @param group is the selector group to add
  80753. */
  80754. addGroup(group: SelectorGroup): void;
  80755. /** Remove the group from the given position
  80756. * @param groupNb is the position of the group in the list
  80757. */
  80758. removeGroup(groupNb: number): void;
  80759. /** Change a group header label
  80760. * @param label is the new group header label
  80761. * @param groupNb is the number of the group to relabel
  80762. * */
  80763. setHeaderName(label: string, groupNb: number): void;
  80764. /** Change selector label to the one given
  80765. * @param label is the new selector label
  80766. * @param groupNb is the number of the groupcontaining the selector
  80767. * @param selectorNb is the number of the selector within a group to relabel
  80768. * */
  80769. relabel(label: string, groupNb: number, selectorNb: number): void;
  80770. /** For a given group position remove the selector at the given position
  80771. * @param groupNb is the number of the group to remove the selector from
  80772. * @param selectorNb is the number of the selector within the group
  80773. */
  80774. removeFromGroupSelector(groupNb: number, selectorNb: number): void;
  80775. /** For a given group position of correct type add a checkbox button
  80776. * @param groupNb is the number of the group to remove the selector from
  80777. * @param label is the label for the selector
  80778. * @param func is the function called when the Selector is checked
  80779. * @param checked is true when Selector is checked
  80780. */
  80781. addToGroupCheckbox(groupNb: number, label: string, func?: () => void, checked?: boolean): void;
  80782. /** For a given group position of correct type add a radio button
  80783. * @param groupNb is the number of the group to remove the selector from
  80784. * @param label is the label for the selector
  80785. * @param func is the function called when the Selector is checked
  80786. * @param checked is true when Selector is checked
  80787. */
  80788. addToGroupRadio(groupNb: number, label: string, func?: () => void, checked?: boolean): void;
  80789. /**
  80790. * For a given slider group add a slider
  80791. * @param groupNb is the number of the group to add the slider to
  80792. * @param label is the label for the Slider
  80793. * @param func is the function called when the Slider moves
  80794. * @param unit is a string describing the units used, eg degrees or metres
  80795. * @param min is the minimum value for the Slider
  80796. * @param max is the maximum value for the Slider
  80797. * @param value is the start value for the Slider between min and max
  80798. * @param onVal is the function used to format the value displayed, eg radians to degrees
  80799. */
  80800. addToGroupSlider(groupNb: number, label: string, func?: () => void, unit?: string, min?: number, max?: number, value?: number, onVal?: (v: number) => number): void;
  80801. }
  80802. }
  80803. declare module BABYLON.GUI {
  80804. /**
  80805. * Class used to hold a the container for ScrollViewer
  80806. * @hidden
  80807. */
  80808. export class _ScrollViewerWindow extends Container {
  80809. parentClientWidth: number;
  80810. parentClientHeight: number;
  80811. private _freezeControls;
  80812. private _parentMeasure;
  80813. private _oldLeft;
  80814. private _oldTop;
  80815. get freezeControls(): boolean;
  80816. set freezeControls(value: boolean);
  80817. private _bucketWidth;
  80818. private _bucketHeight;
  80819. private _buckets;
  80820. private _bucketLen;
  80821. get bucketWidth(): number;
  80822. get bucketHeight(): number;
  80823. setBucketSizes(width: number, height: number): void;
  80824. private _useBuckets;
  80825. private _makeBuckets;
  80826. private _dispatchInBuckets;
  80827. private _updateMeasures;
  80828. private _updateChildrenMeasures;
  80829. private _restoreMeasures;
  80830. /**
  80831. * Creates a new ScrollViewerWindow
  80832. * @param name of ScrollViewerWindow
  80833. */
  80834. constructor(name?: string);
  80835. protected _getTypeName(): string;
  80836. /** @hidden */
  80837. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  80838. /** @hidden */
  80839. _layout(parentMeasure: Measure, context: CanvasRenderingContext2D): boolean;
  80840. private _scrollChildren;
  80841. private _scrollChildrenWithBuckets;
  80842. /** @hidden */
  80843. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: Measure): void;
  80844. protected _postMeasure(): void;
  80845. }
  80846. }
  80847. declare module BABYLON.GUI {
  80848. /**
  80849. * Class used to create slider controls
  80850. */
  80851. export class ScrollBar extends BaseSlider {
  80852. name?: string | undefined;
  80853. private _background;
  80854. private _borderColor;
  80855. private _tempMeasure;
  80856. /** Gets or sets border color */
  80857. get borderColor(): string;
  80858. set borderColor(value: string);
  80859. /** Gets or sets background color */
  80860. get background(): string;
  80861. set background(value: string);
  80862. /**
  80863. * Creates a new Slider
  80864. * @param name defines the control name
  80865. */
  80866. constructor(name?: string | undefined);
  80867. protected _getTypeName(): string;
  80868. protected _getThumbThickness(): number;
  80869. _draw(context: CanvasRenderingContext2D): void;
  80870. private _first;
  80871. private _originX;
  80872. private _originY;
  80873. /** @hidden */
  80874. protected _updateValueFromPointer(x: number, y: number): void;
  80875. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
  80876. }
  80877. }
  80878. declare module BABYLON.GUI {
  80879. /**
  80880. * Class used to create slider controls
  80881. */
  80882. export class ImageScrollBar extends BaseSlider {
  80883. name?: string | undefined;
  80884. private _backgroundBaseImage;
  80885. private _backgroundImage;
  80886. private _thumbImage;
  80887. private _thumbBaseImage;
  80888. private _thumbLength;
  80889. private _thumbHeight;
  80890. private _barImageHeight;
  80891. private _tempMeasure;
  80892. /** Number of 90° rotation to apply on the images when in vertical mode */
  80893. num90RotationInVerticalMode: number;
  80894. /**
  80895. * Gets or sets the image used to render the background for horizontal bar
  80896. */
  80897. get backgroundImage(): Image;
  80898. set backgroundImage(value: Image);
  80899. /**
  80900. * Gets or sets the image used to render the thumb
  80901. */
  80902. get thumbImage(): Image;
  80903. set thumbImage(value: Image);
  80904. /**
  80905. * Gets or sets the length of the thumb
  80906. */
  80907. get thumbLength(): number;
  80908. set thumbLength(value: number);
  80909. /**
  80910. * Gets or sets the height of the thumb
  80911. */
  80912. get thumbHeight(): number;
  80913. set thumbHeight(value: number);
  80914. /**
  80915. * Gets or sets the height of the bar image
  80916. */
  80917. get barImageHeight(): number;
  80918. set barImageHeight(value: number);
  80919. /**
  80920. * Creates a new ImageScrollBar
  80921. * @param name defines the control name
  80922. */
  80923. constructor(name?: string | undefined);
  80924. protected _getTypeName(): string;
  80925. protected _getThumbThickness(): number;
  80926. _draw(context: CanvasRenderingContext2D): void;
  80927. private _first;
  80928. private _originX;
  80929. private _originY;
  80930. /** @hidden */
  80931. protected _updateValueFromPointer(x: number, y: number): void;
  80932. _onPointerDown(target: Control, coordinates: BABYLON.Vector2, pointerId: number, buttonIndex: number, pi: BABYLON.PointerInfoBase): boolean;
  80933. }
  80934. }
  80935. declare module BABYLON.GUI {
  80936. /**
  80937. * Class used to hold a viewer window and sliders in a grid
  80938. */
  80939. export class ScrollViewer extends Rectangle {
  80940. private _grid;
  80941. private _horizontalBarSpace;
  80942. private _verticalBarSpace;
  80943. private _dragSpace;
  80944. private _horizontalBar;
  80945. private _verticalBar;
  80946. private _barColor;
  80947. private _barBackground;
  80948. private _barImage;
  80949. private _horizontalBarImage;
  80950. private _verticalBarImage;
  80951. private _barBackgroundImage;
  80952. private _horizontalBarBackgroundImage;
  80953. private _verticalBarBackgroundImage;
  80954. private _barSize;
  80955. private _window;
  80956. private _pointerIsOver;
  80957. private _wheelPrecision;
  80958. private _onWheelObserver;
  80959. private _clientWidth;
  80960. private _clientHeight;
  80961. private _useImageBar;
  80962. private _thumbLength;
  80963. private _thumbHeight;
  80964. private _barImageHeight;
  80965. private _horizontalBarImageHeight;
  80966. private _verticalBarImageHeight;
  80967. private _oldWindowContentsWidth;
  80968. private _oldWindowContentsHeight;
  80969. /**
  80970. * Gets the horizontal scrollbar
  80971. */
  80972. get horizontalBar(): ScrollBar | ImageScrollBar;
  80973. /**
  80974. * Gets the vertical scrollbar
  80975. */
  80976. get verticalBar(): ScrollBar | ImageScrollBar;
  80977. /**
  80978. * Adds a new control to the current container
  80979. * @param control defines the control to add
  80980. * @returns the current container
  80981. */
  80982. addControl(control: BABYLON.Nullable<Control>): Container;
  80983. /**
  80984. * Removes a control from the current container
  80985. * @param control defines the control to remove
  80986. * @returns the current container
  80987. */
  80988. removeControl(control: Control): Container;
  80989. /** Gets the list of children */
  80990. get children(): Control[];
  80991. _flagDescendantsAsMatrixDirty(): void;
  80992. /**
  80993. * Freezes or unfreezes the controls in the window.
  80994. * When controls are frozen, the scroll viewer can render a lot more quickly but updates to positions/sizes of controls
  80995. * are not taken into account. If you want to change positions/sizes, unfreeze, perform the changes then freeze again
  80996. */
  80997. get freezeControls(): boolean;
  80998. set freezeControls(value: boolean);
  80999. /** Gets the bucket width */
  81000. get bucketWidth(): number;
  81001. /** Gets the bucket height */
  81002. get bucketHeight(): number;
  81003. /**
  81004. * Sets the bucket sizes.
  81005. * When freezeControls is true, setting a non-zero bucket size will improve performances by updating only
  81006. * controls that are visible. The bucket sizes is used to subdivide (internally) the window area to smaller areas into which
  81007. * controls are dispatched. So, the size should be roughly equals to the mean size of all the controls of
  81008. * the window. To disable the usage of buckets, sets either width or height (or both) to 0.
  81009. * Please note that using this option will raise the memory usage (the higher the bucket sizes, the less memory
  81010. * used), that's why it is not enabled by default.
  81011. * @param width width of the bucket
  81012. * @param height height of the bucket
  81013. */
  81014. setBucketSizes(width: number, height: number): void;
  81015. private _forceHorizontalBar;
  81016. private _forceVerticalBar;
  81017. /**
  81018. * Forces the horizontal scroll bar to be displayed
  81019. */
  81020. get forceHorizontalBar(): boolean;
  81021. set forceHorizontalBar(value: boolean);
  81022. /**
  81023. * Forces the vertical scroll bar to be displayed
  81024. */
  81025. get forceVerticalBar(): boolean;
  81026. set forceVerticalBar(value: boolean);
  81027. /**
  81028. * Creates a new ScrollViewer
  81029. * @param name of ScrollViewer
  81030. */
  81031. constructor(name?: string, isImageBased?: boolean);
  81032. /** Reset the scroll viewer window to initial size */
  81033. resetWindow(): void;
  81034. protected _getTypeName(): string;
  81035. private _buildClientSizes;
  81036. protected _additionalProcessing(parentMeasure: Measure, context: CanvasRenderingContext2D): void;
  81037. protected _postMeasure(): void;
  81038. /**
  81039. * Gets or sets the mouse wheel precision
  81040. * from 0 to 1 with a default value of 0.05
  81041. * */
  81042. get wheelPrecision(): number;
  81043. set wheelPrecision(value: number);
  81044. /** Gets or sets the scroll bar container background color */
  81045. get scrollBackground(): string;
  81046. set scrollBackground(color: string);
  81047. /** Gets or sets the bar color */
  81048. get barColor(): string;
  81049. set barColor(color: string);
  81050. /** Gets or sets the bar image */
  81051. get thumbImage(): Image;
  81052. set thumbImage(value: Image);
  81053. /** Gets or sets the horizontal bar image */
  81054. get horizontalThumbImage(): Image;
  81055. set horizontalThumbImage(value: Image);
  81056. /** Gets or sets the vertical bar image */
  81057. get verticalThumbImage(): Image;
  81058. set verticalThumbImage(value: Image);
  81059. /** Gets or sets the size of the bar */
  81060. get barSize(): number;
  81061. set barSize(value: number);
  81062. /** Gets or sets the length of the thumb */
  81063. get thumbLength(): number;
  81064. set thumbLength(value: number);
  81065. /** Gets or sets the height of the thumb */
  81066. get thumbHeight(): number;
  81067. set thumbHeight(value: number);
  81068. /** Gets or sets the height of the bar image */
  81069. get barImageHeight(): number;
  81070. set barImageHeight(value: number);
  81071. /** Gets or sets the height of the horizontal bar image */
  81072. get horizontalBarImageHeight(): number;
  81073. set horizontalBarImageHeight(value: number);
  81074. /** Gets or sets the height of the vertical bar image */
  81075. get verticalBarImageHeight(): number;
  81076. set verticalBarImageHeight(value: number);
  81077. /** Gets or sets the bar background */
  81078. get barBackground(): string;
  81079. set barBackground(color: string);
  81080. /** Gets or sets the bar background image */
  81081. get barImage(): Image;
  81082. set barImage(value: Image);
  81083. /** Gets or sets the horizontal bar background image */
  81084. get horizontalBarImage(): Image;
  81085. set horizontalBarImage(value: Image);
  81086. /** Gets or sets the vertical bar background image */
  81087. get verticalBarImage(): Image;
  81088. set verticalBarImage(value: Image);
  81089. private _setWindowPosition;
  81090. /** @hidden */
  81091. private _updateScroller;
  81092. _link(host: AdvancedDynamicTexture): void;
  81093. /** @hidden */
  81094. private _addBar;
  81095. /** @hidden */
  81096. private _attachWheel;
  81097. _renderHighlightSpecific(context: CanvasRenderingContext2D): void;
  81098. /** Releases associated resources */
  81099. dispose(): void;
  81100. }
  81101. }
  81102. declare module BABYLON.GUI {
  81103. /** Class used to render a grid */
  81104. export class DisplayGrid extends Control {
  81105. name?: string | undefined;
  81106. private _cellWidth;
  81107. private _cellHeight;
  81108. private _minorLineTickness;
  81109. private _minorLineColor;
  81110. private _majorLineTickness;
  81111. private _majorLineColor;
  81112. private _majorLineFrequency;
  81113. private _background;
  81114. private _displayMajorLines;
  81115. private _displayMinorLines;
  81116. /** Gets or sets a boolean indicating if minor lines must be rendered (true by default)) */
  81117. get displayMinorLines(): boolean;
  81118. set displayMinorLines(value: boolean);
  81119. /** Gets or sets a boolean indicating if major lines must be rendered (true by default)) */
  81120. get displayMajorLines(): boolean;
  81121. set displayMajorLines(value: boolean);
  81122. /** Gets or sets background color (Black by default) */
  81123. get background(): string;
  81124. set background(value: string);
  81125. /** Gets or sets the width of each cell (20 by default) */
  81126. get cellWidth(): number;
  81127. set cellWidth(value: number);
  81128. /** Gets or sets the height of each cell (20 by default) */
  81129. get cellHeight(): number;
  81130. set cellHeight(value: number);
  81131. /** Gets or sets the tickness of minor lines (1 by default) */
  81132. get minorLineTickness(): number;
  81133. set minorLineTickness(value: number);
  81134. /** Gets or sets the color of minor lines (DarkGray by default) */
  81135. get minorLineColor(): string;
  81136. set minorLineColor(value: string);
  81137. /** Gets or sets the tickness of major lines (2 by default) */
  81138. get majorLineTickness(): number;
  81139. set majorLineTickness(value: number);
  81140. /** Gets or sets the color of major lines (White by default) */
  81141. get majorLineColor(): string;
  81142. set majorLineColor(value: string);
  81143. /** Gets or sets the frequency of major lines (default is 1 every 5 minor lines)*/
  81144. get majorLineFrequency(): number;
  81145. set majorLineFrequency(value: number);
  81146. /**
  81147. * Creates a new GridDisplayRectangle
  81148. * @param name defines the control name
  81149. */
  81150. constructor(name?: string | undefined);
  81151. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  81152. protected _getTypeName(): string;
  81153. }
  81154. }
  81155. declare module BABYLON.GUI {
  81156. /**
  81157. * Class used to create slider controls based on images
  81158. */
  81159. export class ImageBasedSlider extends BaseSlider {
  81160. name?: string | undefined;
  81161. private _backgroundImage;
  81162. private _thumbImage;
  81163. private _valueBarImage;
  81164. private _tempMeasure;
  81165. get displayThumb(): boolean;
  81166. set displayThumb(value: boolean);
  81167. /**
  81168. * Gets or sets the image used to render the background
  81169. */
  81170. get backgroundImage(): Image;
  81171. set backgroundImage(value: Image);
  81172. /**
  81173. * Gets or sets the image used to render the value bar
  81174. */
  81175. get valueBarImage(): Image;
  81176. set valueBarImage(value: Image);
  81177. /**
  81178. * Gets or sets the image used to render the thumb
  81179. */
  81180. get thumbImage(): Image;
  81181. set thumbImage(value: Image);
  81182. /**
  81183. * Creates a new ImageBasedSlider
  81184. * @param name defines the control name
  81185. */
  81186. constructor(name?: string | undefined);
  81187. protected _getTypeName(): string;
  81188. _draw(context: CanvasRenderingContext2D, invalidatedRectangle?: BABYLON.Nullable<Measure>): void;
  81189. }
  81190. }
  81191. declare module BABYLON.GUI {
  81192. /**
  81193. * Forcing an export so that this code will execute
  81194. * @hidden
  81195. */
  81196. const name = "Statics";
  81197. }
  81198. declare module BABYLON.GUI {
  81199. /**
  81200. * This class can be used to get instrumentation data from a AdvancedDynamicTexture object
  81201. */
  81202. export class AdvancedDynamicTextureInstrumentation implements BABYLON.IDisposable {
  81203. /**
  81204. * Define the instrumented AdvancedDynamicTexture.
  81205. */
  81206. texture: AdvancedDynamicTexture;
  81207. private _captureRenderTime;
  81208. private _renderTime;
  81209. private _captureLayoutTime;
  81210. private _layoutTime;
  81211. private _onBeginRenderObserver;
  81212. private _onEndRenderObserver;
  81213. private _onBeginLayoutObserver;
  81214. private _onEndLayoutObserver;
  81215. /**
  81216. * Gets the perf counter used to capture render time
  81217. */
  81218. get renderTimeCounter(): BABYLON.PerfCounter;
  81219. /**
  81220. * Gets the perf counter used to capture layout time
  81221. */
  81222. get layoutTimeCounter(): BABYLON.PerfCounter;
  81223. /**
  81224. * Enable or disable the render time capture
  81225. */
  81226. get captureRenderTime(): boolean;
  81227. set captureRenderTime(value: boolean);
  81228. /**
  81229. * Enable or disable the layout time capture
  81230. */
  81231. get captureLayoutTime(): boolean;
  81232. set captureLayoutTime(value: boolean);
  81233. /**
  81234. * Instantiates a new advanced dynamic texture instrumentation.
  81235. * This class can be used to get instrumentation data from an AdvancedDynamicTexture object
  81236. * @param texture Defines the AdvancedDynamicTexture to instrument
  81237. */
  81238. constructor(
  81239. /**
  81240. * Define the instrumented AdvancedDynamicTexture.
  81241. */
  81242. texture: AdvancedDynamicTexture);
  81243. /**
  81244. * Dispose and release associated resources.
  81245. */
  81246. dispose(): void;
  81247. }
  81248. }
  81249. declare module BABYLON.GUI {
  81250. /**
  81251. * Class used to load GUI via XML.
  81252. */
  81253. export class XmlLoader {
  81254. private _nodes;
  81255. private _nodeTypes;
  81256. private _isLoaded;
  81257. private _objectAttributes;
  81258. private _parentClass;
  81259. /**
  81260. * Create a new xml loader
  81261. * @param parentClass Sets the class context. Used when the loader is instanced inside a class and not in a global context
  81262. */
  81263. constructor(parentClass?: null);
  81264. private _getChainElement;
  81265. private _getClassAttribute;
  81266. private _createGuiElement;
  81267. private _parseGrid;
  81268. private _parseElement;
  81269. private _prepareSourceElement;
  81270. private _parseElementsFromSource;
  81271. private _parseXml;
  81272. /**
  81273. * Gets if the loading has finished.
  81274. * @returns whether the loading has finished or not
  81275. */
  81276. isLoaded(): boolean;
  81277. /**
  81278. * Gets a loaded node / control by id.
  81279. * @param id the Controls id set in the xml
  81280. * @returns element of type Control
  81281. */
  81282. getNodeById(id: string): any;
  81283. /**
  81284. * Gets all loaded nodes / controls
  81285. * @returns Array of controls
  81286. */
  81287. getNodes(): any;
  81288. /**
  81289. * Initiates the xml layout loading
  81290. * @param xmlFile defines the xml layout to load
  81291. * @param rootNode defines the node / control to use as a parent for the loaded layout controls.
  81292. * @param callback defines the callback called on layout load.
  81293. */
  81294. loadLayout(xmlFile: any, rootNode: any, callback: any): void;
  81295. }
  81296. }
  81297. declare module BABYLON.GUI {
  81298. /**
  81299. * Class used to create containers for controls
  81300. */
  81301. export class Container3D extends Control3D {
  81302. private _blockLayout;
  81303. /**
  81304. * Gets the list of child controls
  81305. */
  81306. protected _children: Control3D[];
  81307. /**
  81308. * Gets the list of child controls
  81309. */
  81310. get children(): Array<Control3D>;
  81311. /**
  81312. * Gets or sets a boolean indicating if the layout must be blocked (default is false).
  81313. * This is helpful to optimize layout operation when adding multiple children in a row
  81314. */
  81315. get blockLayout(): boolean;
  81316. set blockLayout(value: boolean);
  81317. /**
  81318. * Creates a new container
  81319. * @param name defines the container name
  81320. */
  81321. constructor(name?: string);
  81322. /**
  81323. * Force the container to update the layout. Please note that it will not take blockLayout property in account
  81324. * @returns the current container
  81325. */
  81326. updateLayout(): Container3D;
  81327. /**
  81328. * Gets a boolean indicating if the given control is in the children of this control
  81329. * @param control defines the control to check
  81330. * @returns true if the control is in the child list
  81331. */
  81332. containsControl(control: Control3D): boolean;
  81333. /**
  81334. * Adds a control to the children of this control
  81335. * @param control defines the control to add
  81336. * @returns the current container
  81337. */
  81338. addControl(control: Control3D): Container3D;
  81339. /**
  81340. * This function will be called everytime a new control is added
  81341. */
  81342. protected _arrangeChildren(): void;
  81343. protected _createNode(scene: BABYLON.Scene): BABYLON.Nullable<BABYLON.TransformNode>;
  81344. /**
  81345. * Removes a control from the children of this control
  81346. * @param control defines the control to remove
  81347. * @returns the current container
  81348. */
  81349. removeControl(control: Control3D): Container3D;
  81350. protected _getTypeName(): string;
  81351. /**
  81352. * Releases all associated resources
  81353. */
  81354. dispose(): void;
  81355. /** Control rotation will remain unchanged */
  81356. static readonly UNSET_ORIENTATION: number;
  81357. /** Control will rotate to make it look at sphere central axis */
  81358. static readonly FACEORIGIN_ORIENTATION: number;
  81359. /** Control will rotate to make it look back at sphere central axis */
  81360. static readonly FACEORIGINREVERSED_ORIENTATION: number;
  81361. /** Control will rotate to look at z axis (0, 0, 1) */
  81362. static readonly FACEFORWARD_ORIENTATION: number;
  81363. /** Control will rotate to look at negative z axis (0, 0, -1) */
  81364. static readonly FACEFORWARDREVERSED_ORIENTATION: number;
  81365. }
  81366. }
  81367. declare module BABYLON.GUI {
  81368. /**
  81369. * Class used to manage 3D user interface
  81370. * @see https://doc.babylonjs.com/how_to/gui3d
  81371. */
  81372. export class GUI3DManager implements BABYLON.IDisposable {
  81373. private _scene;
  81374. private _sceneDisposeObserver;
  81375. private _utilityLayer;
  81376. private _rootContainer;
  81377. private _pointerObserver;
  81378. private _pointerOutObserver;
  81379. /** @hidden */
  81380. _lastPickedControl: Control3D;
  81381. /** @hidden */
  81382. _lastControlOver: {
  81383. [pointerId: number]: Control3D;
  81384. };
  81385. /** @hidden */
  81386. _lastControlDown: {
  81387. [pointerId: number]: Control3D;
  81388. };
  81389. /**
  81390. * BABYLON.Observable raised when the point picked by the pointer events changed
  81391. */
  81392. onPickedPointChangedObservable: BABYLON.Observable<BABYLON.Nullable<BABYLON.Vector3>>;
  81393. /** @hidden */
  81394. _sharedMaterials: {
  81395. [key: string]: BABYLON.Material;
  81396. };
  81397. /** Gets the hosting scene */
  81398. get scene(): BABYLON.Scene;
  81399. /** Gets associated utility layer */
  81400. get utilityLayer(): BABYLON.Nullable<BABYLON.UtilityLayerRenderer>;
  81401. /**
  81402. * Creates a new GUI3DManager
  81403. * @param scene
  81404. */
  81405. constructor(scene?: BABYLON.Scene);
  81406. private _handlePointerOut;
  81407. private _doPicking;
  81408. /**
  81409. * Gets the root container
  81410. */
  81411. get rootContainer(): Container3D;
  81412. /**
  81413. * Gets a boolean indicating if the given control is in the root child list
  81414. * @param control defines the control to check
  81415. * @returns true if the control is in the root child list
  81416. */
  81417. containsControl(control: Control3D): boolean;
  81418. /**
  81419. * Adds a control to the root child list
  81420. * @param control defines the control to add
  81421. * @returns the current manager
  81422. */
  81423. addControl(control: Control3D): GUI3DManager;
  81424. /**
  81425. * Removes a control from the root child list
  81426. * @param control defines the control to remove
  81427. * @returns the current container
  81428. */
  81429. removeControl(control: Control3D): GUI3DManager;
  81430. /**
  81431. * Releases all associated resources
  81432. */
  81433. dispose(): void;
  81434. }
  81435. }
  81436. declare module BABYLON.GUI {
  81437. /**
  81438. * Class used to transport BABYLON.Vector3 information for pointer events
  81439. */
  81440. export class Vector3WithInfo extends BABYLON.Vector3 {
  81441. /** defines the current mouse button index */
  81442. buttonIndex: number;
  81443. /**
  81444. * Creates a new Vector3WithInfo
  81445. * @param source defines the vector3 data to transport
  81446. * @param buttonIndex defines the current mouse button index
  81447. */
  81448. constructor(source: BABYLON.Vector3,
  81449. /** defines the current mouse button index */
  81450. buttonIndex?: number);
  81451. }
  81452. }
  81453. declare module BABYLON.GUI {
  81454. /**
  81455. * Class used as base class for controls
  81456. */
  81457. export class Control3D implements BABYLON.IDisposable, BABYLON.IBehaviorAware<Control3D> {
  81458. /** Defines the control name */
  81459. name?: string | undefined;
  81460. /** @hidden */
  81461. _host: GUI3DManager;
  81462. private _node;
  81463. private _downCount;
  81464. private _enterCount;
  81465. private _downPointerIds;
  81466. private _isVisible;
  81467. /** Gets or sets the control position in world space */
  81468. get position(): BABYLON.Vector3;
  81469. set position(value: BABYLON.Vector3);
  81470. /** Gets or sets the control scaling in world space */
  81471. get scaling(): BABYLON.Vector3;
  81472. set scaling(value: BABYLON.Vector3);
  81473. /** Callback used to start pointer enter animation */
  81474. pointerEnterAnimation: () => void;
  81475. /** Callback used to start pointer out animation */
  81476. pointerOutAnimation: () => void;
  81477. /** Callback used to start pointer down animation */
  81478. pointerDownAnimation: () => void;
  81479. /** Callback used to start pointer up animation */
  81480. pointerUpAnimation: () => void;
  81481. /**
  81482. * An event triggered when the pointer move over the control
  81483. */
  81484. onPointerMoveObservable: BABYLON.Observable<BABYLON.Vector3>;
  81485. /**
  81486. * An event triggered when the pointer move out of the control
  81487. */
  81488. onPointerOutObservable: BABYLON.Observable<Control3D>;
  81489. /**
  81490. * An event triggered when the pointer taps the control
  81491. */
  81492. onPointerDownObservable: BABYLON.Observable<Vector3WithInfo>;
  81493. /**
  81494. * An event triggered when pointer is up
  81495. */
  81496. onPointerUpObservable: BABYLON.Observable<Vector3WithInfo>;
  81497. /**
  81498. * An event triggered when a control is clicked on (with a mouse)
  81499. */
  81500. onPointerClickObservable: BABYLON.Observable<Vector3WithInfo>;
  81501. /**
  81502. * An event triggered when pointer enters the control
  81503. */
  81504. onPointerEnterObservable: BABYLON.Observable<Control3D>;
  81505. /**
  81506. * Gets or sets the parent container
  81507. */
  81508. parent: BABYLON.Nullable<Container3D>;
  81509. private _behaviors;
  81510. /**
  81511. * Gets the list of attached behaviors
  81512. * @see https://doc.babylonjs.com/features/behaviour
  81513. */
  81514. get behaviors(): BABYLON.Behavior<Control3D>[];
  81515. /**
  81516. * Attach a behavior to the control
  81517. * @see https://doc.babylonjs.com/features/behaviour
  81518. * @param behavior defines the behavior to attach
  81519. * @returns the current control
  81520. */
  81521. addBehavior(behavior: BABYLON.Behavior<Control3D>): Control3D;
  81522. /**
  81523. * Remove an attached behavior
  81524. * @see https://doc.babylonjs.com/features/behaviour
  81525. * @param behavior defines the behavior to attach
  81526. * @returns the current control
  81527. */
  81528. removeBehavior(behavior: BABYLON.Behavior<Control3D>): Control3D;
  81529. /**
  81530. * Gets an attached behavior by name
  81531. * @param name defines the name of the behavior to look for
  81532. * @see https://doc.babylonjs.com/features/behaviour
  81533. * @returns null if behavior was not found else the requested behavior
  81534. */
  81535. getBehaviorByName(name: string): BABYLON.Nullable<BABYLON.Behavior<Control3D>>;
  81536. /** Gets or sets a boolean indicating if the control is visible */
  81537. get isVisible(): boolean;
  81538. set isVisible(value: boolean);
  81539. /**
  81540. * Creates a new control
  81541. * @param name defines the control name
  81542. */
  81543. constructor(
  81544. /** Defines the control name */
  81545. name?: string | undefined);
  81546. /**
  81547. * Gets a string representing the class name
  81548. */
  81549. get typeName(): string;
  81550. /**
  81551. * Get the current class name of the control.
  81552. * @returns current class name
  81553. */
  81554. getClassName(): string;
  81555. protected _getTypeName(): string;
  81556. /**
  81557. * Gets the transform node used by this control
  81558. */
  81559. get node(): BABYLON.Nullable<BABYLON.TransformNode>;
  81560. /**
  81561. * Gets the mesh used to render this control
  81562. */
  81563. get mesh(): BABYLON.Nullable<BABYLON.AbstractMesh>;
  81564. /**
  81565. * Link the control as child of the given node
  81566. * @param node defines the node to link to. Use null to unlink the control
  81567. * @returns the current control
  81568. */
  81569. linkToTransformNode(node: BABYLON.Nullable<BABYLON.TransformNode>): Control3D;
  81570. /** @hidden **/
  81571. _prepareNode(scene: BABYLON.Scene): void;
  81572. /**
  81573. * Node creation.
  81574. * Can be overriden by children
  81575. * @param scene defines the scene where the node must be attached
  81576. * @returns the attached node or null if none. Must return a BABYLON.Mesh or BABYLON.AbstractMesh if there is an atttached visible object
  81577. */
  81578. protected _createNode(scene: BABYLON.Scene): BABYLON.Nullable<BABYLON.TransformNode>;
  81579. /**
  81580. * Affect a material to the given mesh
  81581. * @param mesh defines the mesh which will represent the control
  81582. */
  81583. protected _affectMaterial(mesh: BABYLON.AbstractMesh): void;
  81584. /** @hidden */
  81585. _onPointerMove(target: Control3D, coordinates: BABYLON.Vector3): void;
  81586. /** @hidden */
  81587. _onPointerEnter(target: Control3D): boolean;
  81588. /** @hidden */
  81589. _onPointerOut(target: Control3D): void;
  81590. /** @hidden */
  81591. _onPointerDown(target: Control3D, coordinates: BABYLON.Vector3, pointerId: number, buttonIndex: number): boolean;
  81592. /** @hidden */
  81593. _onPointerUp(target: Control3D, coordinates: BABYLON.Vector3, pointerId: number, buttonIndex: number, notifyClick: boolean): void;
  81594. /** @hidden */
  81595. forcePointerUp(pointerId?: BABYLON.Nullable<number>): void;
  81596. /** @hidden */
  81597. _processObservables(type: number, pickedPoint: BABYLON.Vector3, pointerId: number, buttonIndex: number): boolean;
  81598. /** @hidden */
  81599. _disposeNode(): void;
  81600. /**
  81601. * Releases all associated resources
  81602. */
  81603. dispose(): void;
  81604. }
  81605. }
  81606. declare module BABYLON.GUI {
  81607. /**
  81608. * Class used as a root to all buttons
  81609. */
  81610. export class AbstractButton3D extends Control3D {
  81611. /**
  81612. * Creates a new button
  81613. * @param name defines the control name
  81614. */
  81615. constructor(name?: string);
  81616. protected _getTypeName(): string;
  81617. protected _createNode(scene: BABYLON.Scene): BABYLON.TransformNode;
  81618. }
  81619. }
  81620. declare module BABYLON.GUI {
  81621. /**
  81622. * Class used to create a button in 3D
  81623. */
  81624. export class Button3D extends AbstractButton3D {
  81625. /** @hidden */
  81626. protected _currentMaterial: BABYLON.Material;
  81627. private _facadeTexture;
  81628. private _content;
  81629. private _contentResolution;
  81630. private _contentScaleRatio;
  81631. /**
  81632. * Gets or sets the texture resolution used to render content (512 by default)
  81633. */
  81634. get contentResolution(): BABYLON.int;
  81635. set contentResolution(value: BABYLON.int);
  81636. /**
  81637. * Gets or sets the texture scale ratio used to render content (2 by default)
  81638. */
  81639. get contentScaleRatio(): number;
  81640. set contentScaleRatio(value: number);
  81641. protected _disposeFacadeTexture(): void;
  81642. protected _resetContent(): void;
  81643. /**
  81644. * Creates a new button
  81645. * @param name defines the control name
  81646. */
  81647. constructor(name?: string);
  81648. /**
  81649. * Gets or sets the GUI 2D content used to display the button's facade
  81650. */
  81651. get content(): Control;
  81652. set content(value: Control);
  81653. /**
  81654. * Apply the facade texture (created from the content property).
  81655. * This function can be overloaded by child classes
  81656. * @param facadeTexture defines the AdvancedDynamicTexture to use
  81657. */
  81658. protected _applyFacade(facadeTexture: AdvancedDynamicTexture): void;
  81659. protected _getTypeName(): string;
  81660. protected _createNode(scene: BABYLON.Scene): BABYLON.TransformNode;
  81661. protected _affectMaterial(mesh: BABYLON.AbstractMesh): void;
  81662. /**
  81663. * Releases all associated resources
  81664. */
  81665. dispose(): void;
  81666. }
  81667. }
  81668. declare module BABYLON.GUI {
  81669. /**
  81670. * Abstract class used to create a container panel deployed on the surface of a volume
  81671. */
  81672. export abstract class VolumeBasedPanel extends Container3D {
  81673. private _columns;
  81674. private _rows;
  81675. private _rowThenColum;
  81676. private _orientation;
  81677. protected _cellWidth: number;
  81678. protected _cellHeight: number;
  81679. /**
  81680. * Gets or sets the distance between elements
  81681. */
  81682. margin: number;
  81683. /**
  81684. * Gets or sets the orientation to apply to all controls (BABYLON.Container3D.FaceOriginReversedOrientation by default)
  81685. * | Value | Type | Description |
  81686. * | ----- | ----------------------------------- | ----------- |
  81687. * | 0 | UNSET_ORIENTATION | Control rotation will remain unchanged |
  81688. * | 1 | FACEORIGIN_ORIENTATION | Control will rotate to make it look at sphere central axis |
  81689. * | 2 | FACEORIGINREVERSED_ORIENTATION | Control will rotate to make it look back at sphere central axis |
  81690. * | 3 | FACEFORWARD_ORIENTATION | Control will rotate to look at z axis (0, 0, 1) |
  81691. * | 4 | FACEFORWARDREVERSED_ORIENTATION | Control will rotate to look at negative z axis (0, 0, -1) |
  81692. */
  81693. get orientation(): number;
  81694. set orientation(value: number);
  81695. /**
  81696. * Gets or sets the number of columns requested (10 by default).
  81697. * The panel will automatically compute the number of rows based on number of child controls.
  81698. */
  81699. get columns(): BABYLON.int;
  81700. set columns(value: BABYLON.int);
  81701. /**
  81702. * Gets or sets a the number of rows requested.
  81703. * The panel will automatically compute the number of columns based on number of child controls.
  81704. */
  81705. get rows(): BABYLON.int;
  81706. set rows(value: BABYLON.int);
  81707. /**
  81708. * Creates new VolumeBasedPanel
  81709. */
  81710. constructor();
  81711. protected _arrangeChildren(): void;
  81712. /** Child classes must implement this function to provide correct control positioning */
  81713. protected abstract _mapGridNode(control: Control3D, nodePosition: BABYLON.Vector3): void;
  81714. /** Child classes can implement this function to provide additional processing */
  81715. protected _finalProcessing(): void;
  81716. }
  81717. }
  81718. declare module BABYLON.GUI {
  81719. /**
  81720. * Class used to create a container panel deployed on the surface of a cylinder
  81721. */
  81722. export class CylinderPanel extends VolumeBasedPanel {
  81723. private _radius;
  81724. /**
  81725. * Gets or sets the radius of the cylinder where to project controls (5 by default)
  81726. */
  81727. get radius(): BABYLON.float;
  81728. set radius(value: BABYLON.float);
  81729. protected _mapGridNode(control: Control3D, nodePosition: BABYLON.Vector3): void;
  81730. private _cylindricalMapping;
  81731. }
  81732. }
  81733. declare module BABYLON.GUI {
  81734. /** @hidden */
  81735. export var fluentVertexShader: {
  81736. name: string;
  81737. shader: string;
  81738. };
  81739. }
  81740. declare module BABYLON.GUI {
  81741. /** @hidden */
  81742. export var fluentPixelShader: {
  81743. name: string;
  81744. shader: string;
  81745. };
  81746. }
  81747. declare module BABYLON.GUI {
  81748. /** @hidden */
  81749. export class FluentMaterialDefines extends BABYLON.MaterialDefines {
  81750. INNERGLOW: boolean;
  81751. BORDER: boolean;
  81752. HOVERLIGHT: boolean;
  81753. TEXTURE: boolean;
  81754. constructor();
  81755. }
  81756. /**
  81757. * Class used to render controls with fluent desgin
  81758. */
  81759. export class FluentMaterial extends BABYLON.PushMaterial {
  81760. /**
  81761. * Gets or sets inner glow intensity. A value of 0 means no glow (default is 0.5)
  81762. */
  81763. innerGlowColorIntensity: number;
  81764. /**
  81765. * Gets or sets the inner glow color (white by default)
  81766. */
  81767. innerGlowColor: BABYLON.Color3;
  81768. /**
  81769. * Gets or sets the albedo color (Default is BABYLON.Color3(0.3, 0.35, 0.4))
  81770. */
  81771. albedoColor: BABYLON.Color3;
  81772. /**
  81773. * Gets or sets a boolean indicating if borders must be rendered (default is false)
  81774. */
  81775. renderBorders: boolean;
  81776. /**
  81777. * Gets or sets border width (default is 0.5)
  81778. */
  81779. borderWidth: number;
  81780. /**
  81781. * Gets or sets a value indicating the smoothing value applied to border edges (0.02 by default)
  81782. */
  81783. edgeSmoothingValue: number;
  81784. /**
  81785. * Gets or sets the minimum value that can be applied to border width (default is 0.1)
  81786. */
  81787. borderMinValue: number;
  81788. /**
  81789. * Gets or sets a boolean indicating if hover light must be rendered (default is false)
  81790. */
  81791. renderHoverLight: boolean;
  81792. /**
  81793. * Gets or sets the radius used to render the hover light (default is 1.0)
  81794. */
  81795. hoverRadius: number;
  81796. /**
  81797. * Gets or sets the color used to render the hover light (default is BABYLON.Color4(0.3, 0.3, 0.3, 1.0))
  81798. */
  81799. hoverColor: BABYLON.Color4;
  81800. /**
  81801. * Gets or sets the hover light position in world space (default is BABYLON.Vector3.Zero())
  81802. */
  81803. hoverPosition: BABYLON.Vector3;
  81804. private _albedoTexture;
  81805. /** Gets or sets the texture to use for albedo color */
  81806. albedoTexture: BABYLON.Nullable<BABYLON.BaseTexture>;
  81807. /**
  81808. * Creates a new Fluent material
  81809. * @param name defines the name of the material
  81810. * @param scene defines the hosting scene
  81811. */
  81812. constructor(name: string, scene: BABYLON.Scene);
  81813. needAlphaBlending(): boolean;
  81814. needAlphaTesting(): boolean;
  81815. getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
  81816. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  81817. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  81818. getActiveTextures(): BABYLON.BaseTexture[];
  81819. hasTexture(texture: BABYLON.BaseTexture): boolean;
  81820. dispose(forceDisposeEffect?: boolean): void;
  81821. clone(name: string): FluentMaterial;
  81822. serialize(): any;
  81823. getClassName(): string;
  81824. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): FluentMaterial;
  81825. }
  81826. }
  81827. declare module BABYLON.GUI {
  81828. /**
  81829. * Class used to create a holographic button in 3D
  81830. */
  81831. export class HolographicButton extends Button3D {
  81832. private _backPlate;
  81833. private _textPlate;
  81834. private _frontPlate;
  81835. private _text;
  81836. private _imageUrl;
  81837. private _shareMaterials;
  81838. private _frontMaterial;
  81839. private _backMaterial;
  81840. private _plateMaterial;
  81841. private _pickedPointObserver;
  81842. private _tooltipFade;
  81843. private _tooltipTextBlock;
  81844. private _tooltipTexture;
  81845. private _tooltipMesh;
  81846. private _tooltipHoverObserver;
  81847. private _tooltipOutObserver;
  81848. private _disposeTooltip;
  81849. /**
  81850. * Rendering ground id of all the mesh in the button
  81851. */
  81852. set renderingGroupId(id: number);
  81853. get renderingGroupId(): number;
  81854. /**
  81855. * Text to be displayed on the tooltip shown when hovering on the button. When set to null tooltip is disabled. (Default: null)
  81856. */
  81857. set tooltipText(text: BABYLON.Nullable<string>);
  81858. get tooltipText(): BABYLON.Nullable<string>;
  81859. /**
  81860. * Gets or sets text for the button
  81861. */
  81862. get text(): string;
  81863. set text(value: string);
  81864. /**
  81865. * Gets or sets the image url for the button
  81866. */
  81867. get imageUrl(): string;
  81868. set imageUrl(value: string);
  81869. /**
  81870. * Gets the back material used by this button
  81871. */
  81872. get backMaterial(): FluentMaterial;
  81873. /**
  81874. * Gets the front material used by this button
  81875. */
  81876. get frontMaterial(): FluentMaterial;
  81877. /**
  81878. * Gets the plate material used by this button
  81879. */
  81880. get plateMaterial(): BABYLON.StandardMaterial;
  81881. /**
  81882. * Gets a boolean indicating if this button shares its material with other HolographicButtons
  81883. */
  81884. get shareMaterials(): boolean;
  81885. /**
  81886. * Creates a new button
  81887. * @param name defines the control name
  81888. */
  81889. constructor(name?: string, shareMaterials?: boolean);
  81890. protected _getTypeName(): string;
  81891. private _rebuildContent;
  81892. protected _createNode(scene: BABYLON.Scene): BABYLON.TransformNode;
  81893. protected _applyFacade(facadeTexture: AdvancedDynamicTexture): void;
  81894. private _createBackMaterial;
  81895. private _createFrontMaterial;
  81896. private _createPlateMaterial;
  81897. protected _affectMaterial(mesh: BABYLON.Mesh): void;
  81898. /**
  81899. * Releases all associated resources
  81900. */
  81901. dispose(): void;
  81902. }
  81903. }
  81904. declare module BABYLON.GUI {
  81905. /**
  81906. * Class used to create an interactable object. It's a 3D button using a mesh coming from the current scene
  81907. */
  81908. export class MeshButton3D extends Button3D {
  81909. /** @hidden */
  81910. protected _currentMesh: BABYLON.Mesh;
  81911. /**
  81912. * Creates a new 3D button based on a mesh
  81913. * @param mesh mesh to become a 3D button
  81914. * @param name defines the control name
  81915. */
  81916. constructor(mesh: BABYLON.Mesh, name?: string);
  81917. protected _getTypeName(): string;
  81918. protected _createNode(scene: BABYLON.Scene): BABYLON.TransformNode;
  81919. protected _affectMaterial(mesh: BABYLON.AbstractMesh): void;
  81920. }
  81921. }
  81922. declare module BABYLON.GUI {
  81923. /**
  81924. * Class used to create a container panel deployed on the surface of a plane
  81925. */
  81926. export class PlanePanel extends VolumeBasedPanel {
  81927. protected _mapGridNode(control: Control3D, nodePosition: BABYLON.Vector3): void;
  81928. }
  81929. }
  81930. declare module BABYLON.GUI {
  81931. /**
  81932. * Class used to create a container panel where items get randomized planar mapping
  81933. */
  81934. export class ScatterPanel extends VolumeBasedPanel {
  81935. private _iteration;
  81936. /**
  81937. * Gets or sets the number of iteration to use to scatter the controls (100 by default)
  81938. */
  81939. get iteration(): BABYLON.float;
  81940. set iteration(value: BABYLON.float);
  81941. protected _mapGridNode(control: Control3D, nodePosition: BABYLON.Vector3): void;
  81942. private _scatterMapping;
  81943. protected _finalProcessing(): void;
  81944. }
  81945. }
  81946. declare module BABYLON.GUI {
  81947. /**
  81948. * Class used to create a container panel deployed on the surface of a sphere
  81949. */
  81950. export class SpherePanel extends VolumeBasedPanel {
  81951. private _radius;
  81952. /**
  81953. * Gets or sets the radius of the sphere where to project controls (5 by default)
  81954. */
  81955. get radius(): BABYLON.float;
  81956. set radius(value: BABYLON.float);
  81957. protected _mapGridNode(control: Control3D, nodePosition: BABYLON.Vector3): void;
  81958. private _sphericalMapping;
  81959. }
  81960. }
  81961. declare module BABYLON.GUI {
  81962. /**
  81963. * Class used to create a stack panel in 3D on XY plane
  81964. */
  81965. export class StackPanel3D extends Container3D {
  81966. private _isVertical;
  81967. /**
  81968. * Gets or sets a boolean indicating if the stack panel is vertical or horizontal (horizontal by default)
  81969. */
  81970. get isVertical(): boolean;
  81971. set isVertical(value: boolean);
  81972. /**
  81973. * Gets or sets the distance between elements
  81974. */
  81975. margin: number;
  81976. /**
  81977. * Creates new StackPanel
  81978. * @param isVertical
  81979. */
  81980. constructor(isVertical?: boolean);
  81981. protected _arrangeChildren(): void;
  81982. }
  81983. }
  81984. declare module BABYLON {
  81985. /**
  81986. * Configuration for glTF validation
  81987. */
  81988. export interface IGLTFValidationConfiguration {
  81989. /**
  81990. * The url of the glTF validator.
  81991. */
  81992. url: string;
  81993. }
  81994. /**
  81995. * glTF validation
  81996. */
  81997. export class GLTFValidation {
  81998. /**
  81999. * The configuration. Defaults to `{ url: "https://preview.babylonjs.com/gltf_validator.js" }`.
  82000. */
  82001. static Configuration: IGLTFValidationConfiguration;
  82002. private static _LoadScriptPromise;
  82003. /**
  82004. * Validate a glTF asset using the glTF-Validator.
  82005. * @param data The JSON of a glTF or the array buffer of a binary glTF
  82006. * @param rootUrl The root url for the glTF
  82007. * @param fileName The file name for the glTF
  82008. * @param getExternalResource The callback to get external resources for the glTF validator
  82009. * @returns A promise that resolves with the glTF validation results once complete
  82010. */
  82011. static ValidateAsync(data: string | ArrayBuffer, rootUrl: string, fileName: string, getExternalResource: (uri: string) => Promise<ArrayBuffer>): Promise<BABYLON.GLTF2.IGLTFValidationResults>;
  82012. }
  82013. }
  82014. declare module BABYLON {
  82015. /**
  82016. * Mode that determines the coordinate system to use.
  82017. */
  82018. export enum GLTFLoaderCoordinateSystemMode {
  82019. /**
  82020. * Automatically convert the glTF right-handed data to the appropriate system based on the current coordinate system mode of the scene.
  82021. */
  82022. AUTO = 0,
  82023. /**
  82024. * Sets the useRightHandedSystem flag on the scene.
  82025. */
  82026. FORCE_RIGHT_HANDED = 1
  82027. }
  82028. /**
  82029. * Mode that determines what animations will start.
  82030. */
  82031. export enum GLTFLoaderAnimationStartMode {
  82032. /**
  82033. * No animation will start.
  82034. */
  82035. NONE = 0,
  82036. /**
  82037. * The first animation will start.
  82038. */
  82039. FIRST = 1,
  82040. /**
  82041. * All animations will start.
  82042. */
  82043. ALL = 2
  82044. }
  82045. /**
  82046. * Interface that contains the data for the glTF asset.
  82047. */
  82048. export interface IGLTFLoaderData {
  82049. /**
  82050. * The object that represents the glTF JSON.
  82051. */
  82052. json: Object;
  82053. /**
  82054. * The BIN chunk of a binary glTF.
  82055. */
  82056. bin: Nullable<IDataBuffer>;
  82057. }
  82058. /**
  82059. * Interface for extending the loader.
  82060. */
  82061. export interface IGLTFLoaderExtension {
  82062. /**
  82063. * The name of this extension.
  82064. */
  82065. readonly name: string;
  82066. /**
  82067. * Defines whether this extension is enabled.
  82068. */
  82069. enabled: boolean;
  82070. /**
  82071. * Defines the order of this extension.
  82072. * The loader sorts the extensions using these values when loading.
  82073. */
  82074. order?: number;
  82075. }
  82076. /**
  82077. * Loader state.
  82078. */
  82079. export enum GLTFLoaderState {
  82080. /**
  82081. * The asset is loading.
  82082. */
  82083. LOADING = 0,
  82084. /**
  82085. * The asset is ready for rendering.
  82086. */
  82087. READY = 1,
  82088. /**
  82089. * The asset is completely loaded.
  82090. */
  82091. COMPLETE = 2
  82092. }
  82093. /** @hidden */
  82094. export interface IImportMeshAsyncOutput {
  82095. meshes: AbstractMesh[];
  82096. geometries: Geometry[];
  82097. particleSystems: IParticleSystem[];
  82098. skeletons: Skeleton[];
  82099. animationGroups: AnimationGroup[];
  82100. lights: Light[];
  82101. transformNodes: TransformNode[];
  82102. }
  82103. /** @hidden */
  82104. export interface IGLTFLoader extends IDisposable {
  82105. readonly state: Nullable<GLTFLoaderState>;
  82106. importMeshAsync: (meshesNames: any, scene: Scene, forAssetContainer: boolean, data: IGLTFLoaderData, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string) => Promise<IImportMeshAsyncOutput>;
  82107. loadAsync: (scene: Scene, data: IGLTFLoaderData, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string) => Promise<void>;
  82108. }
  82109. /**
  82110. * File loader for loading glTF files into a scene.
  82111. */
  82112. export class GLTFFileLoader implements IDisposable, ISceneLoaderPluginAsync, ISceneLoaderPluginFactory {
  82113. /** @hidden */
  82114. static _CreateGLTF1Loader: (parent: GLTFFileLoader) => IGLTFLoader;
  82115. /** @hidden */
  82116. static _CreateGLTF2Loader: (parent: GLTFFileLoader) => IGLTFLoader;
  82117. /**
  82118. * Raised when the asset has been parsed
  82119. */
  82120. onParsedObservable: Observable<IGLTFLoaderData>;
  82121. private _onParsedObserver;
  82122. /**
  82123. * Raised when the asset has been parsed
  82124. */
  82125. set onParsed(callback: (loaderData: IGLTFLoaderData) => void);
  82126. /**
  82127. * Set this property to false to disable incremental loading which delays the loader from calling the success callback until after loading the meshes and shaders.
  82128. * Textures always loads asynchronously. For example, the success callback can compute the bounding information of the loaded meshes when incremental loading is disabled.
  82129. * Defaults to true.
  82130. * @hidden
  82131. */
  82132. static IncrementalLoading: boolean;
  82133. /**
  82134. * Set this property to true in order to work with homogeneous coordinates, available with some converters and exporters.
  82135. * Defaults to false. See https://en.wikipedia.org/wiki/Homogeneous_coordinates.
  82136. * @hidden
  82137. */
  82138. static HomogeneousCoordinates: boolean;
  82139. /**
  82140. * The coordinate system mode. Defaults to AUTO.
  82141. */
  82142. coordinateSystemMode: GLTFLoaderCoordinateSystemMode;
  82143. /**
  82144. * The animation start mode. Defaults to FIRST.
  82145. */
  82146. animationStartMode: GLTFLoaderAnimationStartMode;
  82147. /**
  82148. * Defines if the loader should compile materials before raising the success callback. Defaults to false.
  82149. */
  82150. compileMaterials: boolean;
  82151. /**
  82152. * Defines if the loader should also compile materials with clip planes. Defaults to false.
  82153. */
  82154. useClipPlane: boolean;
  82155. /**
  82156. * Defines if the loader should compile shadow generators before raising the success callback. Defaults to false.
  82157. */
  82158. compileShadowGenerators: boolean;
  82159. /**
  82160. * Defines if the Alpha blended materials are only applied as coverage.
  82161. * If false, (default) The luminance of each pixel will reduce its opacity to simulate the behaviour of most physical materials.
  82162. * If true, no extra effects are applied to transparent pixels.
  82163. */
  82164. transparencyAsCoverage: boolean;
  82165. /**
  82166. * Defines if the loader should use range requests when load binary glTF files from HTTP.
  82167. * Enabling will disable offline support and glTF validator.
  82168. * Defaults to false.
  82169. */
  82170. useRangeRequests: boolean;
  82171. /**
  82172. * Defines if the loader should create instances when multiple glTF nodes point to the same glTF mesh. Defaults to true.
  82173. */
  82174. createInstances: boolean;
  82175. /**
  82176. * Defines if the loader should always compute the bounding boxes of meshes and not use the min/max values from the position accessor. Defaults to false.
  82177. */
  82178. alwaysComputeBoundingBox: boolean;
  82179. /**
  82180. * If true, load all materials defined in the file, even if not used by any mesh. Defaults to false.
  82181. */
  82182. loadAllMaterials: boolean;
  82183. /**
  82184. * Function called before loading a url referenced by the asset.
  82185. */
  82186. preprocessUrlAsync: (url: string) => Promise<string>;
  82187. /**
  82188. * Observable raised when the loader creates a mesh after parsing the glTF properties of the mesh.
  82189. * Note that the observable is raised as soon as the mesh object is created, meaning some data may not have been setup yet for this mesh (vertex data, morph targets, material, ...)
  82190. */
  82191. readonly onMeshLoadedObservable: Observable<AbstractMesh>;
  82192. private _onMeshLoadedObserver;
  82193. /**
  82194. * Callback raised when the loader creates a mesh after parsing the glTF properties of the mesh.
  82195. * Note that the callback is called as soon as the mesh object is created, meaning some data may not have been setup yet for this mesh (vertex data, morph targets, material, ...)
  82196. */
  82197. set onMeshLoaded(callback: (mesh: AbstractMesh) => void);
  82198. /**
  82199. * Observable raised when the loader creates a texture after parsing the glTF properties of the texture.
  82200. */
  82201. readonly onTextureLoadedObservable: Observable<BaseTexture>;
  82202. private _onTextureLoadedObserver;
  82203. /**
  82204. * Callback raised when the loader creates a texture after parsing the glTF properties of the texture.
  82205. */
  82206. set onTextureLoaded(callback: (texture: BaseTexture) => void);
  82207. /**
  82208. * Observable raised when the loader creates a material after parsing the glTF properties of the material.
  82209. */
  82210. readonly onMaterialLoadedObservable: Observable<Material>;
  82211. private _onMaterialLoadedObserver;
  82212. /**
  82213. * Callback raised when the loader creates a material after parsing the glTF properties of the material.
  82214. */
  82215. set onMaterialLoaded(callback: (material: Material) => void);
  82216. /**
  82217. * Observable raised when the loader creates a camera after parsing the glTF properties of the camera.
  82218. */
  82219. readonly onCameraLoadedObservable: Observable<Camera>;
  82220. private _onCameraLoadedObserver;
  82221. /**
  82222. * Callback raised when the loader creates a camera after parsing the glTF properties of the camera.
  82223. */
  82224. set onCameraLoaded(callback: (camera: Camera) => void);
  82225. /**
  82226. * Observable raised when the asset is completely loaded, immediately before the loader is disposed.
  82227. * For assets with LODs, raised when all of the LODs are complete.
  82228. * For assets without LODs, raised when the model is complete, immediately after the loader resolves the returned promise.
  82229. */
  82230. readonly onCompleteObservable: Observable<void>;
  82231. private _onCompleteObserver;
  82232. /**
  82233. * Callback raised when the asset is completely loaded, immediately before the loader is disposed.
  82234. * For assets with LODs, raised when all of the LODs are complete.
  82235. * For assets without LODs, raised when the model is complete, immediately after the loader resolves the returned promise.
  82236. */
  82237. set onComplete(callback: () => void);
  82238. /**
  82239. * Observable raised when an error occurs.
  82240. */
  82241. readonly onErrorObservable: Observable<any>;
  82242. private _onErrorObserver;
  82243. /**
  82244. * Callback raised when an error occurs.
  82245. */
  82246. set onError(callback: (reason: any) => void);
  82247. /**
  82248. * Observable raised after the loader is disposed.
  82249. */
  82250. readonly onDisposeObservable: Observable<void>;
  82251. private _onDisposeObserver;
  82252. /**
  82253. * Callback raised after the loader is disposed.
  82254. */
  82255. set onDispose(callback: () => void);
  82256. /**
  82257. * Observable raised after a loader extension is created.
  82258. * Set additional options for a loader extension in this event.
  82259. */
  82260. readonly onExtensionLoadedObservable: Observable<IGLTFLoaderExtension>;
  82261. private _onExtensionLoadedObserver;
  82262. /**
  82263. * Callback raised after a loader extension is created.
  82264. */
  82265. set onExtensionLoaded(callback: (extension: IGLTFLoaderExtension) => void);
  82266. /**
  82267. * Defines if the loader logging is enabled.
  82268. */
  82269. get loggingEnabled(): boolean;
  82270. set loggingEnabled(value: boolean);
  82271. /**
  82272. * Defines if the loader should capture performance counters.
  82273. */
  82274. get capturePerformanceCounters(): boolean;
  82275. set capturePerformanceCounters(value: boolean);
  82276. /**
  82277. * Defines if the loader should validate the asset.
  82278. */
  82279. validate: boolean;
  82280. /**
  82281. * Observable raised after validation when validate is set to true. The event data is the result of the validation.
  82282. */
  82283. readonly onValidatedObservable: Observable<BABYLON.GLTF2.IGLTFValidationResults>;
  82284. private _onValidatedObserver;
  82285. /**
  82286. * Callback raised after a loader extension is created.
  82287. */
  82288. set onValidated(callback: (results: BABYLON.GLTF2.IGLTFValidationResults) => void);
  82289. private _loader;
  82290. private _progressCallback?;
  82291. private _requests;
  82292. private static magicBase64Encoded;
  82293. /**
  82294. * Name of the loader ("gltf")
  82295. */
  82296. name: string;
  82297. /** @hidden */
  82298. extensions: ISceneLoaderPluginExtensions;
  82299. /**
  82300. * Disposes the loader, releases resources during load, and cancels any outstanding requests.
  82301. */
  82302. dispose(): void;
  82303. /** @hidden */
  82304. requestFile(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  82305. /** @hidden */
  82306. readFile(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  82307. /** @hidden */
  82308. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  82309. meshes: AbstractMesh[];
  82310. particleSystems: IParticleSystem[];
  82311. skeletons: Skeleton[];
  82312. animationGroups: AnimationGroup[];
  82313. }>;
  82314. /** @hidden */
  82315. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  82316. /** @hidden */
  82317. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  82318. /** @hidden */
  82319. canDirectLoad(data: string): boolean;
  82320. /** @hidden */
  82321. directLoad(scene: Scene, data: string): Promise<any>;
  82322. /**
  82323. * The callback that allows custom handling of the root url based on the response url.
  82324. * @param rootUrl the original root url
  82325. * @param responseURL the response url if available
  82326. * @returns the new root url
  82327. */
  82328. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  82329. /** @hidden */
  82330. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  82331. /**
  82332. * The loader state or null if the loader is not active.
  82333. */
  82334. get loaderState(): Nullable<GLTFLoaderState>;
  82335. /**
  82336. * Returns a promise that resolves when the asset is completely loaded.
  82337. * @returns a promise that resolves when the asset is completely loaded.
  82338. */
  82339. whenCompleteAsync(): Promise<void>;
  82340. /** @hidden */
  82341. _loadFile(url: string, scene: Scene, onSuccess: (data: string | ArrayBuffer) => void, useArrayBuffer?: boolean, onError?: (request?: WebRequest) => void): IFileRequest;
  82342. /** @hidden */
  82343. _requestFile(url: string, scene: Scene, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  82344. private _onProgress;
  82345. private _validate;
  82346. private _getLoader;
  82347. private _parseJson;
  82348. private _unpackBinaryAsync;
  82349. private _unpackBinaryV1Async;
  82350. private _unpackBinaryV2Async;
  82351. private static _parseVersion;
  82352. private static _compareVersion;
  82353. private static readonly _logSpaces;
  82354. private _logIndentLevel;
  82355. private _loggingEnabled;
  82356. /** @hidden */
  82357. _log: (message: string) => void;
  82358. /** @hidden */
  82359. _logOpen(message: string): void;
  82360. /** @hidden */
  82361. _logClose(): void;
  82362. private _logEnabled;
  82363. private _logDisabled;
  82364. private _capturePerformanceCounters;
  82365. /** @hidden */
  82366. _startPerformanceCounter: (counterName: string) => void;
  82367. /** @hidden */
  82368. _endPerformanceCounter: (counterName: string) => void;
  82369. private _startPerformanceCounterEnabled;
  82370. private _startPerformanceCounterDisabled;
  82371. private _endPerformanceCounterEnabled;
  82372. private _endPerformanceCounterDisabled;
  82373. }
  82374. }
  82375. declare module BABYLON.GLTF1 {
  82376. /**
  82377. * Enums
  82378. * @hidden
  82379. */
  82380. export enum EComponentType {
  82381. BYTE = 5120,
  82382. UNSIGNED_BYTE = 5121,
  82383. SHORT = 5122,
  82384. UNSIGNED_SHORT = 5123,
  82385. FLOAT = 5126
  82386. }
  82387. /** @hidden */
  82388. export enum EShaderType {
  82389. FRAGMENT = 35632,
  82390. VERTEX = 35633
  82391. }
  82392. /** @hidden */
  82393. export enum EParameterType {
  82394. BYTE = 5120,
  82395. UNSIGNED_BYTE = 5121,
  82396. SHORT = 5122,
  82397. UNSIGNED_SHORT = 5123,
  82398. INT = 5124,
  82399. UNSIGNED_INT = 5125,
  82400. FLOAT = 5126,
  82401. FLOAT_VEC2 = 35664,
  82402. FLOAT_VEC3 = 35665,
  82403. FLOAT_VEC4 = 35666,
  82404. INT_VEC2 = 35667,
  82405. INT_VEC3 = 35668,
  82406. INT_VEC4 = 35669,
  82407. BOOL = 35670,
  82408. BOOL_VEC2 = 35671,
  82409. BOOL_VEC3 = 35672,
  82410. BOOL_VEC4 = 35673,
  82411. FLOAT_MAT2 = 35674,
  82412. FLOAT_MAT3 = 35675,
  82413. FLOAT_MAT4 = 35676,
  82414. SAMPLER_2D = 35678
  82415. }
  82416. /** @hidden */
  82417. export enum ETextureWrapMode {
  82418. CLAMP_TO_EDGE = 33071,
  82419. MIRRORED_REPEAT = 33648,
  82420. REPEAT = 10497
  82421. }
  82422. /** @hidden */
  82423. export enum ETextureFilterType {
  82424. NEAREST = 9728,
  82425. LINEAR = 9728,
  82426. NEAREST_MIPMAP_NEAREST = 9984,
  82427. LINEAR_MIPMAP_NEAREST = 9985,
  82428. NEAREST_MIPMAP_LINEAR = 9986,
  82429. LINEAR_MIPMAP_LINEAR = 9987
  82430. }
  82431. /** @hidden */
  82432. export enum ETextureFormat {
  82433. ALPHA = 6406,
  82434. RGB = 6407,
  82435. RGBA = 6408,
  82436. LUMINANCE = 6409,
  82437. LUMINANCE_ALPHA = 6410
  82438. }
  82439. /** @hidden */
  82440. export enum ECullingType {
  82441. FRONT = 1028,
  82442. BACK = 1029,
  82443. FRONT_AND_BACK = 1032
  82444. }
  82445. /** @hidden */
  82446. export enum EBlendingFunction {
  82447. ZERO = 0,
  82448. ONE = 1,
  82449. SRC_COLOR = 768,
  82450. ONE_MINUS_SRC_COLOR = 769,
  82451. DST_COLOR = 774,
  82452. ONE_MINUS_DST_COLOR = 775,
  82453. SRC_ALPHA = 770,
  82454. ONE_MINUS_SRC_ALPHA = 771,
  82455. DST_ALPHA = 772,
  82456. ONE_MINUS_DST_ALPHA = 773,
  82457. CONSTANT_COLOR = 32769,
  82458. ONE_MINUS_CONSTANT_COLOR = 32770,
  82459. CONSTANT_ALPHA = 32771,
  82460. ONE_MINUS_CONSTANT_ALPHA = 32772,
  82461. SRC_ALPHA_SATURATE = 776
  82462. }
  82463. /** @hidden */
  82464. export interface IGLTFProperty {
  82465. extensions?: {
  82466. [key: string]: any;
  82467. };
  82468. extras?: Object;
  82469. }
  82470. /** @hidden */
  82471. export interface IGLTFChildRootProperty extends IGLTFProperty {
  82472. name?: string;
  82473. }
  82474. /** @hidden */
  82475. export interface IGLTFAccessor extends IGLTFChildRootProperty {
  82476. bufferView: string;
  82477. byteOffset: number;
  82478. byteStride: number;
  82479. count: number;
  82480. type: string;
  82481. componentType: EComponentType;
  82482. max?: number[];
  82483. min?: number[];
  82484. name?: string;
  82485. }
  82486. /** @hidden */
  82487. export interface IGLTFBufferView extends IGLTFChildRootProperty {
  82488. buffer: string;
  82489. byteOffset: number;
  82490. byteLength: number;
  82491. byteStride: number;
  82492. target?: number;
  82493. }
  82494. /** @hidden */
  82495. export interface IGLTFBuffer extends IGLTFChildRootProperty {
  82496. uri: string;
  82497. byteLength?: number;
  82498. type?: string;
  82499. }
  82500. /** @hidden */
  82501. export interface IGLTFShader extends IGLTFChildRootProperty {
  82502. uri: string;
  82503. type: EShaderType;
  82504. }
  82505. /** @hidden */
  82506. export interface IGLTFProgram extends IGLTFChildRootProperty {
  82507. attributes: string[];
  82508. fragmentShader: string;
  82509. vertexShader: string;
  82510. }
  82511. /** @hidden */
  82512. export interface IGLTFTechniqueParameter {
  82513. type: number;
  82514. count?: number;
  82515. semantic?: string;
  82516. node?: string;
  82517. value?: number | boolean | string | Array<any>;
  82518. source?: string;
  82519. babylonValue?: any;
  82520. }
  82521. /** @hidden */
  82522. export interface IGLTFTechniqueCommonProfile {
  82523. lightingModel: string;
  82524. texcoordBindings: Object;
  82525. parameters?: Array<any>;
  82526. }
  82527. /** @hidden */
  82528. export interface IGLTFTechniqueStatesFunctions {
  82529. blendColor?: number[];
  82530. blendEquationSeparate?: number[];
  82531. blendFuncSeparate?: number[];
  82532. colorMask: boolean[];
  82533. cullFace: number[];
  82534. }
  82535. /** @hidden */
  82536. export interface IGLTFTechniqueStates {
  82537. enable: number[];
  82538. functions: IGLTFTechniqueStatesFunctions;
  82539. }
  82540. /** @hidden */
  82541. export interface IGLTFTechnique extends IGLTFChildRootProperty {
  82542. parameters: {
  82543. [key: string]: IGLTFTechniqueParameter;
  82544. };
  82545. program: string;
  82546. attributes: {
  82547. [key: string]: string;
  82548. };
  82549. uniforms: {
  82550. [key: string]: string;
  82551. };
  82552. states: IGLTFTechniqueStates;
  82553. }
  82554. /** @hidden */
  82555. export interface IGLTFMaterial extends IGLTFChildRootProperty {
  82556. technique?: string;
  82557. values: string[];
  82558. }
  82559. /** @hidden */
  82560. export interface IGLTFMeshPrimitive extends IGLTFProperty {
  82561. attributes: {
  82562. [key: string]: string;
  82563. };
  82564. indices: string;
  82565. material: string;
  82566. mode?: number;
  82567. }
  82568. /** @hidden */
  82569. export interface IGLTFMesh extends IGLTFChildRootProperty {
  82570. primitives: IGLTFMeshPrimitive[];
  82571. }
  82572. /** @hidden */
  82573. export interface IGLTFImage extends IGLTFChildRootProperty {
  82574. uri: string;
  82575. }
  82576. /** @hidden */
  82577. export interface IGLTFSampler extends IGLTFChildRootProperty {
  82578. magFilter?: number;
  82579. minFilter?: number;
  82580. wrapS?: number;
  82581. wrapT?: number;
  82582. }
  82583. /** @hidden */
  82584. export interface IGLTFTexture extends IGLTFChildRootProperty {
  82585. sampler: string;
  82586. source: string;
  82587. format?: ETextureFormat;
  82588. internalFormat?: ETextureFormat;
  82589. target?: number;
  82590. type?: number;
  82591. babylonTexture?: Texture;
  82592. }
  82593. /** @hidden */
  82594. export interface IGLTFAmbienLight {
  82595. color?: number[];
  82596. }
  82597. /** @hidden */
  82598. export interface IGLTFDirectionalLight {
  82599. color?: number[];
  82600. }
  82601. /** @hidden */
  82602. export interface IGLTFPointLight {
  82603. color?: number[];
  82604. constantAttenuation?: number;
  82605. linearAttenuation?: number;
  82606. quadraticAttenuation?: number;
  82607. }
  82608. /** @hidden */
  82609. export interface IGLTFSpotLight {
  82610. color?: number[];
  82611. constantAttenuation?: number;
  82612. fallOfAngle?: number;
  82613. fallOffExponent?: number;
  82614. linearAttenuation?: number;
  82615. quadraticAttenuation?: number;
  82616. }
  82617. /** @hidden */
  82618. export interface IGLTFLight extends IGLTFChildRootProperty {
  82619. type: string;
  82620. }
  82621. /** @hidden */
  82622. export interface IGLTFCameraOrthographic {
  82623. xmag: number;
  82624. ymag: number;
  82625. zfar: number;
  82626. znear: number;
  82627. }
  82628. /** @hidden */
  82629. export interface IGLTFCameraPerspective {
  82630. aspectRatio: number;
  82631. yfov: number;
  82632. zfar: number;
  82633. znear: number;
  82634. }
  82635. /** @hidden */
  82636. export interface IGLTFCamera extends IGLTFChildRootProperty {
  82637. type: string;
  82638. }
  82639. /** @hidden */
  82640. export interface IGLTFAnimationChannelTarget {
  82641. id: string;
  82642. path: string;
  82643. }
  82644. /** @hidden */
  82645. export interface IGLTFAnimationChannel {
  82646. sampler: string;
  82647. target: IGLTFAnimationChannelTarget;
  82648. }
  82649. /** @hidden */
  82650. export interface IGLTFAnimationSampler {
  82651. input: string;
  82652. output: string;
  82653. interpolation?: string;
  82654. }
  82655. /** @hidden */
  82656. export interface IGLTFAnimation extends IGLTFChildRootProperty {
  82657. channels?: IGLTFAnimationChannel[];
  82658. parameters?: {
  82659. [key: string]: string;
  82660. };
  82661. samplers?: {
  82662. [key: string]: IGLTFAnimationSampler;
  82663. };
  82664. }
  82665. /** @hidden */
  82666. export interface IGLTFNodeInstanceSkin {
  82667. skeletons: string[];
  82668. skin: string;
  82669. meshes: string[];
  82670. }
  82671. /** @hidden */
  82672. export interface IGLTFSkins extends IGLTFChildRootProperty {
  82673. bindShapeMatrix: number[];
  82674. inverseBindMatrices: string;
  82675. jointNames: string[];
  82676. babylonSkeleton?: Skeleton;
  82677. }
  82678. /** @hidden */
  82679. export interface IGLTFNode extends IGLTFChildRootProperty {
  82680. camera?: string;
  82681. children: string[];
  82682. skin?: string;
  82683. jointName?: string;
  82684. light?: string;
  82685. matrix: number[];
  82686. mesh?: string;
  82687. meshes?: string[];
  82688. rotation?: number[];
  82689. scale?: number[];
  82690. translation?: number[];
  82691. babylonNode?: Node;
  82692. }
  82693. /** @hidden */
  82694. export interface IGLTFScene extends IGLTFChildRootProperty {
  82695. nodes: string[];
  82696. }
  82697. /** @hidden */
  82698. export interface IGLTFRuntime {
  82699. extensions: {
  82700. [key: string]: any;
  82701. };
  82702. accessors: {
  82703. [key: string]: IGLTFAccessor;
  82704. };
  82705. buffers: {
  82706. [key: string]: IGLTFBuffer;
  82707. };
  82708. bufferViews: {
  82709. [key: string]: IGLTFBufferView;
  82710. };
  82711. meshes: {
  82712. [key: string]: IGLTFMesh;
  82713. };
  82714. lights: {
  82715. [key: string]: IGLTFLight;
  82716. };
  82717. cameras: {
  82718. [key: string]: IGLTFCamera;
  82719. };
  82720. nodes: {
  82721. [key: string]: IGLTFNode;
  82722. };
  82723. images: {
  82724. [key: string]: IGLTFImage;
  82725. };
  82726. textures: {
  82727. [key: string]: IGLTFTexture;
  82728. };
  82729. shaders: {
  82730. [key: string]: IGLTFShader;
  82731. };
  82732. programs: {
  82733. [key: string]: IGLTFProgram;
  82734. };
  82735. samplers: {
  82736. [key: string]: IGLTFSampler;
  82737. };
  82738. techniques: {
  82739. [key: string]: IGLTFTechnique;
  82740. };
  82741. materials: {
  82742. [key: string]: IGLTFMaterial;
  82743. };
  82744. animations: {
  82745. [key: string]: IGLTFAnimation;
  82746. };
  82747. skins: {
  82748. [key: string]: IGLTFSkins;
  82749. };
  82750. currentScene?: Object;
  82751. scenes: {
  82752. [key: string]: IGLTFScene;
  82753. };
  82754. extensionsUsed: string[];
  82755. extensionsRequired?: string[];
  82756. buffersCount: number;
  82757. shaderscount: number;
  82758. scene: Scene;
  82759. rootUrl: string;
  82760. loadedBufferCount: number;
  82761. loadedBufferViews: {
  82762. [name: string]: ArrayBufferView;
  82763. };
  82764. loadedShaderCount: number;
  82765. importOnlyMeshes: boolean;
  82766. importMeshesNames?: string[];
  82767. dummyNodes: Node[];
  82768. forAssetContainer: boolean;
  82769. }
  82770. /** @hidden */
  82771. export interface INodeToRoot {
  82772. bone: Bone;
  82773. node: IGLTFNode;
  82774. id: string;
  82775. }
  82776. /** @hidden */
  82777. export interface IJointNode {
  82778. node: IGLTFNode;
  82779. id: string;
  82780. }
  82781. }
  82782. declare module BABYLON.GLTF1 {
  82783. /**
  82784. * Utils functions for GLTF
  82785. * @hidden
  82786. */
  82787. export class GLTFUtils {
  82788. /**
  82789. * Sets the given "parameter" matrix
  82790. * @param scene: the Scene object
  82791. * @param source: the source node where to pick the matrix
  82792. * @param parameter: the GLTF technique parameter
  82793. * @param uniformName: the name of the shader's uniform
  82794. * @param shaderMaterial: the shader material
  82795. */
  82796. static SetMatrix(scene: Scene, source: Node, parameter: IGLTFTechniqueParameter, uniformName: string, shaderMaterial: ShaderMaterial | Effect): void;
  82797. /**
  82798. * Sets the given "parameter" matrix
  82799. * @param shaderMaterial: the shader material
  82800. * @param uniform: the name of the shader's uniform
  82801. * @param value: the value of the uniform
  82802. * @param type: the uniform's type (EParameterType FLOAT, VEC2, VEC3 or VEC4)
  82803. */
  82804. static SetUniform(shaderMaterial: ShaderMaterial | Effect, uniform: string, value: any, type: number): boolean;
  82805. /**
  82806. * Returns the wrap mode of the texture
  82807. * @param mode: the mode value
  82808. */
  82809. static GetWrapMode(mode: number): number;
  82810. /**
  82811. * Returns the byte stride giving an accessor
  82812. * @param accessor: the GLTF accessor objet
  82813. */
  82814. static GetByteStrideFromType(accessor: IGLTFAccessor): number;
  82815. /**
  82816. * Returns the texture filter mode giving a mode value
  82817. * @param mode: the filter mode value
  82818. */
  82819. static GetTextureFilterMode(mode: number): ETextureFilterType;
  82820. static GetBufferFromBufferView(gltfRuntime: IGLTFRuntime, bufferView: IGLTFBufferView, byteOffset: number, byteLength: number, componentType: EComponentType): ArrayBufferView;
  82821. /**
  82822. * Returns a buffer from its accessor
  82823. * @param gltfRuntime: the GLTF runtime
  82824. * @param accessor: the GLTF accessor
  82825. */
  82826. static GetBufferFromAccessor(gltfRuntime: IGLTFRuntime, accessor: IGLTFAccessor): any;
  82827. /**
  82828. * Decodes a buffer view into a string
  82829. * @param view: the buffer view
  82830. */
  82831. static DecodeBufferToText(view: ArrayBufferView): string;
  82832. /**
  82833. * Returns the default material of gltf. Related to
  82834. * https://github.com/KhronosGroup/glTF/tree/master/specification/1.0#appendix-a-default-material
  82835. * @param scene: the Babylon.js scene
  82836. */
  82837. static GetDefaultMaterial(scene: Scene): ShaderMaterial;
  82838. private static _DefaultMaterial;
  82839. }
  82840. }
  82841. declare module BABYLON.GLTF1 {
  82842. /**
  82843. * Implementation of the base glTF spec
  82844. * @hidden
  82845. */
  82846. export class GLTFLoaderBase {
  82847. static CreateRuntime(parsedData: any, scene: Scene, rootUrl: string): IGLTFRuntime;
  82848. static LoadBufferAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (buffer: ArrayBufferView) => void, onError: (message: string) => void, onProgress?: () => void): void;
  82849. static LoadTextureBufferAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (buffer: Nullable<ArrayBufferView>) => void, onError: (message: string) => void): void;
  82850. static CreateTextureAsync(gltfRuntime: IGLTFRuntime, id: string, buffer: Nullable<ArrayBufferView>, onSuccess: (texture: Texture) => void, onError: (message: string) => void): void;
  82851. static LoadShaderStringAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (shaderString: string | ArrayBuffer) => void, onError?: (message: string) => void): void;
  82852. static LoadMaterialAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (material: Material) => void, onError: (message: string) => void): void;
  82853. }
  82854. /**
  82855. * glTF V1 Loader
  82856. * @hidden
  82857. */
  82858. export class GLTFLoader implements IGLTFLoader {
  82859. static Extensions: {
  82860. [name: string]: GLTFLoaderExtension;
  82861. };
  82862. static RegisterExtension(extension: GLTFLoaderExtension): void;
  82863. state: Nullable<GLTFLoaderState>;
  82864. dispose(): void;
  82865. private _importMeshAsync;
  82866. /**
  82867. * Imports one or more meshes from a loaded gltf file and adds them to the scene
  82868. * @param meshesNames a string or array of strings of the mesh names that should be loaded from the file
  82869. * @param scene the scene the meshes should be added to
  82870. * @param forAssetContainer defines if the entities must be stored in the scene
  82871. * @param data gltf data containing information of the meshes in a loaded file
  82872. * @param rootUrl root url to load from
  82873. * @param onProgress event that fires when loading progress has occured
  82874. * @returns a promise containg the loaded meshes, particles, skeletons and animations
  82875. */
  82876. importMeshAsync(meshesNames: any, scene: Scene, forAssetContainer: boolean, data: IGLTFLoaderData, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void): Promise<IImportMeshAsyncOutput>;
  82877. private _loadAsync;
  82878. /**
  82879. * Imports all objects from a loaded gltf file and adds them to the scene
  82880. * @param scene the scene the objects should be added to
  82881. * @param data gltf data containing information of the meshes in a loaded file
  82882. * @param rootUrl root url to load from
  82883. * @param onProgress event that fires when loading progress has occured
  82884. * @returns a promise which completes when objects have been loaded to the scene
  82885. */
  82886. loadAsync(scene: Scene, data: IGLTFLoaderData, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void): Promise<void>;
  82887. private _loadShadersAsync;
  82888. private _loadBuffersAsync;
  82889. private _createNodes;
  82890. }
  82891. /** @hidden */
  82892. export abstract class GLTFLoaderExtension {
  82893. private _name;
  82894. constructor(name: string);
  82895. get name(): string;
  82896. /**
  82897. * Defines an override for loading the runtime
  82898. * Return true to stop further extensions from loading the runtime
  82899. */
  82900. loadRuntimeAsync(scene: Scene, data: IGLTFLoaderData, rootUrl: string, onSuccess?: (gltfRuntime: IGLTFRuntime) => void, onError?: (message: string) => void): boolean;
  82901. /**
  82902. * Defines an onverride for creating gltf runtime
  82903. * Return true to stop further extensions from creating the runtime
  82904. */
  82905. loadRuntimeExtensionsAsync(gltfRuntime: IGLTFRuntime, onSuccess: () => void, onError?: (message: string) => void): boolean;
  82906. /**
  82907. * Defines an override for loading buffers
  82908. * Return true to stop further extensions from loading this buffer
  82909. */
  82910. loadBufferAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (buffer: ArrayBufferView) => void, onError: (message: string) => void, onProgress?: () => void): boolean;
  82911. /**
  82912. * Defines an override for loading texture buffers
  82913. * Return true to stop further extensions from loading this texture data
  82914. */
  82915. loadTextureBufferAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (buffer: ArrayBufferView) => void, onError: (message: string) => void): boolean;
  82916. /**
  82917. * Defines an override for creating textures
  82918. * Return true to stop further extensions from loading this texture
  82919. */
  82920. createTextureAsync(gltfRuntime: IGLTFRuntime, id: string, buffer: ArrayBufferView, onSuccess: (texture: Texture) => void, onError: (message: string) => void): boolean;
  82921. /**
  82922. * Defines an override for loading shader strings
  82923. * Return true to stop further extensions from loading this shader data
  82924. */
  82925. loadShaderStringAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (shaderString: string) => void, onError: (message: string) => void): boolean;
  82926. /**
  82927. * Defines an override for loading materials
  82928. * Return true to stop further extensions from loading this material
  82929. */
  82930. loadMaterialAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (material: Material) => void, onError: (message: string) => void): boolean;
  82931. static LoadRuntimeAsync(scene: Scene, data: IGLTFLoaderData, rootUrl: string, onSuccess?: (gltfRuntime: IGLTFRuntime) => void, onError?: (message: string) => void): void;
  82932. static LoadRuntimeExtensionsAsync(gltfRuntime: IGLTFRuntime, onSuccess: () => void, onError?: (message: string) => void): void;
  82933. static LoadBufferAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (bufferView: ArrayBufferView) => void, onError: (message: string) => void, onProgress?: () => void): void;
  82934. static LoadTextureAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (texture: Texture) => void, onError: (message: string) => void): void;
  82935. static LoadShaderStringAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (shaderData: string | ArrayBuffer) => void, onError: (message: string) => void): void;
  82936. static LoadMaterialAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (material: Material) => void, onError: (message: string) => void): void;
  82937. private static LoadTextureBufferAsync;
  82938. private static CreateTextureAsync;
  82939. private static ApplyExtensions;
  82940. }
  82941. }
  82942. declare module BABYLON.GLTF1 {
  82943. /** @hidden */
  82944. export class GLTFBinaryExtension extends GLTFLoaderExtension {
  82945. private _bin;
  82946. constructor();
  82947. loadRuntimeAsync(scene: Scene, data: IGLTFLoaderData, rootUrl: string, onSuccess: (gltfRuntime: IGLTFRuntime) => void, onError: (message: string) => void): boolean;
  82948. loadBufferAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (buffer: ArrayBufferView) => void, onError: (message: string) => void): boolean;
  82949. loadTextureBufferAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (buffer: ArrayBufferView) => void, onError: (message: string) => void): boolean;
  82950. loadShaderStringAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (shaderString: string) => void, onError: (message: string) => void): boolean;
  82951. }
  82952. }
  82953. declare module BABYLON.GLTF1 {
  82954. /** @hidden */
  82955. export class GLTFMaterialsCommonExtension extends GLTFLoaderExtension {
  82956. constructor();
  82957. loadRuntimeExtensionsAsync(gltfRuntime: IGLTFRuntime, onSuccess: () => void, onError: (message: string) => void): boolean;
  82958. loadMaterialAsync(gltfRuntime: IGLTFRuntime, id: string, onSuccess: (material: Material) => void, onError: (message: string) => void): boolean;
  82959. private _loadTexture;
  82960. }
  82961. }
  82962. declare module BABYLON.GLTF2.Loader {
  82963. /**
  82964. * Loader interface with an index field.
  82965. */
  82966. export interface IArrayItem {
  82967. /**
  82968. * The index of this item in the array.
  82969. */
  82970. index: number;
  82971. }
  82972. /**
  82973. * Loader interface with additional members.
  82974. */
  82975. export interface IAccessor extends BABYLON.GLTF2.IAccessor, IArrayItem {
  82976. /** @hidden */
  82977. _data?: Promise<ArrayBufferView>;
  82978. /** @hidden */
  82979. _babylonVertexBuffer?: Promise<VertexBuffer>;
  82980. }
  82981. /**
  82982. * Loader interface with additional members.
  82983. */
  82984. export interface IAnimationChannel extends BABYLON.GLTF2.IAnimationChannel, IArrayItem {
  82985. }
  82986. /** @hidden */
  82987. export interface _IAnimationSamplerData {
  82988. input: Float32Array;
  82989. interpolation: BABYLON.GLTF2.AnimationSamplerInterpolation;
  82990. output: Float32Array;
  82991. }
  82992. /**
  82993. * Loader interface with additional members.
  82994. */
  82995. export interface IAnimationSampler extends BABYLON.GLTF2.IAnimationSampler, IArrayItem {
  82996. /** @hidden */
  82997. _data?: Promise<_IAnimationSamplerData>;
  82998. }
  82999. /**
  83000. * Loader interface with additional members.
  83001. */
  83002. export interface IAnimation extends BABYLON.GLTF2.IAnimation, IArrayItem {
  83003. channels: IAnimationChannel[];
  83004. samplers: IAnimationSampler[];
  83005. /** @hidden */
  83006. _babylonAnimationGroup?: AnimationGroup;
  83007. }
  83008. /**
  83009. * Loader interface with additional members.
  83010. */
  83011. export interface IBuffer extends BABYLON.GLTF2.IBuffer, IArrayItem {
  83012. /** @hidden */
  83013. _data?: Promise<ArrayBufferView>;
  83014. }
  83015. /**
  83016. * Loader interface with additional members.
  83017. */
  83018. export interface IBufferView extends BABYLON.GLTF2.IBufferView, IArrayItem {
  83019. /** @hidden */
  83020. _data?: Promise<ArrayBufferView>;
  83021. /** @hidden */
  83022. _babylonBuffer?: Promise<Buffer>;
  83023. }
  83024. /**
  83025. * Loader interface with additional members.
  83026. */
  83027. export interface ICamera extends BABYLON.GLTF2.ICamera, IArrayItem {
  83028. }
  83029. /**
  83030. * Loader interface with additional members.
  83031. */
  83032. export interface IImage extends BABYLON.GLTF2.IImage, IArrayItem {
  83033. /** @hidden */
  83034. _data?: Promise<ArrayBufferView>;
  83035. }
  83036. /**
  83037. * Loader interface with additional members.
  83038. */
  83039. export interface IMaterialNormalTextureInfo extends BABYLON.GLTF2.IMaterialNormalTextureInfo, ITextureInfo {
  83040. }
  83041. /**
  83042. * Loader interface with additional members.
  83043. */
  83044. export interface IMaterialOcclusionTextureInfo extends BABYLON.GLTF2.IMaterialOcclusionTextureInfo, ITextureInfo {
  83045. }
  83046. /**
  83047. * Loader interface with additional members.
  83048. */
  83049. export interface IMaterialPbrMetallicRoughness extends BABYLON.GLTF2.IMaterialPbrMetallicRoughness {
  83050. baseColorTexture?: ITextureInfo;
  83051. metallicRoughnessTexture?: ITextureInfo;
  83052. }
  83053. /**
  83054. * Loader interface with additional members.
  83055. */
  83056. export interface IMaterial extends BABYLON.GLTF2.IMaterial, IArrayItem {
  83057. pbrMetallicRoughness?: IMaterialPbrMetallicRoughness;
  83058. normalTexture?: IMaterialNormalTextureInfo;
  83059. occlusionTexture?: IMaterialOcclusionTextureInfo;
  83060. emissiveTexture?: ITextureInfo;
  83061. /** @hidden */
  83062. _data?: {
  83063. [babylonDrawMode: number]: {
  83064. babylonMaterial: Material;
  83065. babylonMeshes: AbstractMesh[];
  83066. promise: Promise<void>;
  83067. };
  83068. };
  83069. }
  83070. /**
  83071. * Loader interface with additional members.
  83072. */
  83073. export interface IMesh extends BABYLON.GLTF2.IMesh, IArrayItem {
  83074. primitives: IMeshPrimitive[];
  83075. }
  83076. /**
  83077. * Loader interface with additional members.
  83078. */
  83079. export interface IMeshPrimitive extends BABYLON.GLTF2.IMeshPrimitive, IArrayItem {
  83080. /** @hidden */
  83081. _instanceData?: {
  83082. babylonSourceMesh: Mesh;
  83083. promise: Promise<any>;
  83084. };
  83085. }
  83086. /**
  83087. * Loader interface with additional members.
  83088. */
  83089. export interface INode extends BABYLON.GLTF2.INode, IArrayItem {
  83090. /**
  83091. * The parent glTF node.
  83092. */
  83093. parent?: INode;
  83094. /** @hidden */
  83095. _babylonTransformNode?: TransformNode;
  83096. /** @hidden */
  83097. _primitiveBabylonMeshes?: AbstractMesh[];
  83098. /** @hidden */
  83099. _babylonBones?: Bone[];
  83100. /** @hidden */
  83101. _numMorphTargets?: number;
  83102. }
  83103. /** @hidden */
  83104. export interface _ISamplerData {
  83105. noMipMaps: boolean;
  83106. samplingMode: number;
  83107. wrapU: number;
  83108. wrapV: number;
  83109. }
  83110. /**
  83111. * Loader interface with additional members.
  83112. */
  83113. export interface ISampler extends BABYLON.GLTF2.ISampler, IArrayItem {
  83114. /** @hidden */
  83115. _data?: _ISamplerData;
  83116. }
  83117. /**
  83118. * Loader interface with additional members.
  83119. */
  83120. export interface IScene extends BABYLON.GLTF2.IScene, IArrayItem {
  83121. }
  83122. /**
  83123. * Loader interface with additional members.
  83124. */
  83125. export interface ISkin extends BABYLON.GLTF2.ISkin, IArrayItem {
  83126. /** @hidden */
  83127. _data?: {
  83128. babylonSkeleton: Skeleton;
  83129. promise: Promise<void>;
  83130. };
  83131. }
  83132. /**
  83133. * Loader interface with additional members.
  83134. */
  83135. export interface ITexture extends BABYLON.GLTF2.ITexture, IArrayItem {
  83136. /** @hidden */
  83137. _textureInfo: ITextureInfo;
  83138. }
  83139. /**
  83140. * Loader interface with additional members.
  83141. */
  83142. export interface ITextureInfo extends BABYLON.GLTF2.ITextureInfo {
  83143. /** false or undefined if the texture holds color data (true if data are roughness, normal, ...) */
  83144. nonColorData?: boolean;
  83145. }
  83146. /**
  83147. * Loader interface with additional members.
  83148. */
  83149. export interface IGLTF extends BABYLON.GLTF2.IGLTF {
  83150. accessors?: IAccessor[];
  83151. animations?: IAnimation[];
  83152. buffers?: IBuffer[];
  83153. bufferViews?: IBufferView[];
  83154. cameras?: ICamera[];
  83155. images?: IImage[];
  83156. materials?: IMaterial[];
  83157. meshes?: IMesh[];
  83158. nodes?: INode[];
  83159. samplers?: ISampler[];
  83160. scenes?: IScene[];
  83161. skins?: ISkin[];
  83162. textures?: ITexture[];
  83163. }
  83164. }
  83165. declare module BABYLON.GLTF2 {
  83166. /**
  83167. * Interface for a glTF loader extension.
  83168. */
  83169. export interface IGLTFLoaderExtension extends BABYLON.IGLTFLoaderExtension, IDisposable {
  83170. /**
  83171. * Called after the loader state changes to LOADING.
  83172. */
  83173. onLoading?(): void;
  83174. /**
  83175. * Called after the loader state changes to READY.
  83176. */
  83177. onReady?(): void;
  83178. /**
  83179. * Define this method to modify the default behavior when loading scenes.
  83180. * @param context The context when loading the asset
  83181. * @param scene The glTF scene property
  83182. * @returns A promise that resolves when the load is complete or null if not handled
  83183. */
  83184. loadSceneAsync?(context: string, scene: IScene): Nullable<Promise<void>>;
  83185. /**
  83186. * Define this method to modify the default behavior when loading nodes.
  83187. * @param context The context when loading the asset
  83188. * @param node The glTF node property
  83189. * @param assign A function called synchronously after parsing the glTF properties
  83190. * @returns A promise that resolves with the loaded Babylon transform node when the load is complete or null if not handled
  83191. */
  83192. loadNodeAsync?(context: string, node: INode, assign: (babylonMesh: TransformNode) => void): Nullable<Promise<TransformNode>>;
  83193. /**
  83194. * Define this method to modify the default behavior when loading cameras.
  83195. * @param context The context when loading the asset
  83196. * @param camera The glTF camera property
  83197. * @param assign A function called synchronously after parsing the glTF properties
  83198. * @returns A promise that resolves with the loaded Babylon camera when the load is complete or null if not handled
  83199. */
  83200. loadCameraAsync?(context: string, camera: ICamera, assign: (babylonCamera: Camera) => void): Nullable<Promise<Camera>>;
  83201. /**
  83202. * @hidden
  83203. * Define this method to modify the default behavior when loading vertex data for mesh primitives.
  83204. * @param context The context when loading the asset
  83205. * @param primitive The glTF mesh primitive property
  83206. * @returns A promise that resolves with the loaded geometry when the load is complete or null if not handled
  83207. */
  83208. _loadVertexDataAsync?(context: string, primitive: IMeshPrimitive, babylonMesh: Mesh): Nullable<Promise<Geometry>>;
  83209. /**
  83210. * @hidden
  83211. * Define this method to modify the default behavior when loading data for mesh primitives.
  83212. * @param context The context when loading the asset
  83213. * @param name The mesh name when loading the asset
  83214. * @param node The glTF node when loading the asset
  83215. * @param mesh The glTF mesh when loading the asset
  83216. * @param primitive The glTF mesh primitive property
  83217. * @param assign A function called synchronously after parsing the glTF properties
  83218. * @returns A promise that resolves with the loaded mesh when the load is complete or null if not handled
  83219. */
  83220. _loadMeshPrimitiveAsync?(context: string, name: string, node: INode, mesh: IMesh, primitive: IMeshPrimitive, assign: (babylonMesh: AbstractMesh) => void): Nullable<Promise<AbstractMesh>>;
  83221. /**
  83222. * @hidden
  83223. * Define this method to modify the default behavior when loading materials. Load material creates the material and then loads material properties.
  83224. * @param context The context when loading the asset
  83225. * @param material The glTF material property
  83226. * @param assign A function called synchronously after parsing the glTF properties
  83227. * @returns A promise that resolves with the loaded Babylon material when the load is complete or null if not handled
  83228. */
  83229. _loadMaterialAsync?(context: string, material: IMaterial, babylonMesh: Nullable<Mesh>, babylonDrawMode: number, assign: (babylonMaterial: Material) => void): Nullable<Promise<Material>>;
  83230. /**
  83231. * Define this method to modify the default behavior when creating materials.
  83232. * @param context The context when loading the asset
  83233. * @param material The glTF material property
  83234. * @param babylonDrawMode The draw mode for the Babylon material
  83235. * @returns The Babylon material or null if not handled
  83236. */
  83237. createMaterial?(context: string, material: IMaterial, babylonDrawMode: number): Nullable<Material>;
  83238. /**
  83239. * Define this method to modify the default behavior when loading material properties.
  83240. * @param context The context when loading the asset
  83241. * @param material The glTF material property
  83242. * @param babylonMaterial The Babylon material
  83243. * @returns A promise that resolves when the load is complete or null if not handled
  83244. */
  83245. loadMaterialPropertiesAsync?(context: string, material: IMaterial, babylonMaterial: Material): Nullable<Promise<void>>;
  83246. /**
  83247. * Define this method to modify the default behavior when loading texture infos.
  83248. * @param context The context when loading the asset
  83249. * @param textureInfo The glTF texture info property
  83250. * @param assign A function called synchronously after parsing the glTF properties
  83251. * @returns A promise that resolves with the loaded Babylon texture when the load is complete or null if not handled
  83252. */
  83253. loadTextureInfoAsync?(context: string, textureInfo: ITextureInfo, assign: (babylonTexture: BaseTexture) => void): Nullable<Promise<BaseTexture>>;
  83254. /**
  83255. * @hidden
  83256. * Define this method to modify the default behavior when loading textures.
  83257. * @param context The context when loading the asset
  83258. * @param texture The glTF texture property
  83259. * @param assign A function called synchronously after parsing the glTF properties
  83260. * @returns A promise that resolves with the loaded Babylon texture when the load is complete or null if not handled
  83261. */
  83262. _loadTextureAsync?(context: string, texture: ITexture, assign: (babylonTexture: BaseTexture) => void): Nullable<Promise<BaseTexture>>;
  83263. /**
  83264. * Define this method to modify the default behavior when loading animations.
  83265. * @param context The context when loading the asset
  83266. * @param animation The glTF animation property
  83267. * @returns A promise that resolves with the loaded Babylon animation group when the load is complete or null if not handled
  83268. */
  83269. loadAnimationAsync?(context: string, animation: IAnimation): Nullable<Promise<AnimationGroup>>;
  83270. /**
  83271. * @hidden
  83272. * Define this method to modify the default behavior when loading skins.
  83273. * @param context The context when loading the asset
  83274. * @param node The glTF node property
  83275. * @param skin The glTF skin property
  83276. * @returns A promise that resolves when the load is complete or null if not handled
  83277. */
  83278. _loadSkinAsync?(context: string, node: INode, skin: ISkin): Nullable<Promise<void>>;
  83279. /**
  83280. * @hidden
  83281. * Define this method to modify the default behavior when loading uris.
  83282. * @param context The context when loading the asset
  83283. * @param property The glTF property associated with the uri
  83284. * @param uri The uri to load
  83285. * @returns A promise that resolves with the loaded data when the load is complete or null if not handled
  83286. */
  83287. _loadUriAsync?(context: string, property: IProperty, uri: string): Nullable<Promise<ArrayBufferView>>;
  83288. /**
  83289. * Define this method to modify the default behavior when loading buffer views.
  83290. * @param context The context when loading the asset
  83291. * @param bufferView The glTF buffer view property
  83292. * @returns A promise that resolves with the loaded data when the load is complete or null if not handled
  83293. */
  83294. loadBufferViewAsync?(context: string, bufferView: IBufferView): Nullable<Promise<ArrayBufferView>>;
  83295. /**
  83296. * Define this method to modify the default behavior when loading buffers.
  83297. * @param context The context when loading the asset
  83298. * @param buffer The glTF buffer property
  83299. * @param byteOffset The byte offset to load
  83300. * @param byteLength The byte length to load
  83301. * @returns A promise that resolves with the loaded data when the load is complete or null if not handled
  83302. */
  83303. loadBufferAsync?(context: string, buffer: IBuffer, byteOffset: number, byteLength: number): Nullable<Promise<ArrayBufferView>>;
  83304. }
  83305. }
  83306. declare module BABYLON.GLTF2 {
  83307. /**
  83308. * Helper class for working with arrays when loading the glTF asset
  83309. */
  83310. export class ArrayItem {
  83311. /**
  83312. * Gets an item from the given array.
  83313. * @param context The context when loading the asset
  83314. * @param array The array to get the item from
  83315. * @param index The index to the array
  83316. * @returns The array item
  83317. */
  83318. static Get<T>(context: string, array: ArrayLike<T> | undefined, index: number | undefined): T;
  83319. /**
  83320. * Assign an `index` field to each item of the given array.
  83321. * @param array The array of items
  83322. */
  83323. static Assign(array?: BABYLON.GLTF2.Loader.IArrayItem[]): void;
  83324. }
  83325. /**
  83326. * The glTF 2.0 loader
  83327. */
  83328. export class GLTFLoader implements IGLTFLoader {
  83329. /** @hidden */
  83330. _completePromises: Promise<any>[];
  83331. /** @hidden */
  83332. _forAssetContainer: boolean;
  83333. /** Storage */
  83334. _babylonLights: Light[];
  83335. /** @hidden */
  83336. _disableInstancedMesh: number;
  83337. private _disposed;
  83338. private _parent;
  83339. private _state;
  83340. private _extensions;
  83341. private _rootUrl;
  83342. private _fileName;
  83343. private _uniqueRootUrl;
  83344. private _gltf;
  83345. private _bin;
  83346. private _babylonScene;
  83347. private _rootBabylonMesh;
  83348. private _defaultBabylonMaterialData;
  83349. private static _RegisteredExtensions;
  83350. /**
  83351. * The default glTF sampler.
  83352. */
  83353. static readonly DefaultSampler: ISampler;
  83354. /**
  83355. * Registers a loader extension.
  83356. * @param name The name of the loader extension.
  83357. * @param factory The factory function that creates the loader extension.
  83358. */
  83359. static RegisterExtension(name: string, factory: (loader: GLTFLoader) => IGLTFLoaderExtension): void;
  83360. /**
  83361. * Unregisters a loader extension.
  83362. * @param name The name of the loader extension.
  83363. * @returns A boolean indicating whether the extension has been unregistered
  83364. */
  83365. static UnregisterExtension(name: string): boolean;
  83366. /**
  83367. * The loader state.
  83368. */
  83369. get state(): Nullable<GLTFLoaderState>;
  83370. /**
  83371. * The object that represents the glTF JSON.
  83372. */
  83373. get gltf(): IGLTF;
  83374. /**
  83375. * The BIN chunk of a binary glTF.
  83376. */
  83377. get bin(): Nullable<IDataBuffer>;
  83378. /**
  83379. * The parent file loader.
  83380. */
  83381. get parent(): GLTFFileLoader;
  83382. /**
  83383. * The Babylon scene when loading the asset.
  83384. */
  83385. get babylonScene(): Scene;
  83386. /**
  83387. * The root Babylon mesh when loading the asset.
  83388. */
  83389. get rootBabylonMesh(): Mesh;
  83390. /** @hidden */
  83391. constructor(parent: GLTFFileLoader);
  83392. /** @hidden */
  83393. dispose(): void;
  83394. /** @hidden */
  83395. importMeshAsync(meshesNames: any, scene: Scene, forAssetContainer: boolean, data: IGLTFLoaderData, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<IImportMeshAsyncOutput>;
  83396. /** @hidden */
  83397. loadAsync(scene: Scene, data: IGLTFLoaderData, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  83398. private _loadAsync;
  83399. private _loadData;
  83400. private _setupData;
  83401. private _loadExtensions;
  83402. private _checkExtensions;
  83403. private _setState;
  83404. private _createRootNode;
  83405. /**
  83406. * Loads a glTF scene.
  83407. * @param context The context when loading the asset
  83408. * @param scene The glTF scene property
  83409. * @returns A promise that resolves when the load is complete
  83410. */
  83411. loadSceneAsync(context: string, scene: IScene): Promise<void>;
  83412. private _forEachPrimitive;
  83413. private _getGeometries;
  83414. private _getMeshes;
  83415. private _getTransformNodes;
  83416. private _getSkeletons;
  83417. private _getAnimationGroups;
  83418. private _startAnimations;
  83419. /**
  83420. * Loads a glTF node.
  83421. * @param context The context when loading the asset
  83422. * @param node The glTF node property
  83423. * @param assign A function called synchronously after parsing the glTF properties
  83424. * @returns A promise that resolves with the loaded Babylon mesh when the load is complete
  83425. */
  83426. loadNodeAsync(context: string, node: INode, assign?: (babylonTransformNode: TransformNode) => void): Promise<TransformNode>;
  83427. private _loadMeshAsync;
  83428. /**
  83429. * @hidden Define this method to modify the default behavior when loading data for mesh primitives.
  83430. * @param context The context when loading the asset
  83431. * @param name The mesh name when loading the asset
  83432. * @param node The glTF node when loading the asset
  83433. * @param mesh The glTF mesh when loading the asset
  83434. * @param primitive The glTF mesh primitive property
  83435. * @param assign A function called synchronously after parsing the glTF properties
  83436. * @returns A promise that resolves with the loaded mesh when the load is complete or null if not handled
  83437. */
  83438. _loadMeshPrimitiveAsync(context: string, name: string, node: INode, mesh: IMesh, primitive: IMeshPrimitive, assign: (babylonMesh: AbstractMesh) => void): Promise<AbstractMesh>;
  83439. private _loadVertexDataAsync;
  83440. private _createMorphTargets;
  83441. private _loadMorphTargetsAsync;
  83442. private _loadMorphTargetVertexDataAsync;
  83443. private static _LoadTransform;
  83444. private _loadSkinAsync;
  83445. private _loadBones;
  83446. private _loadBone;
  83447. private _loadSkinInverseBindMatricesDataAsync;
  83448. private _updateBoneMatrices;
  83449. private _getNodeMatrix;
  83450. /**
  83451. * Loads a glTF camera.
  83452. * @param context The context when loading the asset
  83453. * @param camera The glTF camera property
  83454. * @param assign A function called synchronously after parsing the glTF properties
  83455. * @returns A promise that resolves with the loaded Babylon camera when the load is complete
  83456. */
  83457. loadCameraAsync(context: string, camera: ICamera, assign?: (babylonCamera: Camera) => void): Promise<Camera>;
  83458. private _loadAnimationsAsync;
  83459. /**
  83460. * Loads a glTF animation.
  83461. * @param context The context when loading the asset
  83462. * @param animation The glTF animation property
  83463. * @returns A promise that resolves with the loaded Babylon animation group when the load is complete
  83464. */
  83465. loadAnimationAsync(context: string, animation: IAnimation): Promise<AnimationGroup>;
  83466. /**
  83467. * @hidden Loads a glTF animation channel.
  83468. * @param context The context when loading the asset
  83469. * @param animationContext The context of the animation when loading the asset
  83470. * @param animation The glTF animation property
  83471. * @param channel The glTF animation channel property
  83472. * @param babylonAnimationGroup The babylon animation group property
  83473. * @param animationTargetOverride The babylon animation channel target override property. My be null.
  83474. * @returns A void promise when the channel load is complete
  83475. */
  83476. _loadAnimationChannelAsync(context: string, animationContext: string, animation: IAnimation, channel: IAnimationChannel, babylonAnimationGroup: AnimationGroup, animationTargetOverride?: Nullable<IAnimatable>): Promise<void>;
  83477. private _loadAnimationSamplerAsync;
  83478. private _loadBufferAsync;
  83479. /**
  83480. * Loads a glTF buffer view.
  83481. * @param context The context when loading the asset
  83482. * @param bufferView The glTF buffer view property
  83483. * @returns A promise that resolves with the loaded data when the load is complete
  83484. */
  83485. loadBufferViewAsync(context: string, bufferView: IBufferView): Promise<ArrayBufferView>;
  83486. private _loadAccessorAsync;
  83487. /** @hidden */
  83488. _loadFloatAccessorAsync(context: string, accessor: IAccessor): Promise<Float32Array>;
  83489. private _loadIndicesAccessorAsync;
  83490. private _loadVertexBufferViewAsync;
  83491. private _loadVertexAccessorAsync;
  83492. private _loadMaterialMetallicRoughnessPropertiesAsync;
  83493. /** @hidden */
  83494. _loadMaterialAsync(context: string, material: IMaterial, babylonMesh: Nullable<Mesh>, babylonDrawMode: number, assign?: (babylonMaterial: Material) => void): Promise<Material>;
  83495. private _createDefaultMaterial;
  83496. /**
  83497. * Creates a Babylon material from a glTF material.
  83498. * @param context The context when loading the asset
  83499. * @param material The glTF material property
  83500. * @param babylonDrawMode The draw mode for the Babylon material
  83501. * @returns The Babylon material
  83502. */
  83503. createMaterial(context: string, material: IMaterial, babylonDrawMode: number): Material;
  83504. /**
  83505. * Loads properties from a glTF material into a Babylon material.
  83506. * @param context The context when loading the asset
  83507. * @param material The glTF material property
  83508. * @param babylonMaterial The Babylon material
  83509. * @returns A promise that resolves when the load is complete
  83510. */
  83511. loadMaterialPropertiesAsync(context: string, material: IMaterial, babylonMaterial: Material): Promise<void>;
  83512. /**
  83513. * Loads the normal, occlusion, and emissive properties from a glTF material into a Babylon material.
  83514. * @param context The context when loading the asset
  83515. * @param material The glTF material property
  83516. * @param babylonMaterial The Babylon material
  83517. * @returns A promise that resolves when the load is complete
  83518. */
  83519. loadMaterialBasePropertiesAsync(context: string, material: IMaterial, babylonMaterial: Material): Promise<void>;
  83520. /**
  83521. * Loads the alpha properties from a glTF material into a Babylon material.
  83522. * Must be called after the setting the albedo texture of the Babylon material when the material has an albedo texture.
  83523. * @param context The context when loading the asset
  83524. * @param material The glTF material property
  83525. * @param babylonMaterial The Babylon material
  83526. */
  83527. loadMaterialAlphaProperties(context: string, material: IMaterial, babylonMaterial: Material): void;
  83528. /**
  83529. * Loads a glTF texture info.
  83530. * @param context The context when loading the asset
  83531. * @param textureInfo The glTF texture info property
  83532. * @param assign A function called synchronously after parsing the glTF properties
  83533. * @returns A promise that resolves with the loaded Babylon texture when the load is complete
  83534. */
  83535. loadTextureInfoAsync(context: string, textureInfo: ITextureInfo, assign?: (babylonTexture: BaseTexture) => void): Promise<BaseTexture>;
  83536. /** @hidden */
  83537. _loadTextureAsync(context: string, texture: ITexture, assign?: (babylonTexture: BaseTexture) => void): Promise<BaseTexture>;
  83538. /** @hidden */
  83539. _createTextureAsync(context: string, sampler: ISampler, image: IImage, assign?: (babylonTexture: BaseTexture) => void, textureLoaderOptions?: any): Promise<BaseTexture>;
  83540. private _loadSampler;
  83541. /**
  83542. * Loads a glTF image.
  83543. * @param context The context when loading the asset
  83544. * @param image The glTF image property
  83545. * @returns A promise that resolves with the loaded data when the load is complete
  83546. */
  83547. loadImageAsync(context: string, image: IImage): Promise<ArrayBufferView>;
  83548. /**
  83549. * Loads a glTF uri.
  83550. * @param context The context when loading the asset
  83551. * @param property The glTF property associated with the uri
  83552. * @param uri The base64 or relative uri
  83553. * @returns A promise that resolves with the loaded data when the load is complete
  83554. */
  83555. loadUriAsync(context: string, property: IProperty, uri: string): Promise<ArrayBufferView>;
  83556. /**
  83557. * Adds a JSON pointer to the metadata of the Babylon object at `<object>.metadata.gltf.pointers`.
  83558. * @param babylonObject the Babylon object with metadata
  83559. * @param pointer the JSON pointer
  83560. */
  83561. static AddPointerMetadata(babylonObject: {
  83562. metadata: any;
  83563. }, pointer: string): void;
  83564. private static _GetTextureWrapMode;
  83565. private static _GetTextureSamplingMode;
  83566. private static _GetTypedArrayConstructor;
  83567. private static _GetTypedArray;
  83568. private static _GetNumComponents;
  83569. private static _ValidateUri;
  83570. /** @hidden */
  83571. static _GetDrawMode(context: string, mode: number | undefined): number;
  83572. private _compileMaterialsAsync;
  83573. private _compileShadowGeneratorsAsync;
  83574. private _forEachExtensions;
  83575. private _applyExtensions;
  83576. private _extensionsOnLoading;
  83577. private _extensionsOnReady;
  83578. private _extensionsLoadSceneAsync;
  83579. private _extensionsLoadNodeAsync;
  83580. private _extensionsLoadCameraAsync;
  83581. private _extensionsLoadVertexDataAsync;
  83582. private _extensionsLoadMeshPrimitiveAsync;
  83583. private _extensionsLoadMaterialAsync;
  83584. private _extensionsCreateMaterial;
  83585. private _extensionsLoadMaterialPropertiesAsync;
  83586. private _extensionsLoadTextureInfoAsync;
  83587. private _extensionsLoadTextureAsync;
  83588. private _extensionsLoadAnimationAsync;
  83589. private _extensionsLoadSkinAsync;
  83590. private _extensionsLoadUriAsync;
  83591. private _extensionsLoadBufferViewAsync;
  83592. private _extensionsLoadBufferAsync;
  83593. /**
  83594. * Helper method called by a loader extension to load an glTF extension.
  83595. * @param context The context when loading the asset
  83596. * @param property The glTF property to load the extension from
  83597. * @param extensionName The name of the extension to load
  83598. * @param actionAsync The action to run
  83599. * @returns The promise returned by actionAsync or null if the extension does not exist
  83600. */
  83601. static LoadExtensionAsync<TExtension = any, TResult = void>(context: string, property: IProperty, extensionName: string, actionAsync: (extensionContext: string, extension: TExtension) => Nullable<Promise<TResult>>): Nullable<Promise<TResult>>;
  83602. /**
  83603. * Helper method called by a loader extension to load a glTF extra.
  83604. * @param context The context when loading the asset
  83605. * @param property The glTF property to load the extra from
  83606. * @param extensionName The name of the extension to load
  83607. * @param actionAsync The action to run
  83608. * @returns The promise returned by actionAsync or null if the extra does not exist
  83609. */
  83610. static LoadExtraAsync<TExtra = any, TResult = void>(context: string, property: IProperty, extensionName: string, actionAsync: (extraContext: string, extra: TExtra) => Nullable<Promise<TResult>>): Nullable<Promise<TResult>>;
  83611. /**
  83612. * Checks for presence of an extension.
  83613. * @param name The name of the extension to check
  83614. * @returns A boolean indicating the presence of the given extension name in `extensionsUsed`
  83615. */
  83616. isExtensionUsed(name: string): boolean;
  83617. /**
  83618. * Increments the indentation level and logs a message.
  83619. * @param message The message to log
  83620. */
  83621. logOpen(message: string): void;
  83622. /**
  83623. * Decrements the indentation level.
  83624. */
  83625. logClose(): void;
  83626. /**
  83627. * Logs a message
  83628. * @param message The message to log
  83629. */
  83630. log(message: string): void;
  83631. /**
  83632. * Starts a performance counter.
  83633. * @param counterName The name of the performance counter
  83634. */
  83635. startPerformanceCounter(counterName: string): void;
  83636. /**
  83637. * Ends a performance counter.
  83638. * @param counterName The name of the performance counter
  83639. */
  83640. endPerformanceCounter(counterName: string): void;
  83641. }
  83642. }
  83643. declare module BABYLON.GLTF2.Loader.Extensions {
  83644. /** @hidden */
  83645. interface IEXTLightsImageBased_LightImageBased {
  83646. _babylonTexture?: BaseTexture;
  83647. _loaded?: Promise<void>;
  83648. }
  83649. /**
  83650. * [Specification](https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Vendor/EXT_lights_image_based/README.md)
  83651. */
  83652. export class EXT_lights_image_based implements IGLTFLoaderExtension {
  83653. /**
  83654. * The name of this extension.
  83655. */
  83656. readonly name: string;
  83657. /**
  83658. * Defines whether this extension is enabled.
  83659. */
  83660. enabled: boolean;
  83661. private _loader;
  83662. private _lights?;
  83663. /** @hidden */
  83664. constructor(loader: GLTFLoader);
  83665. /** @hidden */
  83666. dispose(): void;
  83667. /** @hidden */
  83668. onLoading(): void;
  83669. /** @hidden */
  83670. loadSceneAsync(context: string, scene: IScene): Nullable<Promise<void>>;
  83671. private _loadLightAsync;
  83672. }
  83673. }
  83674. declare module BABYLON.GLTF2.Loader.Extensions {
  83675. /**
  83676. * [Proposed Specification](https://github.com/KhronosGroup/glTF/pull/1691)
  83677. * [Playground Sample](https://playground.babylonjs.com/#QFIGLW#9)
  83678. * !!! Experimental Extension Subject to Changes !!!
  83679. */
  83680. export class EXT_mesh_gpu_instancing implements IGLTFLoaderExtension {
  83681. /**
  83682. * The name of this extension.
  83683. */
  83684. readonly name: string;
  83685. /**
  83686. * Defines whether this extension is enabled.
  83687. */
  83688. enabled: boolean;
  83689. private _loader;
  83690. /** @hidden */
  83691. constructor(loader: GLTFLoader);
  83692. /** @hidden */
  83693. dispose(): void;
  83694. /** @hidden */
  83695. loadNodeAsync(context: string, node: INode, assign: (babylonTransformNode: TransformNode) => void): Nullable<Promise<TransformNode>>;
  83696. }
  83697. }
  83698. declare module BABYLON.GLTF2.Loader.Extensions {
  83699. /**
  83700. * [Specification](https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Vendor/EXT_texture_webp/)
  83701. */
  83702. export class EXT_texture_webp implements IGLTFLoaderExtension {
  83703. /** The name of this extension. */
  83704. readonly name: string;
  83705. /** Defines whether this extension is enabled. */
  83706. enabled: boolean;
  83707. private _loader;
  83708. /** @hidden */
  83709. constructor(loader: GLTFLoader);
  83710. /** @hidden */
  83711. dispose(): void;
  83712. /** @hidden */
  83713. _loadTextureAsync(context: string, texture: ITexture, assign: (babylonTexture: BaseTexture) => void): Nullable<Promise<BaseTexture>>;
  83714. }
  83715. }
  83716. declare module BABYLON.GLTF2.Loader.Extensions {
  83717. /**
  83718. * [Specification](https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_draco_mesh_compression)
  83719. */
  83720. export class KHR_draco_mesh_compression implements IGLTFLoaderExtension {
  83721. /**
  83722. * The name of this extension.
  83723. */
  83724. readonly name: string;
  83725. /**
  83726. * The draco compression used to decode vertex data or DracoCompression.Default if not defined
  83727. */
  83728. dracoCompression?: DracoCompression;
  83729. /**
  83730. * Defines whether this extension is enabled.
  83731. */
  83732. enabled: boolean;
  83733. private _loader;
  83734. /** @hidden */
  83735. constructor(loader: GLTFLoader);
  83736. /** @hidden */
  83737. dispose(): void;
  83738. /** @hidden */
  83739. _loadVertexDataAsync(context: string, primitive: IMeshPrimitive, babylonMesh: Mesh): Nullable<Promise<Geometry>>;
  83740. }
  83741. }
  83742. declare module BABYLON.GLTF2.Loader.Extensions {
  83743. /**
  83744. * [Specification](https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_lights_punctual)
  83745. */
  83746. export class KHR_lights implements IGLTFLoaderExtension {
  83747. /**
  83748. * The name of this extension.
  83749. */
  83750. readonly name: string;
  83751. /**
  83752. * Defines whether this extension is enabled.
  83753. */
  83754. enabled: boolean;
  83755. private _loader;
  83756. private _lights?;
  83757. /** @hidden */
  83758. constructor(loader: GLTFLoader);
  83759. /** @hidden */
  83760. dispose(): void;
  83761. /** @hidden */
  83762. onLoading(): void;
  83763. /** @hidden */
  83764. loadNodeAsync(context: string, node: INode, assign: (babylonTransformNode: TransformNode) => void): Nullable<Promise<TransformNode>>;
  83765. }
  83766. }
  83767. declare module BABYLON.GLTF2.Loader.Extensions {
  83768. /**
  83769. * [Specification](https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_pbrSpecularGlossiness)
  83770. */
  83771. export class KHR_materials_pbrSpecularGlossiness implements IGLTFLoaderExtension {
  83772. /**
  83773. * The name of this extension.
  83774. */
  83775. readonly name: string;
  83776. /**
  83777. * Defines whether this extension is enabled.
  83778. */
  83779. enabled: boolean;
  83780. /**
  83781. * Defines a number that determines the order the extensions are applied.
  83782. */
  83783. order: number;
  83784. private _loader;
  83785. /** @hidden */
  83786. constructor(loader: GLTFLoader);
  83787. /** @hidden */
  83788. dispose(): void;
  83789. /** @hidden */
  83790. loadMaterialPropertiesAsync(context: string, material: IMaterial, babylonMaterial: Material): Nullable<Promise<void>>;
  83791. private _loadSpecularGlossinessPropertiesAsync;
  83792. }
  83793. }
  83794. declare module BABYLON.GLTF2.Loader.Extensions {
  83795. /**
  83796. * [Specification](https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_materials_unlit)
  83797. */
  83798. export class KHR_materials_unlit implements IGLTFLoaderExtension {
  83799. /**
  83800. * The name of this extension.
  83801. */
  83802. readonly name: string;
  83803. /**
  83804. * Defines whether this extension is enabled.
  83805. */
  83806. enabled: boolean;
  83807. /**
  83808. * Defines a number that determines the order the extensions are applied.
  83809. */
  83810. order: number;
  83811. private _loader;
  83812. /** @hidden */
  83813. constructor(loader: GLTFLoader);
  83814. /** @hidden */
  83815. dispose(): void;
  83816. /** @hidden */
  83817. loadMaterialPropertiesAsync(context: string, material: IMaterial, babylonMaterial: Material): Nullable<Promise<void>>;
  83818. private _loadUnlitPropertiesAsync;
  83819. }
  83820. }
  83821. declare module BABYLON.GLTF2.Loader.Extensions {
  83822. /**
  83823. * [Specification](https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_materials_clearcoat/README.md)
  83824. * [Playground Sample](https://www.babylonjs-playground.com/frame.html#7F7PN6#8)
  83825. */
  83826. export class KHR_materials_clearcoat implements IGLTFLoaderExtension {
  83827. /**
  83828. * The name of this extension.
  83829. */
  83830. readonly name: string;
  83831. /**
  83832. * Defines whether this extension is enabled.
  83833. */
  83834. enabled: boolean;
  83835. /**
  83836. * Defines a number that determines the order the extensions are applied.
  83837. */
  83838. order: number;
  83839. private _loader;
  83840. /** @hidden */
  83841. constructor(loader: GLTFLoader);
  83842. /** @hidden */
  83843. dispose(): void;
  83844. /** @hidden */
  83845. loadMaterialPropertiesAsync(context: string, material: IMaterial, babylonMaterial: Material): Nullable<Promise<void>>;
  83846. private _loadClearCoatPropertiesAsync;
  83847. }
  83848. }
  83849. declare module BABYLON.GLTF2.Loader.Extensions {
  83850. /**
  83851. * [Proposed Specification](https://github.com/KhronosGroup/glTF/pull/1688)
  83852. * [Playground Sample](https://www.babylonjs-playground.com/frame.html#BNIZX6#4)
  83853. * !!! Experimental Extension Subject to Changes !!!
  83854. */
  83855. export class KHR_materials_sheen implements IGLTFLoaderExtension {
  83856. /**
  83857. * The name of this extension.
  83858. */
  83859. readonly name: string;
  83860. /**
  83861. * Defines whether this extension is enabled.
  83862. */
  83863. enabled: boolean;
  83864. /**
  83865. * Defines a number that determines the order the extensions are applied.
  83866. */
  83867. order: number;
  83868. private _loader;
  83869. /** @hidden */
  83870. constructor(loader: GLTFLoader);
  83871. /** @hidden */
  83872. dispose(): void;
  83873. /** @hidden */
  83874. loadMaterialPropertiesAsync(context: string, material: IMaterial, babylonMaterial: Material): Nullable<Promise<void>>;
  83875. private _loadSheenPropertiesAsync;
  83876. }
  83877. }
  83878. declare module BABYLON.GLTF2.Loader.Extensions {
  83879. /**
  83880. * [Proposed Specification](https://github.com/KhronosGroup/glTF/pull/1719)
  83881. * !!! Experimental Extension Subject to Changes !!!
  83882. */
  83883. export class KHR_materials_specular implements IGLTFLoaderExtension {
  83884. /**
  83885. * The name of this extension.
  83886. */
  83887. readonly name: string;
  83888. /**
  83889. * Defines whether this extension is enabled.
  83890. */
  83891. enabled: boolean;
  83892. /**
  83893. * Defines a number that determines the order the extensions are applied.
  83894. */
  83895. order: number;
  83896. private _loader;
  83897. /** @hidden */
  83898. constructor(loader: GLTFLoader);
  83899. /** @hidden */
  83900. dispose(): void;
  83901. /** @hidden */
  83902. loadMaterialPropertiesAsync(context: string, material: IMaterial, babylonMaterial: Material): Nullable<Promise<void>>;
  83903. private _loadSpecularPropertiesAsync;
  83904. }
  83905. }
  83906. declare module BABYLON.GLTF2.Loader.Extensions {
  83907. /**
  83908. * [Proposed Specification](https://github.com/KhronosGroup/glTF/pull/1718)
  83909. * !!! Experimental Extension Subject to Changes !!!
  83910. */
  83911. export class KHR_materials_ior implements IGLTFLoaderExtension {
  83912. /**
  83913. * Default ior Value from the spec.
  83914. */
  83915. private static readonly _DEFAULT_IOR;
  83916. /**
  83917. * The name of this extension.
  83918. */
  83919. readonly name: string;
  83920. /**
  83921. * Defines whether this extension is enabled.
  83922. */
  83923. enabled: boolean;
  83924. /**
  83925. * Defines a number that determines the order the extensions are applied.
  83926. */
  83927. order: number;
  83928. private _loader;
  83929. /** @hidden */
  83930. constructor(loader: GLTFLoader);
  83931. /** @hidden */
  83932. dispose(): void;
  83933. /** @hidden */
  83934. loadMaterialPropertiesAsync(context: string, material: IMaterial, babylonMaterial: Material): Nullable<Promise<void>>;
  83935. private _loadIorPropertiesAsync;
  83936. }
  83937. }
  83938. declare module BABYLON.GLTF2.Loader.Extensions {
  83939. /**
  83940. * [Proposed Specification](https://github.com/KhronosGroup/glTF/pull/1681)
  83941. * !!! Experimental Extension Subject to Changes !!!
  83942. */
  83943. export class KHR_materials_variants implements IGLTFLoaderExtension {
  83944. /**
  83945. * The name of this extension.
  83946. */
  83947. readonly name: string;
  83948. /**
  83949. * Defines whether this extension is enabled.
  83950. */
  83951. enabled: boolean;
  83952. private _loader;
  83953. private _variants?;
  83954. /** @hidden */
  83955. constructor(loader: GLTFLoader);
  83956. /** @hidden */
  83957. dispose(): void;
  83958. /**
  83959. * Gets the list of available variant names for this asset.
  83960. * @param rootMesh The glTF root mesh
  83961. * @returns the list of all the variant names for this model
  83962. */
  83963. static GetAvailableVariants(rootMesh: Mesh): string[];
  83964. /**
  83965. * Gets the list of available variant names for this asset.
  83966. * @param rootMesh The glTF root mesh
  83967. * @returns the list of all the variant names for this model
  83968. */
  83969. getAvailableVariants(rootMesh: Mesh): string[];
  83970. /**
  83971. * Select a variant given a variant name or a list of variant names.
  83972. * @param rootMesh The glTF root mesh
  83973. * @param variantName The variant name(s) to select.
  83974. */
  83975. static SelectVariant(rootMesh: Mesh, variantName: string | string[]): void;
  83976. /**
  83977. * Select a variant given a variant name or a list of variant names.
  83978. * @param rootMesh The glTF root mesh
  83979. * @param variantName The variant name(s) to select.
  83980. */
  83981. selectVariant(rootMesh: Mesh, variantName: string | string[]): void;
  83982. /**
  83983. * Reset back to the original before selecting a variant.
  83984. * @param rootMesh The glTF root mesh
  83985. */
  83986. static Reset(rootMesh: Mesh): void;
  83987. /**
  83988. * Reset back to the original before selecting a variant.
  83989. * @param rootMesh The glTF root mesh
  83990. */
  83991. reset(rootMesh: Mesh): void;
  83992. /**
  83993. * Gets the last selected variant name(s) or null if original.
  83994. * @param rootMesh The glTF root mesh
  83995. * @returns The selected variant name(s).
  83996. */
  83997. static GetLastSelectedVariant(rootMesh: Mesh): Nullable<string | string[]>;
  83998. /**
  83999. * Gets the last selected variant name(s) or null if original.
  84000. * @param rootMesh The glTF root mesh
  84001. * @returns The selected variant name(s).
  84002. */
  84003. getLastSelectedVariant(rootMesh: Mesh): Nullable<string | string[]>;
  84004. private static _GetExtensionMetadata;
  84005. /** @hidden */
  84006. onLoading(): void;
  84007. /** @hidden */
  84008. _loadMeshPrimitiveAsync(context: string, name: string, node: INode, mesh: IMesh, primitive: IMeshPrimitive, assign: (babylonMesh: AbstractMesh) => void): Nullable<Promise<AbstractMesh>>;
  84009. }
  84010. }
  84011. declare module BABYLON.GLTF2.Loader.Extensions {
  84012. /**
  84013. * [Proposed Specification](https://github.com/KhronosGroup/glTF/pull/1698)
  84014. * !!! Experimental Extension Subject to Changes !!!
  84015. */
  84016. export class KHR_materials_transmission implements IGLTFLoaderExtension {
  84017. /**
  84018. * The name of this extension.
  84019. */
  84020. readonly name: string;
  84021. /**
  84022. * Defines whether this extension is enabled.
  84023. */
  84024. enabled: boolean;
  84025. /**
  84026. * Defines a number that determines the order the extensions are applied.
  84027. */
  84028. order: number;
  84029. private _loader;
  84030. /** @hidden */
  84031. constructor(loader: GLTFLoader);
  84032. /** @hidden */
  84033. dispose(): void;
  84034. /** @hidden */
  84035. loadMaterialPropertiesAsync(context: string, material: IMaterial, babylonMaterial: Material): Nullable<Promise<void>>;
  84036. private _loadTransparentPropertiesAsync;
  84037. }
  84038. }
  84039. declare module BABYLON.GLTF2.Loader.Extensions {
  84040. /**
  84041. * [Proposed Specification](https://github.com/KhronosGroup/glTF/pull/1825)
  84042. * !!! Experimental Extension Subject to Changes !!!
  84043. */
  84044. export class KHR_materials_translucency implements IGLTFLoaderExtension {
  84045. /**
  84046. * The name of this extension.
  84047. */
  84048. readonly name: string;
  84049. /**
  84050. * Defines whether this extension is enabled.
  84051. */
  84052. enabled: boolean;
  84053. /**
  84054. * Defines a number that determines the order the extensions are applied.
  84055. */
  84056. order: number;
  84057. private _loader;
  84058. /** @hidden */
  84059. constructor(loader: GLTFLoader);
  84060. /** @hidden */
  84061. dispose(): void;
  84062. /** @hidden */
  84063. loadMaterialPropertiesAsync(context: string, material: IMaterial, babylonMaterial: Material): Nullable<Promise<void>>;
  84064. private _loadTranslucentPropertiesAsync;
  84065. }
  84066. }
  84067. declare module BABYLON.GLTF2.Loader.Extensions {
  84068. /**
  84069. * [Specification](https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_mesh_quantization)
  84070. */
  84071. export class KHR_mesh_quantization implements IGLTFLoaderExtension {
  84072. /**
  84073. * The name of this extension.
  84074. */
  84075. readonly name: string;
  84076. /**
  84077. * Defines whether this extension is enabled.
  84078. */
  84079. enabled: boolean;
  84080. /** @hidden */
  84081. constructor(loader: GLTFLoader);
  84082. /** @hidden */
  84083. dispose(): void;
  84084. }
  84085. }
  84086. declare module BABYLON.GLTF2.Loader.Extensions {
  84087. /**
  84088. * [Proposed Specification](https://github.com/KhronosGroup/glTF/pull/1751)
  84089. * !!! Experimental Extension Subject to Changes !!!
  84090. */
  84091. export class KHR_texture_basisu implements IGLTFLoaderExtension {
  84092. /** The name of this extension. */
  84093. readonly name: string;
  84094. /** Defines whether this extension is enabled. */
  84095. enabled: boolean;
  84096. private _loader;
  84097. /** @hidden */
  84098. constructor(loader: GLTFLoader);
  84099. /** @hidden */
  84100. dispose(): void;
  84101. /** @hidden */
  84102. _loadTextureAsync(context: string, texture: ITexture, assign: (babylonTexture: BaseTexture) => void): Nullable<Promise<BaseTexture>>;
  84103. }
  84104. }
  84105. declare module BABYLON.GLTF2.Loader.Extensions {
  84106. /**
  84107. * [Specification](https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_texture_transform)
  84108. */
  84109. export class KHR_texture_transform implements IGLTFLoaderExtension {
  84110. /**
  84111. * The name of this extension.
  84112. */
  84113. readonly name: string;
  84114. /**
  84115. * Defines whether this extension is enabled.
  84116. */
  84117. enabled: boolean;
  84118. private _loader;
  84119. /** @hidden */
  84120. constructor(loader: GLTFLoader);
  84121. /** @hidden */
  84122. dispose(): void;
  84123. /** @hidden */
  84124. loadTextureInfoAsync(context: string, textureInfo: ITextureInfo, assign: (babylonTexture: BaseTexture) => void): Nullable<Promise<BaseTexture>>;
  84125. }
  84126. }
  84127. declare module BABYLON.GLTF2.Loader.Extensions {
  84128. /**
  84129. * [Proposed Specification](https://github.com/KhronosGroup/glTF/pull/1553)
  84130. * !!! Experimental Extension Subject to Changes !!!
  84131. */
  84132. export class KHR_xmp implements IGLTFLoaderExtension {
  84133. /**
  84134. * The name of this extension.
  84135. */
  84136. readonly name: string;
  84137. /**
  84138. * Defines whether this extension is enabled.
  84139. */
  84140. enabled: boolean;
  84141. /**
  84142. * Defines a number that determines the order the extensions are applied.
  84143. */
  84144. order: number;
  84145. private _loader;
  84146. /** @hidden */
  84147. constructor(loader: GLTFLoader);
  84148. /** @hidden */
  84149. dispose(): void;
  84150. /**
  84151. * Called after the loader state changes to LOADING.
  84152. */
  84153. onLoading(): void;
  84154. }
  84155. }
  84156. declare module BABYLON.GLTF2.Loader.Extensions {
  84157. /**
  84158. * [Specification](https://github.com/najadojo/glTF/tree/MSFT_audio_emitter/extensions/2.0/Vendor/MSFT_audio_emitter)
  84159. */
  84160. export class MSFT_audio_emitter implements IGLTFLoaderExtension {
  84161. /**
  84162. * The name of this extension.
  84163. */
  84164. readonly name: string;
  84165. /**
  84166. * Defines whether this extension is enabled.
  84167. */
  84168. enabled: boolean;
  84169. private _loader;
  84170. private _clips;
  84171. private _emitters;
  84172. /** @hidden */
  84173. constructor(loader: GLTFLoader);
  84174. /** @hidden */
  84175. dispose(): void;
  84176. /** @hidden */
  84177. onLoading(): void;
  84178. /** @hidden */
  84179. loadSceneAsync(context: string, scene: IScene): Nullable<Promise<void>>;
  84180. /** @hidden */
  84181. loadNodeAsync(context: string, node: INode, assign: (babylonTransformNode: TransformNode) => void): Nullable<Promise<TransformNode>>;
  84182. /** @hidden */
  84183. loadAnimationAsync(context: string, animation: IAnimation): Nullable<Promise<AnimationGroup>>;
  84184. private _loadClipAsync;
  84185. private _loadEmitterAsync;
  84186. private _getEventAction;
  84187. private _loadAnimationEventAsync;
  84188. }
  84189. }
  84190. declare module BABYLON.GLTF2.Loader.Extensions {
  84191. /**
  84192. * [Specification](https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/MSFT_lod)
  84193. */
  84194. export class MSFT_lod implements IGLTFLoaderExtension {
  84195. /**
  84196. * The name of this extension.
  84197. */
  84198. readonly name: string;
  84199. /**
  84200. * Defines whether this extension is enabled.
  84201. */
  84202. enabled: boolean;
  84203. /**
  84204. * Defines a number that determines the order the extensions are applied.
  84205. */
  84206. order: number;
  84207. /**
  84208. * Maximum number of LODs to load, starting from the lowest LOD.
  84209. */
  84210. maxLODsToLoad: number;
  84211. /**
  84212. * Observable raised when all node LODs of one level are loaded.
  84213. * The event data is the index of the loaded LOD starting from zero.
  84214. * Dispose the loader to cancel the loading of the next level of LODs.
  84215. */
  84216. onNodeLODsLoadedObservable: Observable<number>;
  84217. /**
  84218. * Observable raised when all material LODs of one level are loaded.
  84219. * The event data is the index of the loaded LOD starting from zero.
  84220. * Dispose the loader to cancel the loading of the next level of LODs.
  84221. */
  84222. onMaterialLODsLoadedObservable: Observable<number>;
  84223. private _loader;
  84224. private _bufferLODs;
  84225. private _nodeIndexLOD;
  84226. private _nodeSignalLODs;
  84227. private _nodePromiseLODs;
  84228. private _nodeBufferLODs;
  84229. private _materialIndexLOD;
  84230. private _materialSignalLODs;
  84231. private _materialPromiseLODs;
  84232. private _materialBufferLODs;
  84233. /** @hidden */
  84234. constructor(loader: GLTFLoader);
  84235. /** @hidden */
  84236. dispose(): void;
  84237. /** @hidden */
  84238. onReady(): void;
  84239. /** @hidden */
  84240. loadSceneAsync(context: string, scene: IScene): Nullable<Promise<void>>;
  84241. /** @hidden */
  84242. loadNodeAsync(context: string, node: INode, assign: (babylonTransformNode: TransformNode) => void): Nullable<Promise<TransformNode>>;
  84243. /** @hidden */
  84244. _loadMaterialAsync(context: string, material: IMaterial, babylonMesh: Nullable<Mesh>, babylonDrawMode: number, assign: (babylonMaterial: Material) => void): Nullable<Promise<Material>>;
  84245. /** @hidden */
  84246. _loadUriAsync(context: string, property: IProperty, uri: string): Nullable<Promise<ArrayBufferView>>;
  84247. /** @hidden */
  84248. loadBufferAsync(context: string, buffer: IBuffer, byteOffset: number, byteLength: number): Nullable<Promise<ArrayBufferView>>;
  84249. private _loadBufferLOD;
  84250. /**
  84251. * Gets an array of LOD properties from lowest to highest.
  84252. */
  84253. private _getLODs;
  84254. private _disposeTransformNode;
  84255. private _disposeMaterials;
  84256. }
  84257. }
  84258. declare module BABYLON.GLTF2.Loader.Extensions {
  84259. /** @hidden */
  84260. export class MSFT_minecraftMesh implements IGLTFLoaderExtension {
  84261. readonly name: string;
  84262. enabled: boolean;
  84263. private _loader;
  84264. constructor(loader: GLTFLoader);
  84265. dispose(): void;
  84266. loadMaterialPropertiesAsync(context: string, material: IMaterial, babylonMaterial: Material): Nullable<Promise<void>>;
  84267. }
  84268. }
  84269. declare module BABYLON.GLTF2.Loader.Extensions {
  84270. /** @hidden */
  84271. export class MSFT_sRGBFactors implements IGLTFLoaderExtension {
  84272. readonly name: string;
  84273. enabled: boolean;
  84274. private _loader;
  84275. constructor(loader: GLTFLoader);
  84276. dispose(): void;
  84277. loadMaterialPropertiesAsync(context: string, material: IMaterial, babylonMaterial: Material): Nullable<Promise<void>>;
  84278. }
  84279. }
  84280. declare module BABYLON.GLTF2.Loader.Extensions {
  84281. /**
  84282. * Store glTF extras (if present) in BJS objects' metadata
  84283. */
  84284. export class ExtrasAsMetadata implements IGLTFLoaderExtension {
  84285. /**
  84286. * The name of this extension.
  84287. */
  84288. readonly name: string;
  84289. /**
  84290. * Defines whether this extension is enabled.
  84291. */
  84292. enabled: boolean;
  84293. private _loader;
  84294. private _assignExtras;
  84295. /** @hidden */
  84296. constructor(loader: GLTFLoader);
  84297. /** @hidden */
  84298. dispose(): void;
  84299. /** @hidden */
  84300. loadNodeAsync(context: string, node: INode, assign: (babylonTransformNode: TransformNode) => void): Nullable<Promise<TransformNode>>;
  84301. /** @hidden */
  84302. loadCameraAsync(context: string, camera: ICamera, assign: (babylonCamera: Camera) => void): Nullable<Promise<Camera>>;
  84303. /** @hidden */
  84304. createMaterial(context: string, material: IMaterial, babylonDrawMode: number): Nullable<Material>;
  84305. }
  84306. }
  84307. declare module BABYLON {
  84308. /**
  84309. * Class reading and parsing the MTL file bundled with the obj file.
  84310. */
  84311. export class MTLFileLoader {
  84312. /**
  84313. * Invert Y-Axis of referenced textures on load
  84314. */
  84315. static INVERT_TEXTURE_Y: boolean;
  84316. /**
  84317. * All material loaded from the mtl will be set here
  84318. */
  84319. materials: StandardMaterial[];
  84320. /**
  84321. * This function will read the mtl file and create each material described inside
  84322. * This function could be improve by adding :
  84323. * -some component missing (Ni, Tf...)
  84324. * -including the specific options available
  84325. *
  84326. * @param scene defines the scene the material will be created in
  84327. * @param data defines the mtl data to parse
  84328. * @param rootUrl defines the rooturl to use in order to load relative dependencies
  84329. * @param forAssetContainer defines if the material should be registered in the scene
  84330. */
  84331. parseMTL(scene: Scene, data: string | ArrayBuffer, rootUrl: string, forAssetContainer: boolean): void;
  84332. /**
  84333. * Gets the texture for the material.
  84334. *
  84335. * If the material is imported from input file,
  84336. * We sanitize the url to ensure it takes the textre from aside the material.
  84337. *
  84338. * @param rootUrl The root url to load from
  84339. * @param value The value stored in the mtl
  84340. * @return The Texture
  84341. */
  84342. private static _getTexture;
  84343. }
  84344. }
  84345. declare module BABYLON {
  84346. /**
  84347. * Options for loading OBJ/MTL files
  84348. */
  84349. type MeshLoadOptions = {
  84350. /**
  84351. * Defines if UVs are optimized by default during load.
  84352. */
  84353. OptimizeWithUV: boolean;
  84354. /**
  84355. * Defines custom scaling of UV coordinates of loaded meshes.
  84356. */
  84357. UVScaling: Vector2;
  84358. /**
  84359. * Invert model on y-axis (does a model scaling inversion)
  84360. */
  84361. InvertY: boolean;
  84362. /**
  84363. * Invert Y-Axis of referenced textures on load
  84364. */
  84365. InvertTextureY: boolean;
  84366. /**
  84367. * Include in meshes the vertex colors available in some OBJ files. This is not part of OBJ standard.
  84368. */
  84369. ImportVertexColors: boolean;
  84370. /**
  84371. * Compute the normals for the model, even if normals are present in the file.
  84372. */
  84373. ComputeNormals: boolean;
  84374. /**
  84375. * Skip loading the materials even if defined in the OBJ file (materials are ignored).
  84376. */
  84377. SkipMaterials: boolean;
  84378. /**
  84379. * When a material fails to load OBJ loader will silently fail and onSuccess() callback will be triggered.
  84380. */
  84381. MaterialLoadingFailsSilently: boolean;
  84382. };
  84383. /**
  84384. * OBJ file type loader.
  84385. * This is a babylon scene loader plugin.
  84386. */
  84387. export class OBJFileLoader implements ISceneLoaderPluginAsync, ISceneLoaderPluginFactory {
  84388. /**
  84389. * Defines if UVs are optimized by default during load.
  84390. */
  84391. static OPTIMIZE_WITH_UV: boolean;
  84392. /**
  84393. * Invert model on y-axis (does a model scaling inversion)
  84394. */
  84395. static INVERT_Y: boolean;
  84396. /**
  84397. * Invert Y-Axis of referenced textures on load
  84398. */
  84399. static get INVERT_TEXTURE_Y(): boolean;
  84400. static set INVERT_TEXTURE_Y(value: boolean);
  84401. /**
  84402. * Include in meshes the vertex colors available in some OBJ files. This is not part of OBJ standard.
  84403. */
  84404. static IMPORT_VERTEX_COLORS: boolean;
  84405. /**
  84406. * Compute the normals for the model, even if normals are present in the file.
  84407. */
  84408. static COMPUTE_NORMALS: boolean;
  84409. /**
  84410. * Defines custom scaling of UV coordinates of loaded meshes.
  84411. */
  84412. static UV_SCALING: Vector2;
  84413. /**
  84414. * Skip loading the materials even if defined in the OBJ file (materials are ignored).
  84415. */
  84416. static SKIP_MATERIALS: boolean;
  84417. /**
  84418. * When a material fails to load OBJ loader will silently fail and onSuccess() callback will be triggered.
  84419. *
  84420. * Defaults to true for backwards compatibility.
  84421. */
  84422. static MATERIAL_LOADING_FAILS_SILENTLY: boolean;
  84423. /**
  84424. * Defines the name of the plugin.
  84425. */
  84426. name: string;
  84427. /**
  84428. * Defines the extension the plugin is able to load.
  84429. */
  84430. extensions: string;
  84431. /** @hidden */
  84432. obj: RegExp;
  84433. /** @hidden */
  84434. group: RegExp;
  84435. /** @hidden */
  84436. mtllib: RegExp;
  84437. /** @hidden */
  84438. usemtl: RegExp;
  84439. /** @hidden */
  84440. smooth: RegExp;
  84441. /** @hidden */
  84442. vertexPattern: RegExp;
  84443. /** @hidden */
  84444. normalPattern: RegExp;
  84445. /** @hidden */
  84446. uvPattern: RegExp;
  84447. /** @hidden */
  84448. facePattern1: RegExp;
  84449. /** @hidden */
  84450. facePattern2: RegExp;
  84451. /** @hidden */
  84452. facePattern3: RegExp;
  84453. /** @hidden */
  84454. facePattern4: RegExp;
  84455. /** @hidden */
  84456. facePattern5: RegExp;
  84457. private _forAssetContainer;
  84458. private _meshLoadOptions;
  84459. /**
  84460. * Creates loader for .OBJ files
  84461. *
  84462. * @param meshLoadOptions options for loading and parsing OBJ/MTL files.
  84463. */
  84464. constructor(meshLoadOptions?: MeshLoadOptions);
  84465. private static get currentMeshLoadOptions();
  84466. /**
  84467. * Calls synchronously the MTL file attached to this obj.
  84468. * Load function or importMesh function don't enable to load 2 files in the same time asynchronously.
  84469. * Without this function materials are not displayed in the first frame (but displayed after).
  84470. * In consequence it is impossible to get material information in your HTML file
  84471. *
  84472. * @param url The URL of the MTL file
  84473. * @param rootUrl
  84474. * @param onSuccess Callback function to be called when the MTL file is loaded
  84475. * @private
  84476. */
  84477. private _loadMTL;
  84478. /**
  84479. * Instantiates a OBJ file loader plugin.
  84480. * @returns the created plugin
  84481. */
  84482. createPlugin(): ISceneLoaderPluginAsync | ISceneLoaderPlugin;
  84483. /**
  84484. * If the data string can be loaded directly.
  84485. *
  84486. * @param data string containing the file data
  84487. * @returns if the data can be loaded directly
  84488. */
  84489. canDirectLoad(data: string): boolean;
  84490. /**
  84491. * Imports one or more meshes from the loaded OBJ data and adds them to the scene
  84492. * @param meshesNames a string or array of strings of the mesh names that should be loaded from the file
  84493. * @param scene the scene the meshes should be added to
  84494. * @param data the OBJ data to load
  84495. * @param rootUrl root url to load from
  84496. * @param onProgress event that fires when loading progress has occured
  84497. * @param fileName Defines the name of the file to load
  84498. * @returns a promise containg the loaded meshes, particles, skeletons and animations
  84499. */
  84500. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  84501. meshes: AbstractMesh[];
  84502. particleSystems: IParticleSystem[];
  84503. skeletons: Skeleton[];
  84504. animationGroups: AnimationGroup[];
  84505. }>;
  84506. /**
  84507. * Imports all objects from the loaded OBJ data and adds them to the scene
  84508. * @param scene the scene the objects should be added to
  84509. * @param data the OBJ data to load
  84510. * @param rootUrl root url to load from
  84511. * @param onProgress event that fires when loading progress has occured
  84512. * @param fileName Defines the name of the file to load
  84513. * @returns a promise which completes when objects have been loaded to the scene
  84514. */
  84515. loadAsync(scene: Scene, data: string, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  84516. /**
  84517. * Load into an asset container.
  84518. * @param scene The scene to load into
  84519. * @param data The data to import
  84520. * @param rootUrl The root url for scene and resources
  84521. * @param onProgress The callback when the load progresses
  84522. * @param fileName Defines the name of the file to load
  84523. * @returns The loaded asset container
  84524. */
  84525. loadAssetContainerAsync(scene: Scene, data: string, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  84526. /**
  84527. * Read the OBJ file and create an Array of meshes.
  84528. * Each mesh contains all information given by the OBJ and the MTL file.
  84529. * i.e. vertices positions and indices, optional normals values, optional UV values, optional material
  84530. *
  84531. * @param meshesNames
  84532. * @param scene Scene The scene where are displayed the data
  84533. * @param data String The content of the obj file
  84534. * @param rootUrl String The path to the folder
  84535. * @returns Array<AbstractMesh>
  84536. * @private
  84537. */
  84538. private _parseSolid;
  84539. }
  84540. }
  84541. declare module BABYLON {
  84542. /**
  84543. * STL file type loader.
  84544. * This is a babylon scene loader plugin.
  84545. */
  84546. export class STLFileLoader implements ISceneLoaderPlugin {
  84547. /** @hidden */
  84548. solidPattern: RegExp;
  84549. /** @hidden */
  84550. facetsPattern: RegExp;
  84551. /** @hidden */
  84552. normalPattern: RegExp;
  84553. /** @hidden */
  84554. vertexPattern: RegExp;
  84555. /**
  84556. * Defines the name of the plugin.
  84557. */
  84558. name: string;
  84559. /**
  84560. * Defines the extensions the stl loader is able to load.
  84561. * force data to come in as an ArrayBuffer
  84562. * we'll convert to string if it looks like it's an ASCII .stl
  84563. */
  84564. extensions: ISceneLoaderPluginExtensions;
  84565. /**
  84566. * Import meshes into a scene.
  84567. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  84568. * @param scene The scene to import into
  84569. * @param data The data to import
  84570. * @param rootUrl The root url for scene and resources
  84571. * @param meshes The meshes array to import into
  84572. * @param particleSystems The particle systems array to import into
  84573. * @param skeletons The skeletons array to import into
  84574. * @param onError The callback when import fails
  84575. * @returns True if successful or false otherwise
  84576. */
  84577. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: Nullable<AbstractMesh[]>, particleSystems: Nullable<IParticleSystem[]>, skeletons: Nullable<Skeleton[]>): boolean;
  84578. /**
  84579. * Load into a scene.
  84580. * @param scene The scene to load into
  84581. * @param data The data to import
  84582. * @param rootUrl The root url for scene and resources
  84583. * @param onError The callback when import fails
  84584. * @returns true if successful or false otherwise
  84585. */
  84586. load(scene: Scene, data: any, rootUrl: string): boolean;
  84587. /**
  84588. * Load into an asset container.
  84589. * @param scene The scene to load into
  84590. * @param data The data to import
  84591. * @param rootUrl The root url for scene and resources
  84592. * @param onError The callback when import fails
  84593. * @returns The loaded asset container
  84594. */
  84595. loadAssetContainer(scene: Scene, data: string, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  84596. private _isBinary;
  84597. private _parseBinary;
  84598. private _parseASCII;
  84599. }
  84600. }
  84601. declare module BABYLON {
  84602. /**
  84603. * Class for generating OBJ data from a Babylon scene.
  84604. */
  84605. export class OBJExport {
  84606. /**
  84607. * Exports the geometry of a Mesh array in .OBJ file format (text)
  84608. * @param mesh defines the list of meshes to serialize
  84609. * @param materials defines if materials should be exported
  84610. * @param matlibname defines the name of the associated mtl file
  84611. * @param globalposition defines if the exported positions are globals or local to the exported mesh
  84612. * @returns the OBJ content
  84613. */
  84614. static OBJ(mesh: Mesh[], materials?: boolean, matlibname?: string, globalposition?: boolean): string;
  84615. /**
  84616. * Exports the material(s) of a mesh in .MTL file format (text)
  84617. * @param mesh defines the mesh to extract the material from
  84618. * @returns the mtl content
  84619. */
  84620. static MTL(mesh: Mesh): string;
  84621. }
  84622. }
  84623. declare module BABYLON {
  84624. /** @hidden */
  84625. export var __IGLTFExporterExtension: number;
  84626. /**
  84627. * Interface for extending the exporter
  84628. * @hidden
  84629. */
  84630. export interface IGLTFExporterExtension {
  84631. /**
  84632. * The name of this extension
  84633. */
  84634. readonly name: string;
  84635. /**
  84636. * Defines whether this extension is enabled
  84637. */
  84638. enabled: boolean;
  84639. /**
  84640. * Defines whether this extension is required
  84641. */
  84642. required: boolean;
  84643. }
  84644. }
  84645. declare module BABYLON.GLTF2.Exporter {
  84646. /** @hidden */
  84647. export var __IGLTFExporterExtensionV2: number;
  84648. /**
  84649. * Interface for a glTF exporter extension
  84650. * @hidden
  84651. */
  84652. export interface IGLTFExporterExtensionV2 extends IGLTFExporterExtension, IDisposable {
  84653. /**
  84654. * Define this method to modify the default behavior before exporting a texture
  84655. * @param context The context when loading the asset
  84656. * @param babylonTexture The Babylon.js texture
  84657. * @param mimeType The mime-type of the generated image
  84658. * @returns A promise that resolves with the exported texture
  84659. */
  84660. preExportTextureAsync?(context: string, babylonTexture: Nullable<Texture>, mimeType: ImageMimeType): Promise<Texture>;
  84661. /**
  84662. * Define this method to get notified when a texture info is created
  84663. * @param context The context when loading the asset
  84664. * @param textureInfo The glTF texture info
  84665. * @param babylonTexture The Babylon.js texture
  84666. */
  84667. postExportTexture?(context: string, textureInfo: ITextureInfo, babylonTexture: BaseTexture): void;
  84668. /**
  84669. * Define this method to modify the default behavior when exporting texture info
  84670. * @param context The context when loading the asset
  84671. * @param meshPrimitive glTF mesh primitive
  84672. * @param babylonSubMesh Babylon submesh
  84673. * @param binaryWriter glTF serializer binary writer instance
  84674. * @returns nullable IMeshPrimitive promise
  84675. */
  84676. postExportMeshPrimitiveAsync?(context: string, meshPrimitive: Nullable<IMeshPrimitive>, babylonSubMesh: SubMesh, binaryWriter: _BinaryWriter): Promise<IMeshPrimitive>;
  84677. /**
  84678. * Define this method to modify the default behavior when exporting a node
  84679. * @param context The context when exporting the node
  84680. * @param node glTF node
  84681. * @param babylonNode BabylonJS node
  84682. * @returns nullable INode promise
  84683. */
  84684. postExportNodeAsync?(context: string, node: Nullable<INode>, babylonNode: Node, nodeMap?: {
  84685. [key: number]: number;
  84686. }): Promise<Nullable<INode>>;
  84687. /**
  84688. * Define this method to modify the default behavior when exporting a material
  84689. * @param material glTF material
  84690. * @param babylonMaterial BabylonJS material
  84691. * @returns nullable IMaterial promise
  84692. */
  84693. postExportMaterialAsync?(context: string, node: Nullable<IMaterial>, babylonMaterial: Material): Promise<IMaterial>;
  84694. /**
  84695. * Define this method to return additional textures to export from a material
  84696. * @param material glTF material
  84697. * @param babylonMaterial BabylonJS material
  84698. * @returns List of textures
  84699. */
  84700. postExportMaterialAdditionalTextures?(context: string, node: IMaterial, babylonMaterial: Material): BaseTexture[];
  84701. /** Gets a boolean indicating that this extension was used */
  84702. wasUsed: boolean;
  84703. /** Gets a boolean indicating that this extension is required for the file to work */
  84704. required: boolean;
  84705. /**
  84706. * Called after the exporter state changes to EXPORTING
  84707. */
  84708. onExporting?(): void;
  84709. }
  84710. }
  84711. declare module BABYLON.GLTF2.Exporter {
  84712. /**
  84713. * Utility methods for working with glTF material conversion properties. This class should only be used internally
  84714. * @hidden
  84715. */
  84716. export class _GLTFMaterialExporter {
  84717. /**
  84718. * Represents the dielectric specular values for R, G and B
  84719. */
  84720. private static readonly _DielectricSpecular;
  84721. /**
  84722. * Allows the maximum specular power to be defined for material calculations
  84723. */
  84724. private static readonly _MaxSpecularPower;
  84725. /**
  84726. * Mapping to store textures
  84727. */
  84728. private _textureMap;
  84729. /**
  84730. * Numeric tolerance value
  84731. */
  84732. private static readonly _Epsilon;
  84733. /**
  84734. * Reference to the glTF Exporter
  84735. */
  84736. private _exporter;
  84737. constructor(exporter: _Exporter);
  84738. /**
  84739. * Specifies if two colors are approximately equal in value
  84740. * @param color1 first color to compare to
  84741. * @param color2 second color to compare to
  84742. * @param epsilon threshold value
  84743. */
  84744. private static FuzzyEquals;
  84745. /**
  84746. * Gets the materials from a Babylon scene and converts them to glTF materials
  84747. * @param scene babylonjs scene
  84748. * @param mimeType texture mime type
  84749. * @param images array of images
  84750. * @param textures array of textures
  84751. * @param materials array of materials
  84752. * @param imageData mapping of texture names to base64 textures
  84753. * @param hasTextureCoords specifies if texture coordinates are present on the material
  84754. */
  84755. _convertMaterialsToGLTFAsync(babylonMaterials: Material[], mimeType: ImageMimeType, hasTextureCoords: boolean): Promise<void>;
  84756. /**
  84757. * Makes a copy of the glTF material without the texture parameters
  84758. * @param originalMaterial original glTF material
  84759. * @returns glTF material without texture parameters
  84760. */
  84761. _stripTexturesFromMaterial(originalMaterial: IMaterial): IMaterial;
  84762. /**
  84763. * Specifies if the material has any texture parameters present
  84764. * @param material glTF Material
  84765. * @returns boolean specifying if texture parameters are present
  84766. */
  84767. _hasTexturesPresent(material: IMaterial): boolean;
  84768. /**
  84769. * Converts a Babylon StandardMaterial to a glTF Metallic Roughness Material
  84770. * @param babylonStandardMaterial
  84771. * @returns glTF Metallic Roughness Material representation
  84772. */
  84773. _convertToGLTFPBRMetallicRoughness(babylonStandardMaterial: StandardMaterial): IMaterialPbrMetallicRoughness;
  84774. /**
  84775. * Computes the metallic factor
  84776. * @param diffuse diffused value
  84777. * @param specular specular value
  84778. * @param oneMinusSpecularStrength one minus the specular strength
  84779. * @returns metallic value
  84780. */
  84781. static _SolveMetallic(diffuse: number, specular: number, oneMinusSpecularStrength: number): number;
  84782. /**
  84783. * Sets the glTF alpha mode to a glTF material from the Babylon Material
  84784. * @param glTFMaterial glTF material
  84785. * @param babylonMaterial Babylon material
  84786. */
  84787. private static _SetAlphaMode;
  84788. /**
  84789. * Converts a Babylon Standard Material to a glTF Material
  84790. * @param babylonStandardMaterial BJS Standard Material
  84791. * @param mimeType mime type to use for the textures
  84792. * @param images array of glTF image interfaces
  84793. * @param textures array of glTF texture interfaces
  84794. * @param materials array of glTF material interfaces
  84795. * @param imageData map of image file name to data
  84796. * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
  84797. */
  84798. _convertStandardMaterialAsync(babylonStandardMaterial: StandardMaterial, mimeType: ImageMimeType, hasTextureCoords: boolean): Promise<IMaterial>;
  84799. private _finishMaterial;
  84800. /**
  84801. * Converts a Babylon PBR Metallic Roughness Material to a glTF Material
  84802. * @param babylonPBRMetalRoughMaterial BJS PBR Metallic Roughness Material
  84803. * @param mimeType mime type to use for the textures
  84804. * @param images array of glTF image interfaces
  84805. * @param textures array of glTF texture interfaces
  84806. * @param materials array of glTF material interfaces
  84807. * @param imageData map of image file name to data
  84808. * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
  84809. */
  84810. _convertPBRMetallicRoughnessMaterialAsync(babylonPBRMetalRoughMaterial: PBRMetallicRoughnessMaterial, mimeType: ImageMimeType, hasTextureCoords: boolean): Promise<IMaterial>;
  84811. /**
  84812. * Converts an image typed array buffer to a base64 image
  84813. * @param buffer typed array buffer
  84814. * @param width width of the image
  84815. * @param height height of the image
  84816. * @param mimeType mimetype of the image
  84817. * @returns base64 image string
  84818. */
  84819. private _createBase64FromCanvasAsync;
  84820. /**
  84821. * Generates a white texture based on the specified width and height
  84822. * @param width width of the texture in pixels
  84823. * @param height height of the texture in pixels
  84824. * @param scene babylonjs scene
  84825. * @returns white texture
  84826. */
  84827. private _createWhiteTexture;
  84828. /**
  84829. * Resizes the two source textures to the same dimensions. If a texture is null, a default white texture is generated. If both textures are null, returns null
  84830. * @param texture1 first texture to resize
  84831. * @param texture2 second texture to resize
  84832. * @param scene babylonjs scene
  84833. * @returns resized textures or null
  84834. */
  84835. private _resizeTexturesToSameDimensions;
  84836. /**
  84837. * Converts an array of pixels to a Float32Array
  84838. * Throws an error if the pixel format is not supported
  84839. * @param pixels - array buffer containing pixel values
  84840. * @returns Float32 of pixels
  84841. */
  84842. private _convertPixelArrayToFloat32;
  84843. /**
  84844. * Convert Specular Glossiness Textures to Metallic Roughness
  84845. * See link below for info on the material conversions from PBR Metallic/Roughness and Specular/Glossiness
  84846. * @link https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_materials_pbrSpecularGlossiness/examples/convert-between-workflows-bjs/js/babylon.pbrUtilities.js
  84847. * @param diffuseTexture texture used to store diffuse information
  84848. * @param specularGlossinessTexture texture used to store specular and glossiness information
  84849. * @param factors specular glossiness material factors
  84850. * @param mimeType the mime type to use for the texture
  84851. * @returns pbr metallic roughness interface or null
  84852. */
  84853. private _convertSpecularGlossinessTexturesToMetallicRoughnessAsync;
  84854. /**
  84855. * Converts specular glossiness material properties to metallic roughness
  84856. * @param specularGlossiness interface with specular glossiness material properties
  84857. * @returns interface with metallic roughness material properties
  84858. */
  84859. private _convertSpecularGlossinessToMetallicRoughness;
  84860. /**
  84861. * Calculates the surface reflectance, independent of lighting conditions
  84862. * @param color Color source to calculate brightness from
  84863. * @returns number representing the perceived brightness, or zero if color is undefined
  84864. */
  84865. private _getPerceivedBrightness;
  84866. /**
  84867. * Returns the maximum color component value
  84868. * @param color
  84869. * @returns maximum color component value, or zero if color is null or undefined
  84870. */
  84871. private _getMaxComponent;
  84872. /**
  84873. * Convert a PBRMaterial (Metallic/Roughness) to Metallic Roughness factors
  84874. * @param babylonPBRMaterial BJS PBR Metallic Roughness Material
  84875. * @param mimeType mime type to use for the textures
  84876. * @param images array of glTF image interfaces
  84877. * @param textures array of glTF texture interfaces
  84878. * @param glTFPbrMetallicRoughness glTF PBR Metallic Roughness interface
  84879. * @param imageData map of image file name to data
  84880. * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
  84881. * @returns glTF PBR Metallic Roughness factors
  84882. */
  84883. private _convertMetalRoughFactorsToMetallicRoughnessAsync;
  84884. private _getGLTFTextureSampler;
  84885. private _getGLTFTextureWrapMode;
  84886. private _getGLTFTextureWrapModesSampler;
  84887. /**
  84888. * Convert a PBRMaterial (Specular/Glossiness) to Metallic Roughness factors
  84889. * @param babylonPBRMaterial BJS PBR Metallic Roughness Material
  84890. * @param mimeType mime type to use for the textures
  84891. * @param images array of glTF image interfaces
  84892. * @param textures array of glTF texture interfaces
  84893. * @param glTFPbrMetallicRoughness glTF PBR Metallic Roughness interface
  84894. * @param imageData map of image file name to data
  84895. * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
  84896. * @returns glTF PBR Metallic Roughness factors
  84897. */
  84898. private _convertSpecGlossFactorsToMetallicRoughnessAsync;
  84899. /**
  84900. * Converts a Babylon PBR Metallic Roughness Material to a glTF Material
  84901. * @param babylonPBRMaterial BJS PBR Metallic Roughness Material
  84902. * @param mimeType mime type to use for the textures
  84903. * @param images array of glTF image interfaces
  84904. * @param textures array of glTF texture interfaces
  84905. * @param materials array of glTF material interfaces
  84906. * @param imageData map of image file name to data
  84907. * @param hasTextureCoords specifies if texture coordinates are present on the submesh to determine if textures should be applied
  84908. */
  84909. _convertPBRMaterialAsync(babylonPBRMaterial: PBRMaterial, mimeType: ImageMimeType, hasTextureCoords: boolean): Promise<IMaterial>;
  84910. private setMetallicRoughnessPbrMaterial;
  84911. private getPixelsFromTexture;
  84912. /**
  84913. * Extracts a texture from a Babylon texture into file data and glTF data
  84914. * @param babylonTexture Babylon texture to extract
  84915. * @param mimeType Mime Type of the babylonTexture
  84916. * @return glTF texture info, or null if the texture format is not supported
  84917. */
  84918. _exportTextureAsync(babylonTexture: BaseTexture, mimeType: ImageMimeType): Promise<Nullable<ITextureInfo>>;
  84919. _exportTextureInfoAsync(babylonTexture: BaseTexture, mimeType: ImageMimeType): Promise<Nullable<ITextureInfo>>;
  84920. /**
  84921. * Builds a texture from base64 string
  84922. * @param base64Texture base64 texture string
  84923. * @param baseTextureName Name to use for the texture
  84924. * @param mimeType image mime type for the texture
  84925. * @param images array of images
  84926. * @param textures array of textures
  84927. * @param imageData map of image data
  84928. * @returns glTF texture info, or null if the texture format is not supported
  84929. */
  84930. private _getTextureInfoFromBase64;
  84931. }
  84932. }
  84933. declare module BABYLON {
  84934. /**
  84935. * Class for holding and downloading glTF file data
  84936. */
  84937. export class GLTFData {
  84938. /**
  84939. * Object which contains the file name as the key and its data as the value
  84940. */
  84941. glTFFiles: {
  84942. [fileName: string]: string | Blob;
  84943. };
  84944. /**
  84945. * Initializes the glTF file object
  84946. */
  84947. constructor();
  84948. /**
  84949. * Downloads the glTF data as files based on their names and data
  84950. */
  84951. downloadFiles(): void;
  84952. }
  84953. }
  84954. declare module BABYLON {
  84955. /**
  84956. * Holds a collection of exporter options and parameters
  84957. */
  84958. export interface IExportOptions {
  84959. /**
  84960. * Function which indicates whether a babylon node should be exported or not
  84961. * @param node source Babylon node. It is used to check whether it should be exported to glTF or not
  84962. * @returns boolean, which indicates whether the node should be exported (true) or not (false)
  84963. */
  84964. shouldExportNode?(node: Node): boolean;
  84965. /**
  84966. * Function used to extract the part of node's metadata that will be exported into glTF node extras
  84967. * @param metadata source metadata to read from
  84968. * @returns the data to store to glTF node extras
  84969. */
  84970. metadataSelector?(metadata: any): any;
  84971. /**
  84972. * The sample rate to bake animation curves
  84973. */
  84974. animationSampleRate?: number;
  84975. /**
  84976. * Begin serialization without waiting for the scene to be ready
  84977. */
  84978. exportWithoutWaitingForScene?: boolean;
  84979. /**
  84980. * Indicates if coordinate system swapping root nodes should be included in export
  84981. */
  84982. includeCoordinateSystemConversionNodes?: boolean;
  84983. }
  84984. /**
  84985. * Class for generating glTF data from a Babylon scene.
  84986. */
  84987. export class GLTF2Export {
  84988. /**
  84989. * Exports the geometry of the scene to .gltf file format asynchronously
  84990. * @param scene Babylon scene with scene hierarchy information
  84991. * @param filePrefix File prefix to use when generating the glTF file
  84992. * @param options Exporter options
  84993. * @returns Returns an object with a .gltf file and associates texture names
  84994. * as keys and their data and paths as values
  84995. */
  84996. static GLTFAsync(scene: Scene, filePrefix: string, options?: IExportOptions): Promise<GLTFData>;
  84997. private static _PreExportAsync;
  84998. private static _PostExportAsync;
  84999. /**
  85000. * Exports the geometry of the scene to .glb file format asychronously
  85001. * @param scene Babylon scene with scene hierarchy information
  85002. * @param filePrefix File prefix to use when generating glb file
  85003. * @param options Exporter options
  85004. * @returns Returns an object with a .glb filename as key and data as value
  85005. */
  85006. static GLBAsync(scene: Scene, filePrefix: string, options?: IExportOptions): Promise<GLTFData>;
  85007. }
  85008. }
  85009. declare module BABYLON.GLTF2.Exporter {
  85010. /**
  85011. * @hidden
  85012. */
  85013. export class _GLTFUtilities {
  85014. /**
  85015. * Creates a buffer view based on the supplied arguments
  85016. * @param bufferIndex index value of the specified buffer
  85017. * @param byteOffset byte offset value
  85018. * @param byteLength byte length of the bufferView
  85019. * @param byteStride byte distance between conequential elements
  85020. * @param name name of the buffer view
  85021. * @returns bufferView for glTF
  85022. */
  85023. static _CreateBufferView(bufferIndex: number, byteOffset: number, byteLength: number, byteStride?: number, name?: string): IBufferView;
  85024. /**
  85025. * Creates an accessor based on the supplied arguments
  85026. * @param bufferviewIndex The index of the bufferview referenced by this accessor
  85027. * @param name The name of the accessor
  85028. * @param type The type of the accessor
  85029. * @param componentType The datatype of components in the attribute
  85030. * @param count The number of attributes referenced by this accessor
  85031. * @param byteOffset The offset relative to the start of the bufferView in bytes
  85032. * @param min Minimum value of each component in this attribute
  85033. * @param max Maximum value of each component in this attribute
  85034. * @returns accessor for glTF
  85035. */
  85036. static _CreateAccessor(bufferviewIndex: number, name: string, type: AccessorType, componentType: AccessorComponentType, count: number, byteOffset: Nullable<number>, min: Nullable<number[]>, max: Nullable<number[]>): IAccessor;
  85037. /**
  85038. * Calculates the minimum and maximum values of an array of position floats
  85039. * @param positions Positions array of a mesh
  85040. * @param vertexStart Starting vertex offset to calculate min and max values
  85041. * @param vertexCount Number of vertices to check for min and max values
  85042. * @returns min number array and max number array
  85043. */
  85044. static _CalculateMinMaxPositions(positions: FloatArray, vertexStart: number, vertexCount: number, convertToRightHandedSystem: boolean): {
  85045. min: number[];
  85046. max: number[];
  85047. };
  85048. /**
  85049. * Converts a new right-handed Vector3
  85050. * @param vector vector3 array
  85051. * @returns right-handed Vector3
  85052. */
  85053. static _GetRightHandedPositionVector3(vector: Vector3): Vector3;
  85054. /**
  85055. * Converts a Vector3 to right-handed
  85056. * @param vector Vector3 to convert to right-handed
  85057. */
  85058. static _GetRightHandedPositionVector3FromRef(vector: Vector3): void;
  85059. /**
  85060. * Converts a three element number array to right-handed
  85061. * @param vector number array to convert to right-handed
  85062. */
  85063. static _GetRightHandedPositionArray3FromRef(vector: number[]): void;
  85064. /**
  85065. * Converts a new right-handed Vector3
  85066. * @param vector vector3 array
  85067. * @returns right-handed Vector3
  85068. */
  85069. static _GetRightHandedNormalVector3(vector: Vector3): Vector3;
  85070. /**
  85071. * Converts a Vector3 to right-handed
  85072. * @param vector Vector3 to convert to right-handed
  85073. */
  85074. static _GetRightHandedNormalVector3FromRef(vector: Vector3): void;
  85075. /**
  85076. * Converts a three element number array to right-handed
  85077. * @param vector number array to convert to right-handed
  85078. */
  85079. static _GetRightHandedNormalArray3FromRef(vector: number[]): void;
  85080. /**
  85081. * Converts a Vector4 to right-handed
  85082. * @param vector Vector4 to convert to right-handed
  85083. */
  85084. static _GetRightHandedVector4FromRef(vector: Vector4): void;
  85085. /**
  85086. * Converts a Vector4 to right-handed
  85087. * @param vector Vector4 to convert to right-handed
  85088. */
  85089. static _GetRightHandedArray4FromRef(vector: number[]): void;
  85090. /**
  85091. * Converts a Quaternion to right-handed
  85092. * @param quaternion Source quaternion to convert to right-handed
  85093. */
  85094. static _GetRightHandedQuaternionFromRef(quaternion: Quaternion): void;
  85095. /**
  85096. * Converts a Quaternion to right-handed
  85097. * @param quaternion Source quaternion to convert to right-handed
  85098. */
  85099. static _GetRightHandedQuaternionArrayFromRef(quaternion: number[]): void;
  85100. static _NormalizeTangentFromRef(tangent: Vector4): void;
  85101. static _GetRightHandedMatrixFromRef(matrix: Matrix): void;
  85102. static _GetDataAccessorElementCount(accessorType: AccessorType): 1 | 3 | 2 | 4 | 9 | 16;
  85103. }
  85104. }
  85105. declare module BABYLON.GLTF2.Exporter {
  85106. /**
  85107. * Converts Babylon Scene into glTF 2.0.
  85108. * @hidden
  85109. */
  85110. export class _Exporter {
  85111. /**
  85112. * Stores the glTF to export
  85113. */
  85114. _glTF: IGLTF;
  85115. /**
  85116. * Stores all generated buffer views, which represents views into the main glTF buffer data
  85117. */
  85118. _bufferViews: IBufferView[];
  85119. /**
  85120. * Stores all the generated accessors, which is used for accessing the data within the buffer views in glTF
  85121. */
  85122. _accessors: IAccessor[];
  85123. /**
  85124. * Stores all the generated nodes, which contains transform and/or mesh information per node
  85125. */
  85126. _nodes: INode[];
  85127. /**
  85128. * Stores all the generated glTF scenes, which stores multiple node hierarchies
  85129. */
  85130. private _scenes;
  85131. /**
  85132. * Stores all the generated mesh information, each containing a set of primitives to render in glTF
  85133. */
  85134. private _meshes;
  85135. /**
  85136. * Stores all the generated material information, which represents the appearance of each primitive
  85137. */
  85138. _materials: IMaterial[];
  85139. _materialMap: {
  85140. [materialID: number]: number;
  85141. };
  85142. /**
  85143. * Stores all the generated texture information, which is referenced by glTF materials
  85144. */
  85145. _textures: ITexture[];
  85146. /**
  85147. * Stores all the generated image information, which is referenced by glTF textures
  85148. */
  85149. _images: IImage[];
  85150. /**
  85151. * Stores all the texture samplers
  85152. */
  85153. _samplers: ISampler[];
  85154. /**
  85155. * Stores all the generated glTF skins
  85156. */
  85157. _skins: ISkin[];
  85158. /**
  85159. * Stores all the generated animation samplers, which is referenced by glTF animations
  85160. */
  85161. /**
  85162. * Stores the animations for glTF models
  85163. */
  85164. private _animations;
  85165. /**
  85166. * Stores the total amount of bytes stored in the glTF buffer
  85167. */
  85168. private _totalByteLength;
  85169. /**
  85170. * Stores a reference to the Babylon scene containing the source geometry and material information
  85171. */
  85172. _babylonScene: Scene;
  85173. /**
  85174. * Stores a map of the image data, where the key is the file name and the value
  85175. * is the image data
  85176. */
  85177. _imageData: {
  85178. [fileName: string]: {
  85179. data: Uint8Array;
  85180. mimeType: ImageMimeType;
  85181. };
  85182. };
  85183. protected _orderedImageData: Array<{
  85184. data: Uint8Array;
  85185. mimeType: ImageMimeType;
  85186. }>;
  85187. /**
  85188. * Stores a map of the unique id of a node to its index in the node array
  85189. */
  85190. _nodeMap: {
  85191. [key: number]: number;
  85192. };
  85193. /**
  85194. * Specifies if the source Babylon scene was left handed, and needed conversion.
  85195. */
  85196. _convertToRightHandedSystem: boolean;
  85197. /**
  85198. * Specifies if a Babylon node should be converted to right-handed on export
  85199. */
  85200. _convertToRightHandedSystemMap: {
  85201. [nodeId: number]: boolean;
  85202. };
  85203. _includeCoordinateSystemConversionNodes: boolean;
  85204. /**
  85205. * Baked animation sample rate
  85206. */
  85207. private _animationSampleRate;
  85208. private _options;
  85209. private _localEngine;
  85210. _glTFMaterialExporter: _GLTFMaterialExporter;
  85211. private _extensions;
  85212. private static _ExtensionNames;
  85213. private static _ExtensionFactories;
  85214. private _applyExtension;
  85215. private _applyExtensions;
  85216. _extensionsPreExportTextureAsync(context: string, babylonTexture: Nullable<Texture>, mimeType: ImageMimeType): Promise<Nullable<BaseTexture>>;
  85217. _extensionsPostExportMeshPrimitiveAsync(context: string, meshPrimitive: IMeshPrimitive, babylonSubMesh: SubMesh, binaryWriter: _BinaryWriter): Promise<Nullable<IMeshPrimitive>>;
  85218. _extensionsPostExportNodeAsync(context: string, node: Nullable<INode>, babylonNode: Node, nodeMap?: {
  85219. [key: number]: number;
  85220. }): Promise<Nullable<INode>>;
  85221. _extensionsPostExportMaterialAsync(context: string, material: Nullable<IMaterial>, babylonMaterial: Material): Promise<Nullable<IMaterial>>;
  85222. _extensionsPostExportMaterialAdditionalTextures(context: string, material: IMaterial, babylonMaterial: Material): BaseTexture[];
  85223. _extensionsPostExportTextures(context: string, textureInfo: ITextureInfo, babylonTexture: BaseTexture): void;
  85224. private _forEachExtensions;
  85225. private _extensionsOnExporting;
  85226. /**
  85227. * Load glTF serializer extensions
  85228. */
  85229. private _loadExtensions;
  85230. /**
  85231. * Creates a glTF Exporter instance, which can accept optional exporter options
  85232. * @param babylonScene Babylon scene object
  85233. * @param options Options to modify the behavior of the exporter
  85234. */
  85235. constructor(babylonScene: Scene, options?: IExportOptions);
  85236. dispose(): void;
  85237. /**
  85238. * Registers a glTF exporter extension
  85239. * @param name Name of the extension to export
  85240. * @param factory The factory function that creates the exporter extension
  85241. */
  85242. static RegisterExtension(name: string, factory: (exporter: _Exporter) => IGLTFExporterExtensionV2): void;
  85243. /**
  85244. * Un-registers an exporter extension
  85245. * @param name The name fo the exporter extension
  85246. * @returns A boolean indicating whether the extension has been un-registered
  85247. */
  85248. static UnregisterExtension(name: string): boolean;
  85249. /**
  85250. * Lazy load a local engine
  85251. */
  85252. _getLocalEngine(): Engine;
  85253. private reorderIndicesBasedOnPrimitiveMode;
  85254. /**
  85255. * Reorders the vertex attribute data based on the primitive mode. This is necessary when indices are not available and the winding order is
  85256. * clock-wise during export to glTF
  85257. * @param submesh BabylonJS submesh
  85258. * @param primitiveMode Primitive mode of the mesh
  85259. * @param sideOrientation the winding order of the submesh
  85260. * @param vertexBufferKind The type of vertex attribute
  85261. * @param meshAttributeArray The vertex attribute data
  85262. * @param byteOffset The offset to the binary data
  85263. * @param binaryWriter The binary data for the glTF file
  85264. * @param convertToRightHandedSystem Converts the values to right-handed
  85265. */
  85266. private reorderVertexAttributeDataBasedOnPrimitiveMode;
  85267. /**
  85268. * Reorders the vertex attributes in the correct triangle mode order . This is necessary when indices are not available and the winding order is
  85269. * clock-wise during export to glTF
  85270. * @param submesh BabylonJS submesh
  85271. * @param primitiveMode Primitive mode of the mesh
  85272. * @param sideOrientation the winding order of the submesh
  85273. * @param vertexBufferKind The type of vertex attribute
  85274. * @param meshAttributeArray The vertex attribute data
  85275. * @param byteOffset The offset to the binary data
  85276. * @param binaryWriter The binary data for the glTF file
  85277. * @param convertToRightHandedSystem Converts the values to right-handed
  85278. */
  85279. private reorderTriangleFillMode;
  85280. /**
  85281. * Reorders the vertex attributes in the correct triangle strip order. This is necessary when indices are not available and the winding order is
  85282. * clock-wise during export to glTF
  85283. * @param submesh BabylonJS submesh
  85284. * @param primitiveMode Primitive mode of the mesh
  85285. * @param sideOrientation the winding order of the submesh
  85286. * @param vertexBufferKind The type of vertex attribute
  85287. * @param meshAttributeArray The vertex attribute data
  85288. * @param byteOffset The offset to the binary data
  85289. * @param binaryWriter The binary data for the glTF file
  85290. * @param convertToRightHandedSystem Converts the values to right-handed
  85291. */
  85292. private reorderTriangleStripDrawMode;
  85293. /**
  85294. * Reorders the vertex attributes in the correct triangle fan order. This is necessary when indices are not available and the winding order is
  85295. * clock-wise during export to glTF
  85296. * @param submesh BabylonJS submesh
  85297. * @param primitiveMode Primitive mode of the mesh
  85298. * @param sideOrientation the winding order of the submesh
  85299. * @param vertexBufferKind The type of vertex attribute
  85300. * @param meshAttributeArray The vertex attribute data
  85301. * @param byteOffset The offset to the binary data
  85302. * @param binaryWriter The binary data for the glTF file
  85303. * @param convertToRightHandedSystem Converts the values to right-handed
  85304. */
  85305. private reorderTriangleFanMode;
  85306. /**
  85307. * Writes the vertex attribute data to binary
  85308. * @param vertices The vertices to write to the binary writer
  85309. * @param byteOffset The offset into the binary writer to overwrite binary data
  85310. * @param vertexAttributeKind The vertex attribute type
  85311. * @param meshAttributeArray The vertex attribute data
  85312. * @param binaryWriter The writer containing the binary data
  85313. * @param convertToRightHandedSystem Converts the values to right-handed
  85314. */
  85315. private writeVertexAttributeData;
  85316. /**
  85317. * Writes mesh attribute data to a data buffer
  85318. * Returns the bytelength of the data
  85319. * @param vertexBufferKind Indicates what kind of vertex data is being passed in
  85320. * @param meshAttributeArray Array containing the attribute data
  85321. * @param byteStride Specifies the space between data
  85322. * @param binaryWriter The buffer to write the binary data to
  85323. * @param convertToRightHandedSystem Converts the values to right-handed
  85324. */
  85325. writeAttributeData(vertexBufferKind: string, attributeComponentKind: AccessorComponentType, meshAttributeArray: FloatArray, stride: number, binaryWriter: _BinaryWriter, convertToRightHandedSystem: boolean, babylonTransformNode: TransformNode): void;
  85326. /**
  85327. * Writes mesh attribute data to a data buffer
  85328. * Returns the bytelength of the data
  85329. * @param vertexBufferKind Indicates what kind of vertex data is being passed in
  85330. * @param meshAttributeArray Array containing the attribute data
  85331. * @param byteStride Specifies the space between data
  85332. * @param binaryWriter The buffer to write the binary data to
  85333. * @param convertToRightHandedSystem Converts the values to right-handed
  85334. */
  85335. writeMorphTargetAttributeData(vertexBufferKind: string, attributeComponentKind: AccessorComponentType, meshPrimitive: SubMesh, morphTarget: MorphTarget, meshAttributeArray: FloatArray, morphTargetAttributeArray: FloatArray, stride: number, binaryWriter: _BinaryWriter, convertToRightHandedSystem: boolean, minMax?: any): void;
  85336. /**
  85337. * Generates glTF json data
  85338. * @param shouldUseGlb Indicates whether the json should be written for a glb file
  85339. * @param glTFPrefix Text to use when prefixing a glTF file
  85340. * @param prettyPrint Indicates whether the json file should be pretty printed (true) or not (false)
  85341. * @returns json data as string
  85342. */
  85343. private generateJSON;
  85344. /**
  85345. * Generates data for .gltf and .bin files based on the glTF prefix string
  85346. * @param glTFPrefix Text to use when prefixing a glTF file
  85347. * @param dispose Dispose the exporter
  85348. * @returns GLTFData with glTF file data
  85349. */
  85350. _generateGLTFAsync(glTFPrefix: string, dispose?: boolean): Promise<GLTFData>;
  85351. /**
  85352. * Creates a binary buffer for glTF
  85353. * @returns array buffer for binary data
  85354. */
  85355. private _generateBinaryAsync;
  85356. /**
  85357. * Pads the number to a multiple of 4
  85358. * @param num number to pad
  85359. * @returns padded number
  85360. */
  85361. private _getPadding;
  85362. /**
  85363. * @hidden
  85364. */
  85365. _generateGLBAsync(glTFPrefix: string, dispose?: boolean): Promise<GLTFData>;
  85366. /**
  85367. * Sets the TRS for each node
  85368. * @param node glTF Node for storing the transformation data
  85369. * @param babylonTransformNode Babylon mesh used as the source for the transformation data
  85370. * @param convertToRightHandedSystem Converts the values to right-handed
  85371. */
  85372. private setNodeTransformation;
  85373. private getVertexBufferFromMesh;
  85374. /**
  85375. * Creates a bufferview based on the vertices type for the Babylon mesh
  85376. * @param kind Indicates the type of vertices data
  85377. * @param componentType Indicates the numerical type used to store the data
  85378. * @param babylonTransformNode The Babylon mesh to get the vertices data from
  85379. * @param binaryWriter The buffer to write the bufferview data to
  85380. * @param convertToRightHandedSystem Converts the values to right-handed
  85381. */
  85382. private createBufferViewKind;
  85383. /**
  85384. * Creates a bufferview based on the vertices type for the Babylon mesh
  85385. * @param babylonSubMesh The Babylon submesh that the morph target is applied to
  85386. * @param babylonMorphTarget the morph target to be exported
  85387. * @param binaryWriter The buffer to write the bufferview data to
  85388. * @param convertToRightHandedSystem Converts the values to right-handed
  85389. */
  85390. private setMorphTargetAttributes;
  85391. /**
  85392. * The primitive mode of the Babylon mesh
  85393. * @param babylonMesh The BabylonJS mesh
  85394. */
  85395. private getMeshPrimitiveMode;
  85396. /**
  85397. * Sets the primitive mode of the glTF mesh primitive
  85398. * @param meshPrimitive glTF mesh primitive
  85399. * @param primitiveMode The primitive mode
  85400. */
  85401. private setPrimitiveMode;
  85402. /**
  85403. * Sets the vertex attribute accessor based of the glTF mesh primitive
  85404. * @param meshPrimitive glTF mesh primitive
  85405. * @param attributeKind vertex attribute
  85406. * @returns boolean specifying if uv coordinates are present
  85407. */
  85408. private setAttributeKind;
  85409. /**
  85410. * Sets data for the primitive attributes of each submesh
  85411. * @param mesh glTF Mesh object to store the primitive attribute information
  85412. * @param babylonTransformNode Babylon mesh to get the primitive attribute data from
  85413. * @param binaryWriter Buffer to write the attribute data to
  85414. * @param convertToRightHandedSystem Converts the values to right-handed
  85415. */
  85416. private setPrimitiveAttributesAsync;
  85417. /**
  85418. * Check if the node is used to convert its descendants from a right handed coordinate system to the Babylon scene's coordinate system.
  85419. * @param node The node to check
  85420. * @returns True if the node is used to convert its descendants from right-handed to left-handed. False otherwise
  85421. */
  85422. private isBabylonCoordinateSystemConvertingNode;
  85423. /**
  85424. * Creates a glTF scene based on the array of meshes
  85425. * Returns the the total byte offset
  85426. * @param babylonScene Babylon scene to get the mesh data from
  85427. * @param binaryWriter Buffer to write binary data to
  85428. */
  85429. private createSceneAsync;
  85430. /**
  85431. * Creates a mapping of Node unique id to node index and handles animations
  85432. * @param babylonScene Babylon Scene
  85433. * @param nodes Babylon transform nodes
  85434. * @param binaryWriter Buffer to write binary data to
  85435. * @returns Node mapping of unique id to index
  85436. */
  85437. private createNodeMapAndAnimationsAsync;
  85438. /**
  85439. * Creates a glTF node from a Babylon mesh
  85440. * @param babylonMesh Source Babylon mesh
  85441. * @param binaryWriter Buffer for storing geometry data
  85442. * @param convertToRightHandedSystem Converts the values to right-handed
  85443. * @param nodeMap Node mapping of unique id to glTF node index
  85444. * @returns glTF node
  85445. */
  85446. private createNodeAsync;
  85447. /**
  85448. * Creates a glTF skin from a Babylon skeleton
  85449. * @param babylonScene Babylon Scene
  85450. * @param nodes Babylon transform nodes
  85451. * @param binaryWriter Buffer to write binary data to
  85452. * @returns Node mapping of unique id to index
  85453. */
  85454. private createSkinsAsync;
  85455. }
  85456. /**
  85457. * @hidden
  85458. *
  85459. * Stores glTF binary data. If the array buffer byte length is exceeded, it doubles in size dynamically
  85460. */
  85461. export class _BinaryWriter {
  85462. /**
  85463. * Array buffer which stores all binary data
  85464. */
  85465. private _arrayBuffer;
  85466. /**
  85467. * View of the array buffer
  85468. */
  85469. private _dataView;
  85470. /**
  85471. * byte offset of data in array buffer
  85472. */
  85473. private _byteOffset;
  85474. /**
  85475. * Initialize binary writer with an initial byte length
  85476. * @param byteLength Initial byte length of the array buffer
  85477. */
  85478. constructor(byteLength: number);
  85479. /**
  85480. * Resize the array buffer to the specified byte length
  85481. * @param byteLength
  85482. */
  85483. private resizeBuffer;
  85484. /**
  85485. * Get an array buffer with the length of the byte offset
  85486. * @returns ArrayBuffer resized to the byte offset
  85487. */
  85488. getArrayBuffer(): ArrayBuffer;
  85489. /**
  85490. * Get the byte offset of the array buffer
  85491. * @returns byte offset
  85492. */
  85493. getByteOffset(): number;
  85494. /**
  85495. * Stores an UInt8 in the array buffer
  85496. * @param entry
  85497. * @param byteOffset If defined, specifies where to set the value as an offset.
  85498. */
  85499. setUInt8(entry: number, byteOffset?: number): void;
  85500. /**
  85501. * Stores an UInt16 in the array buffer
  85502. * @param entry
  85503. * @param byteOffset If defined, specifies where to set the value as an offset.
  85504. */
  85505. setUInt16(entry: number, byteOffset?: number): void;
  85506. /**
  85507. * Gets an UInt32 in the array buffer
  85508. * @param entry
  85509. * @param byteOffset If defined, specifies where to set the value as an offset.
  85510. */
  85511. getUInt32(byteOffset: number): number;
  85512. getVector3Float32FromRef(vector3: Vector3, byteOffset: number): void;
  85513. setVector3Float32FromRef(vector3: Vector3, byteOffset: number): void;
  85514. getVector4Float32FromRef(vector4: Vector4, byteOffset: number): void;
  85515. setVector4Float32FromRef(vector4: Vector4, byteOffset: number): void;
  85516. /**
  85517. * Stores a Float32 in the array buffer
  85518. * @param entry
  85519. */
  85520. setFloat32(entry: number, byteOffset?: number): void;
  85521. /**
  85522. * Stores an UInt32 in the array buffer
  85523. * @param entry
  85524. * @param byteOffset If defined, specifies where to set the value as an offset.
  85525. */
  85526. setUInt32(entry: number, byteOffset?: number): void;
  85527. }
  85528. }
  85529. declare module BABYLON.GLTF2.Exporter {
  85530. /**
  85531. * @hidden
  85532. * Interface to store animation data.
  85533. */
  85534. export interface _IAnimationData {
  85535. /**
  85536. * Keyframe data.
  85537. */
  85538. inputs: number[];
  85539. /**
  85540. * Value data.
  85541. */
  85542. outputs: number[][];
  85543. /**
  85544. * Animation interpolation data.
  85545. */
  85546. samplerInterpolation: AnimationSamplerInterpolation;
  85547. /**
  85548. * Minimum keyframe value.
  85549. */
  85550. inputsMin: number;
  85551. /**
  85552. * Maximum keyframe value.
  85553. */
  85554. inputsMax: number;
  85555. }
  85556. /**
  85557. * @hidden
  85558. */
  85559. export interface _IAnimationInfo {
  85560. /**
  85561. * The target channel for the animation
  85562. */
  85563. animationChannelTargetPath: AnimationChannelTargetPath;
  85564. /**
  85565. * The glTF accessor type for the data.
  85566. */
  85567. dataAccessorType: AccessorType.VEC3 | AccessorType.VEC4 | AccessorType.SCALAR;
  85568. /**
  85569. * Specifies if quaternions should be used.
  85570. */
  85571. useQuaternion: boolean;
  85572. }
  85573. /**
  85574. * @hidden
  85575. * Utility class for generating glTF animation data from BabylonJS.
  85576. */
  85577. export class _GLTFAnimation {
  85578. /**
  85579. * @ignore
  85580. *
  85581. * Creates glTF channel animation from BabylonJS animation.
  85582. * @param babylonTransformNode - BabylonJS mesh.
  85583. * @param animation - animation.
  85584. * @param animationChannelTargetPath - The target animation channel.
  85585. * @param convertToRightHandedSystem - Specifies if the values should be converted to right-handed.
  85586. * @param useQuaternion - Specifies if quaternions are used.
  85587. * @returns nullable IAnimationData
  85588. */
  85589. static _CreateNodeAnimation(babylonTransformNode: TransformNode, animation: Animation, animationChannelTargetPath: AnimationChannelTargetPath, convertToRightHandedSystem: boolean, useQuaternion: boolean, animationSampleRate: number): Nullable<_IAnimationData>;
  85590. private static _DeduceAnimationInfo;
  85591. /**
  85592. * @ignore
  85593. * Create node animations from the transform node animations
  85594. * @param babylonNode
  85595. * @param runtimeGLTFAnimation
  85596. * @param idleGLTFAnimations
  85597. * @param nodeMap
  85598. * @param nodes
  85599. * @param binaryWriter
  85600. * @param bufferViews
  85601. * @param accessors
  85602. * @param convertToRightHandedSystem
  85603. * @param animationSampleRate
  85604. */
  85605. static _CreateNodeAnimationFromNodeAnimations(babylonNode: Node, runtimeGLTFAnimation: IAnimation, idleGLTFAnimations: IAnimation[], nodeMap: {
  85606. [key: number]: number;
  85607. }, nodes: INode[], binaryWriter: _BinaryWriter, bufferViews: IBufferView[], accessors: IAccessor[], convertToRightHandedSystem: boolean, animationSampleRate: number): void;
  85608. /**
  85609. * @ignore
  85610. * Create individual morph animations from the mesh's morph target animation tracks
  85611. * @param babylonNode
  85612. * @param runtimeGLTFAnimation
  85613. * @param idleGLTFAnimations
  85614. * @param nodeMap
  85615. * @param nodes
  85616. * @param binaryWriter
  85617. * @param bufferViews
  85618. * @param accessors
  85619. * @param convertToRightHandedSystem
  85620. * @param animationSampleRate
  85621. */
  85622. static _CreateMorphTargetAnimationFromMorphTargetAnimations(babylonNode: Node, runtimeGLTFAnimation: IAnimation, idleGLTFAnimations: IAnimation[], nodeMap: {
  85623. [key: number]: number;
  85624. }, nodes: INode[], binaryWriter: _BinaryWriter, bufferViews: IBufferView[], accessors: IAccessor[], convertToRightHandedSystem: boolean, animationSampleRate: number): void;
  85625. /**
  85626. * @ignore
  85627. * Create node and morph animations from the animation groups
  85628. * @param babylonScene
  85629. * @param glTFAnimations
  85630. * @param nodeMap
  85631. * @param nodes
  85632. * @param binaryWriter
  85633. * @param bufferViews
  85634. * @param accessors
  85635. * @param convertToRightHandedSystemMap
  85636. * @param animationSampleRate
  85637. */
  85638. static _CreateNodeAndMorphAnimationFromAnimationGroups(babylonScene: Scene, glTFAnimations: IAnimation[], nodeMap: {
  85639. [key: number]: number;
  85640. }, nodes: INode[], binaryWriter: _BinaryWriter, bufferViews: IBufferView[], accessors: IAccessor[], convertToRightHandedSystemMap: {
  85641. [nodeId: number]: boolean;
  85642. }, animationSampleRate: number): void;
  85643. private static AddAnimation;
  85644. /**
  85645. * Create a baked animation
  85646. * @param babylonTransformNode BabylonJS mesh
  85647. * @param animation BabylonJS animation corresponding to the BabylonJS mesh
  85648. * @param animationChannelTargetPath animation target channel
  85649. * @param minFrame minimum animation frame
  85650. * @param maxFrame maximum animation frame
  85651. * @param fps frames per second of the animation
  85652. * @param inputs input key frames of the animation
  85653. * @param outputs output key frame data of the animation
  85654. * @param convertToRightHandedSystem converts the values to right-handed
  85655. * @param useQuaternion specifies if quaternions should be used
  85656. */
  85657. private static _CreateBakedAnimation;
  85658. private static _ConvertFactorToVector3OrQuaternion;
  85659. private static _SetInterpolatedValue;
  85660. /**
  85661. * Creates linear animation from the animation key frames
  85662. * @param babylonTransformNode BabylonJS mesh
  85663. * @param animation BabylonJS animation
  85664. * @param animationChannelTargetPath The target animation channel
  85665. * @param frameDelta The difference between the last and first frame of the animation
  85666. * @param inputs Array to store the key frame times
  85667. * @param outputs Array to store the key frame data
  85668. * @param convertToRightHandedSystem Specifies if the position data should be converted to right handed
  85669. * @param useQuaternion Specifies if quaternions are used in the animation
  85670. */
  85671. private static _CreateLinearOrStepAnimation;
  85672. /**
  85673. * Creates cubic spline animation from the animation key frames
  85674. * @param babylonTransformNode BabylonJS mesh
  85675. * @param animation BabylonJS animation
  85676. * @param animationChannelTargetPath The target animation channel
  85677. * @param frameDelta The difference between the last and first frame of the animation
  85678. * @param inputs Array to store the key frame times
  85679. * @param outputs Array to store the key frame data
  85680. * @param convertToRightHandedSystem Specifies if the position data should be converted to right handed
  85681. * @param useQuaternion Specifies if quaternions are used in the animation
  85682. */
  85683. private static _CreateCubicSplineAnimation;
  85684. private static _GetBasePositionRotationOrScale;
  85685. /**
  85686. * Adds a key frame value
  85687. * @param keyFrame
  85688. * @param animation
  85689. * @param outputs
  85690. * @param animationChannelTargetPath
  85691. * @param basePositionRotationOrScale
  85692. * @param convertToRightHandedSystem
  85693. * @param useQuaternion
  85694. */
  85695. private static _AddKeyframeValue;
  85696. /**
  85697. * Determine the interpolation based on the key frames
  85698. * @param keyFrames
  85699. * @param animationChannelTargetPath
  85700. * @param useQuaternion
  85701. */
  85702. private static _DeduceInterpolation;
  85703. /**
  85704. * Adds an input tangent or output tangent to the output data
  85705. * If an input tangent or output tangent is missing, it uses the zero vector or zero quaternion
  85706. * @param tangentType Specifies which type of tangent to handle (inTangent or outTangent)
  85707. * @param outputs The animation data by keyframe
  85708. * @param animationChannelTargetPath The target animation channel
  85709. * @param interpolation The interpolation type
  85710. * @param keyFrame The key frame with the animation data
  85711. * @param frameDelta Time difference between two frames used to scale the tangent by the frame delta
  85712. * @param useQuaternion Specifies if quaternions are used
  85713. * @param convertToRightHandedSystem Specifies if the values should be converted to right-handed
  85714. */
  85715. private static AddSplineTangent;
  85716. /**
  85717. * Get the minimum and maximum key frames' frame values
  85718. * @param keyFrames animation key frames
  85719. * @returns the minimum and maximum key frame value
  85720. */
  85721. private static calculateMinMaxKeyFrames;
  85722. }
  85723. }
  85724. declare module BABYLON.GLTF2.Exporter {
  85725. /** @hidden */
  85726. export var textureTransformPixelShader: {
  85727. name: string;
  85728. shader: string;
  85729. };
  85730. }
  85731. declare module BABYLON.GLTF2.Exporter.Extensions {
  85732. /**
  85733. * @hidden
  85734. */
  85735. export class KHR_texture_transform implements IGLTFExporterExtensionV2 {
  85736. private _recordedTextures;
  85737. /** Name of this extension */
  85738. readonly name: string;
  85739. /** Defines whether this extension is enabled */
  85740. enabled: boolean;
  85741. /** Defines whether this extension is required */
  85742. required: boolean;
  85743. /** Reference to the glTF exporter */
  85744. private _wasUsed;
  85745. constructor(exporter: _Exporter);
  85746. dispose(): void;
  85747. /** @hidden */
  85748. get wasUsed(): boolean;
  85749. postExportTexture?(context: string, textureInfo: ITextureInfo, babylonTexture: Texture): void;
  85750. preExportTextureAsync(context: string, babylonTexture: Texture, mimeType: ImageMimeType): Promise<Texture>;
  85751. /**
  85752. * Transform the babylon texture by the offset, rotation and scale parameters using a procedural texture
  85753. * @param babylonTexture
  85754. * @param offset
  85755. * @param rotation
  85756. * @param scale
  85757. * @param scene
  85758. */
  85759. private _textureTransformTextureAsync;
  85760. }
  85761. }
  85762. declare module BABYLON.GLTF2.Exporter.Extensions {
  85763. /**
  85764. * [Specification](https://github.com/KhronosGroup/glTF/blob/master/extensions/2.0/Khronos/KHR_lights_punctual/README.md)
  85765. */
  85766. export class KHR_lights_punctual implements IGLTFExporterExtensionV2 {
  85767. /** The name of this extension. */
  85768. readonly name: string;
  85769. /** Defines whether this extension is enabled. */
  85770. enabled: boolean;
  85771. /** Defines whether this extension is required */
  85772. required: boolean;
  85773. /** Reference to the glTF exporter */
  85774. private _exporter;
  85775. private _lights;
  85776. /** @hidden */
  85777. constructor(exporter: _Exporter);
  85778. /** @hidden */
  85779. dispose(): void;
  85780. /** @hidden */
  85781. get wasUsed(): boolean;
  85782. /** @hidden */
  85783. onExporting(): void;
  85784. /**
  85785. * Define this method to modify the default behavior when exporting a node
  85786. * @param context The context when exporting the node
  85787. * @param node glTF node
  85788. * @param babylonNode BabylonJS node
  85789. * @param nodeMap Node mapping of unique id to glTF node index
  85790. * @returns nullable INode promise
  85791. */
  85792. postExportNodeAsync(context: string, node: Nullable<INode>, babylonNode: Node, nodeMap?: {
  85793. [key: number]: number;
  85794. }): Promise<Nullable<INode>>;
  85795. }
  85796. }
  85797. declare module BABYLON.GLTF2.Exporter.Extensions {
  85798. /**
  85799. * @hidden
  85800. */
  85801. export class KHR_materials_sheen implements IGLTFExporterExtensionV2 {
  85802. /** Name of this extension */
  85803. readonly name: string;
  85804. /** Defines whether this extension is enabled */
  85805. enabled: boolean;
  85806. /** Defines whether this extension is required */
  85807. required: boolean;
  85808. /** Reference to the glTF exporter */
  85809. private _textureInfos;
  85810. private _exportedTextures;
  85811. private _wasUsed;
  85812. constructor(exporter: _Exporter);
  85813. dispose(): void;
  85814. /** @hidden */
  85815. get wasUsed(): boolean;
  85816. private _getTextureIndex;
  85817. postExportTexture?(context: string, textureInfo: ITextureInfo, babylonTexture: Texture): void;
  85818. postExportMaterialAdditionalTextures?(context: string, node: IMaterial, babylonMaterial: Material): BaseTexture[];
  85819. postExportMaterialAsync?(context: string, node: IMaterial, babylonMaterial: Material): Promise<IMaterial>;
  85820. }
  85821. }
  85822. declare module BABYLON.GLTF2.Exporter.Extensions {
  85823. /**
  85824. * @hidden
  85825. */
  85826. export class KHR_materials_unlit implements IGLTFExporterExtensionV2 {
  85827. /** Name of this extension */
  85828. readonly name: string;
  85829. /** Defines whether this extension is enabled */
  85830. enabled: boolean;
  85831. /** Defines whether this extension is required */
  85832. required: boolean;
  85833. private _wasUsed;
  85834. constructor(exporter: _Exporter);
  85835. /** @hidden */
  85836. get wasUsed(): boolean;
  85837. dispose(): void;
  85838. postExportMaterialAsync?(context: string, node: IMaterial, babylonMaterial: Material): Promise<IMaterial>;
  85839. }
  85840. }
  85841. declare module BABYLON {
  85842. /**
  85843. * Class for generating STL data from a Babylon scene.
  85844. */
  85845. export class STLExport {
  85846. /**
  85847. * Exports the geometry of a Mesh array in .STL file format (ASCII)
  85848. * @param meshes list defines the mesh to serialize
  85849. * @param download triggers the automatic download of the file.
  85850. * @param fileName changes the downloads fileName.
  85851. * @param binary changes the STL to a binary type.
  85852. * @param isLittleEndian toggle for binary type exporter.
  85853. * @returns the STL as UTF8 string
  85854. */
  85855. static CreateSTL(meshes: Mesh[], download?: boolean, fileName?: string, binary?: boolean, isLittleEndian?: boolean): any;
  85856. }
  85857. }
  85858. declare module "babylonjs-gltf2interface" {
  85859. export = BABYLON.GLTF2;
  85860. }
  85861. /**
  85862. * Module for glTF 2.0 Interface
  85863. */
  85864. declare module BABYLON.GLTF2 {
  85865. /**
  85866. * The datatype of the components in the attribute
  85867. */
  85868. const enum AccessorComponentType {
  85869. /**
  85870. * Byte
  85871. */
  85872. BYTE = 5120,
  85873. /**
  85874. * Unsigned Byte
  85875. */
  85876. UNSIGNED_BYTE = 5121,
  85877. /**
  85878. * Short
  85879. */
  85880. SHORT = 5122,
  85881. /**
  85882. * Unsigned Short
  85883. */
  85884. UNSIGNED_SHORT = 5123,
  85885. /**
  85886. * Unsigned Int
  85887. */
  85888. UNSIGNED_INT = 5125,
  85889. /**
  85890. * Float
  85891. */
  85892. FLOAT = 5126,
  85893. }
  85894. /**
  85895. * Specifies if the attirbute is a scalar, vector, or matrix
  85896. */
  85897. const enum AccessorType {
  85898. /**
  85899. * Scalar
  85900. */
  85901. SCALAR = "SCALAR",
  85902. /**
  85903. * Vector2
  85904. */
  85905. VEC2 = "VEC2",
  85906. /**
  85907. * Vector3
  85908. */
  85909. VEC3 = "VEC3",
  85910. /**
  85911. * Vector4
  85912. */
  85913. VEC4 = "VEC4",
  85914. /**
  85915. * Matrix2x2
  85916. */
  85917. MAT2 = "MAT2",
  85918. /**
  85919. * Matrix3x3
  85920. */
  85921. MAT3 = "MAT3",
  85922. /**
  85923. * Matrix4x4
  85924. */
  85925. MAT4 = "MAT4",
  85926. }
  85927. /**
  85928. * The name of the node's TRS property to modify, or the weights of the Morph Targets it instantiates
  85929. */
  85930. const enum AnimationChannelTargetPath {
  85931. /**
  85932. * Translation
  85933. */
  85934. TRANSLATION = "translation",
  85935. /**
  85936. * Rotation
  85937. */
  85938. ROTATION = "rotation",
  85939. /**
  85940. * Scale
  85941. */
  85942. SCALE = "scale",
  85943. /**
  85944. * Weights
  85945. */
  85946. WEIGHTS = "weights",
  85947. }
  85948. /**
  85949. * Interpolation algorithm
  85950. */
  85951. const enum AnimationSamplerInterpolation {
  85952. /**
  85953. * The animated values are linearly interpolated between keyframes
  85954. */
  85955. LINEAR = "LINEAR",
  85956. /**
  85957. * The animated values remain constant to the output of the first keyframe, until the next keyframe
  85958. */
  85959. STEP = "STEP",
  85960. /**
  85961. * The animation's interpolation is computed using a cubic spline with specified tangents
  85962. */
  85963. CUBICSPLINE = "CUBICSPLINE",
  85964. }
  85965. /**
  85966. * A camera's projection. A node can reference a camera to apply a transform to place the camera in the scene
  85967. */
  85968. const enum CameraType {
  85969. /**
  85970. * A perspective camera containing properties to create a perspective projection matrix
  85971. */
  85972. PERSPECTIVE = "perspective",
  85973. /**
  85974. * An orthographic camera containing properties to create an orthographic projection matrix
  85975. */
  85976. ORTHOGRAPHIC = "orthographic",
  85977. }
  85978. /**
  85979. * The mime-type of the image
  85980. */
  85981. const enum ImageMimeType {
  85982. /**
  85983. * JPEG Mime-type
  85984. */
  85985. JPEG = "image/jpeg",
  85986. /**
  85987. * PNG Mime-type
  85988. */
  85989. PNG = "image/png",
  85990. }
  85991. /**
  85992. * The alpha rendering mode of the material
  85993. */
  85994. const enum MaterialAlphaMode {
  85995. /**
  85996. * The alpha value is ignored and the rendered output is fully opaque
  85997. */
  85998. OPAQUE = "OPAQUE",
  85999. /**
  86000. * The rendered output is either fully opaque or fully transparent depending on the alpha value and the specified alpha cutoff value
  86001. */
  86002. MASK = "MASK",
  86003. /**
  86004. * The alpha value is used to composite the source and destination areas. The rendered output is combined with the background using the normal painting operation (i.e. the Porter and Duff over operator)
  86005. */
  86006. BLEND = "BLEND",
  86007. }
  86008. /**
  86009. * The type of the primitives to render
  86010. */
  86011. const enum MeshPrimitiveMode {
  86012. /**
  86013. * Points
  86014. */
  86015. POINTS = 0,
  86016. /**
  86017. * Lines
  86018. */
  86019. LINES = 1,
  86020. /**
  86021. * Line Loop
  86022. */
  86023. LINE_LOOP = 2,
  86024. /**
  86025. * Line Strip
  86026. */
  86027. LINE_STRIP = 3,
  86028. /**
  86029. * Triangles
  86030. */
  86031. TRIANGLES = 4,
  86032. /**
  86033. * Triangle Strip
  86034. */
  86035. TRIANGLE_STRIP = 5,
  86036. /**
  86037. * Triangle Fan
  86038. */
  86039. TRIANGLE_FAN = 6,
  86040. }
  86041. /**
  86042. * Magnification filter. Valid values correspond to WebGL enums: 9728 (NEAREST) and 9729 (LINEAR)
  86043. */
  86044. const enum TextureMagFilter {
  86045. /**
  86046. * Nearest
  86047. */
  86048. NEAREST = 9728,
  86049. /**
  86050. * Linear
  86051. */
  86052. LINEAR = 9729,
  86053. }
  86054. /**
  86055. * Minification filter. All valid values correspond to WebGL enums
  86056. */
  86057. const enum TextureMinFilter {
  86058. /**
  86059. * Nearest
  86060. */
  86061. NEAREST = 9728,
  86062. /**
  86063. * Linear
  86064. */
  86065. LINEAR = 9729,
  86066. /**
  86067. * Nearest Mip-Map Nearest
  86068. */
  86069. NEAREST_MIPMAP_NEAREST = 9984,
  86070. /**
  86071. * Linear Mipmap Nearest
  86072. */
  86073. LINEAR_MIPMAP_NEAREST = 9985,
  86074. /**
  86075. * Nearest Mipmap Linear
  86076. */
  86077. NEAREST_MIPMAP_LINEAR = 9986,
  86078. /**
  86079. * Linear Mipmap Linear
  86080. */
  86081. LINEAR_MIPMAP_LINEAR = 9987,
  86082. }
  86083. /**
  86084. * S (U) wrapping mode. All valid values correspond to WebGL enums
  86085. */
  86086. const enum TextureWrapMode {
  86087. /**
  86088. * Clamp to Edge
  86089. */
  86090. CLAMP_TO_EDGE = 33071,
  86091. /**
  86092. * Mirrored Repeat
  86093. */
  86094. MIRRORED_REPEAT = 33648,
  86095. /**
  86096. * Repeat
  86097. */
  86098. REPEAT = 10497,
  86099. }
  86100. /**
  86101. * glTF Property
  86102. */
  86103. interface IProperty {
  86104. /**
  86105. * Dictionary object with extension-specific objects
  86106. */
  86107. extensions?: {
  86108. [key: string]: any;
  86109. };
  86110. /**
  86111. * Application-Specific data
  86112. */
  86113. extras?: any;
  86114. }
  86115. /**
  86116. * glTF Child of Root Property
  86117. */
  86118. interface IChildRootProperty extends IProperty {
  86119. /**
  86120. * The user-defined name of this object
  86121. */
  86122. name?: string;
  86123. }
  86124. /**
  86125. * Indices of those attributes that deviate from their initialization value
  86126. */
  86127. interface IAccessorSparseIndices extends IProperty {
  86128. /**
  86129. * The index of the bufferView with sparse indices. Referenced bufferView can't have ARRAY_BUFFER or ELEMENT_ARRAY_BUFFER target
  86130. */
  86131. bufferView: number;
  86132. /**
  86133. * The offset relative to the start of the bufferView in bytes. Must be aligned
  86134. */
  86135. byteOffset?: number;
  86136. /**
  86137. * The indices data type. Valid values correspond to WebGL enums: 5121 (UNSIGNED_BYTE), 5123 (UNSIGNED_SHORT), 5125 (UNSIGNED_INT)
  86138. */
  86139. componentType: AccessorComponentType;
  86140. }
  86141. /**
  86142. * Array of size accessor.sparse.count times number of components storing the displaced accessor attributes pointed by accessor.sparse.indices
  86143. */
  86144. interface IAccessorSparseValues extends IProperty {
  86145. /**
  86146. * The index of the bufferView with sparse values. Referenced bufferView can't have ARRAY_BUFFER or ELEMENT_ARRAY_BUFFER target
  86147. */
  86148. bufferView: number;
  86149. /**
  86150. * The offset relative to the start of the bufferView in bytes. Must be aligned
  86151. */
  86152. byteOffset?: number;
  86153. }
  86154. /**
  86155. * Sparse storage of attributes that deviate from their initialization value
  86156. */
  86157. interface IAccessorSparse extends IProperty {
  86158. /**
  86159. * The number of attributes encoded in this sparse accessor
  86160. */
  86161. count: number;
  86162. /**
  86163. * Index array of size count that points to those accessor attributes that deviate from their initialization value. Indices must strictly increase
  86164. */
  86165. indices: IAccessorSparseIndices;
  86166. /**
  86167. * Array of size count times number of components, storing the displaced accessor attributes pointed by indices. Substituted values must have the same componentType and number of components as the base accessor
  86168. */
  86169. values: IAccessorSparseValues;
  86170. }
  86171. /**
  86172. * A typed view into a bufferView. A bufferView contains raw binary data. An accessor provides a typed view into a bufferView or a subset of a bufferView similar to how WebGL's vertexAttribPointer() defines an attribute in a buffer
  86173. */
  86174. interface IAccessor extends IChildRootProperty {
  86175. /**
  86176. * The index of the bufferview
  86177. */
  86178. bufferView?: number;
  86179. /**
  86180. * The offset relative to the start of the bufferView in bytes
  86181. */
  86182. byteOffset?: number;
  86183. /**
  86184. * The datatype of components in the attribute
  86185. */
  86186. componentType: AccessorComponentType;
  86187. /**
  86188. * Specifies whether integer data values should be normalized
  86189. */
  86190. normalized?: boolean;
  86191. /**
  86192. * The number of attributes referenced by this accessor
  86193. */
  86194. count: number;
  86195. /**
  86196. * Specifies if the attribute is a scalar, vector, or matrix
  86197. */
  86198. type: AccessorType;
  86199. /**
  86200. * Maximum value of each component in this attribute
  86201. */
  86202. max?: number[];
  86203. /**
  86204. * Minimum value of each component in this attribute
  86205. */
  86206. min?: number[];
  86207. /**
  86208. * Sparse storage of attributes that deviate from their initialization value
  86209. */
  86210. sparse?: IAccessorSparse;
  86211. }
  86212. /**
  86213. * Targets an animation's sampler at a node's property
  86214. */
  86215. interface IAnimationChannel extends IProperty {
  86216. /**
  86217. * The index of a sampler in this animation used to compute the value for the target
  86218. */
  86219. sampler: number;
  86220. /**
  86221. * The index of the node and TRS property to target
  86222. */
  86223. target: IAnimationChannelTarget;
  86224. }
  86225. /**
  86226. * The index of the node and TRS property that an animation channel targets
  86227. */
  86228. interface IAnimationChannelTarget extends IProperty {
  86229. /**
  86230. * The index of the node to target
  86231. */
  86232. node: number;
  86233. /**
  86234. * The name of the node's TRS property to modify, or the weights of the Morph Targets it instantiates
  86235. */
  86236. path: AnimationChannelTargetPath;
  86237. }
  86238. /**
  86239. * Combines input and output accessors with an interpolation algorithm to define a keyframe graph (but not its target)
  86240. */
  86241. interface IAnimationSampler extends IProperty {
  86242. /**
  86243. * The index of an accessor containing keyframe input values, e.g., time
  86244. */
  86245. input: number;
  86246. /**
  86247. * Interpolation algorithm
  86248. */
  86249. interpolation?: AnimationSamplerInterpolation;
  86250. /**
  86251. * The index of an accessor, containing keyframe output values
  86252. */
  86253. output: number;
  86254. }
  86255. /**
  86256. * A keyframe animation
  86257. */
  86258. interface IAnimation extends IChildRootProperty {
  86259. /**
  86260. * An array of channels, each of which targets an animation's sampler at a node's property
  86261. */
  86262. channels: IAnimationChannel[];
  86263. /**
  86264. * An array of samplers that combines input and output accessors with an interpolation algorithm to define a keyframe graph (but not its target)
  86265. */
  86266. samplers: IAnimationSampler[];
  86267. }
  86268. /**
  86269. * Metadata about the glTF asset
  86270. */
  86271. interface IAsset extends IChildRootProperty {
  86272. /**
  86273. * A copyright message suitable for display to credit the content creator
  86274. */
  86275. copyright?: string;
  86276. /**
  86277. * Tool that generated this glTF model. Useful for debugging
  86278. */
  86279. generator?: string;
  86280. /**
  86281. * The glTF version that this asset targets
  86282. */
  86283. version: string;
  86284. /**
  86285. * The minimum glTF version that this asset targets
  86286. */
  86287. minVersion?: string;
  86288. }
  86289. /**
  86290. * A buffer points to binary geometry, animation, or skins
  86291. */
  86292. interface IBuffer extends IChildRootProperty {
  86293. /**
  86294. * The uri of the buffer. Relative paths are relative to the .gltf file. Instead of referencing an external file, the uri can also be a data-uri
  86295. */
  86296. uri?: string;
  86297. /**
  86298. * The length of the buffer in bytes
  86299. */
  86300. byteLength: number;
  86301. }
  86302. /**
  86303. * A view into a buffer generally representing a subset of the buffer
  86304. */
  86305. interface IBufferView extends IChildRootProperty {
  86306. /**
  86307. * The index of the buffer
  86308. */
  86309. buffer: number;
  86310. /**
  86311. * The offset into the buffer in bytes
  86312. */
  86313. byteOffset?: number;
  86314. /**
  86315. * The lenth of the bufferView in bytes
  86316. */
  86317. byteLength: number;
  86318. /**
  86319. * The stride, in bytes
  86320. */
  86321. byteStride?: number;
  86322. }
  86323. /**
  86324. * An orthographic camera containing properties to create an orthographic projection matrix
  86325. */
  86326. interface ICameraOrthographic extends IProperty {
  86327. /**
  86328. * The floating-point horizontal magnification of the view. Must not be zero
  86329. */
  86330. xmag: number;
  86331. /**
  86332. * The floating-point vertical magnification of the view. Must not be zero
  86333. */
  86334. ymag: number;
  86335. /**
  86336. * The floating-point distance to the far clipping plane. zfar must be greater than znear
  86337. */
  86338. zfar: number;
  86339. /**
  86340. * The floating-point distance to the near clipping plane
  86341. */
  86342. znear: number;
  86343. }
  86344. /**
  86345. * A perspective camera containing properties to create a perspective projection matrix
  86346. */
  86347. interface ICameraPerspective extends IProperty {
  86348. /**
  86349. * The floating-point aspect ratio of the field of view
  86350. */
  86351. aspectRatio?: number;
  86352. /**
  86353. * The floating-point vertical field of view in radians
  86354. */
  86355. yfov: number;
  86356. /**
  86357. * The floating-point distance to the far clipping plane
  86358. */
  86359. zfar?: number;
  86360. /**
  86361. * The floating-point distance to the near clipping plane
  86362. */
  86363. znear: number;
  86364. }
  86365. /**
  86366. * A camera's projection. A node can reference a camera to apply a transform to place the camera in the scene
  86367. */
  86368. interface ICamera extends IChildRootProperty {
  86369. /**
  86370. * An orthographic camera containing properties to create an orthographic projection matrix
  86371. */
  86372. orthographic?: ICameraOrthographic;
  86373. /**
  86374. * A perspective camera containing properties to create a perspective projection matrix
  86375. */
  86376. perspective?: ICameraPerspective;
  86377. /**
  86378. * Specifies if the camera uses a perspective or orthographic projection
  86379. */
  86380. type: CameraType;
  86381. }
  86382. /**
  86383. * Image data used to create a texture. Image can be referenced by URI or bufferView index. mimeType is required in the latter case
  86384. */
  86385. interface IImage extends IChildRootProperty {
  86386. /**
  86387. * The uri of the image. Relative paths are relative to the .gltf file. Instead of referencing an external file, the uri can also be a data-uri. The image format must be jpg or png
  86388. */
  86389. uri?: string;
  86390. /**
  86391. * The image's MIME type
  86392. */
  86393. mimeType?: ImageMimeType;
  86394. /**
  86395. * The index of the bufferView that contains the image. Use this instead of the image's uri property
  86396. */
  86397. bufferView?: number;
  86398. }
  86399. /**
  86400. * Material Normal Texture Info
  86401. */
  86402. interface IMaterialNormalTextureInfo extends ITextureInfo {
  86403. /**
  86404. * The scalar multiplier applied to each normal vector of the normal texture
  86405. */
  86406. scale?: number;
  86407. }
  86408. /**
  86409. * Material Occlusion Texture Info
  86410. */
  86411. interface IMaterialOcclusionTextureInfo extends ITextureInfo {
  86412. /**
  86413. * A scalar multiplier controlling the amount of occlusion applied
  86414. */
  86415. strength?: number;
  86416. }
  86417. /**
  86418. * A set of parameter values that are used to define the metallic-roughness material model from Physically-Based Rendering (PBR) methodology
  86419. */
  86420. interface IMaterialPbrMetallicRoughness {
  86421. /**
  86422. * The material's base color factor
  86423. */
  86424. baseColorFactor?: number[];
  86425. /**
  86426. * The base color texture
  86427. */
  86428. baseColorTexture?: ITextureInfo;
  86429. /**
  86430. * The metalness of the material
  86431. */
  86432. metallicFactor?: number;
  86433. /**
  86434. * The roughness of the material
  86435. */
  86436. roughnessFactor?: number;
  86437. /**
  86438. * The metallic-roughness texture
  86439. */
  86440. metallicRoughnessTexture?: ITextureInfo;
  86441. }
  86442. /**
  86443. * The material appearance of a primitive
  86444. */
  86445. interface IMaterial extends IChildRootProperty {
  86446. /**
  86447. * A set of parameter values that are used to define the metallic-roughness material model from Physically-Based Rendering (PBR) methodology. When not specified, all the default values of pbrMetallicRoughness apply
  86448. */
  86449. pbrMetallicRoughness?: IMaterialPbrMetallicRoughness;
  86450. /**
  86451. * The normal map texture
  86452. */
  86453. normalTexture?: IMaterialNormalTextureInfo;
  86454. /**
  86455. * The occlusion map texture
  86456. */
  86457. occlusionTexture?: IMaterialOcclusionTextureInfo;
  86458. /**
  86459. * The emissive map texture
  86460. */
  86461. emissiveTexture?: ITextureInfo;
  86462. /**
  86463. * The RGB components of the emissive color of the material. These values are linear. If an emissiveTexture is specified, this value is multiplied with the texel values
  86464. */
  86465. emissiveFactor?: number[];
  86466. /**
  86467. * The alpha rendering mode of the material
  86468. */
  86469. alphaMode?: MaterialAlphaMode;
  86470. /**
  86471. * The alpha cutoff value of the material
  86472. */
  86473. alphaCutoff?: number;
  86474. /**
  86475. * Specifies whether the material is double sided
  86476. */
  86477. doubleSided?: boolean;
  86478. }
  86479. /**
  86480. * Geometry to be rendered with the given material
  86481. */
  86482. interface IMeshPrimitive extends IProperty {
  86483. /**
  86484. * A dictionary object, where each key corresponds to mesh attribute semantic and each value is the index of the accessor containing attribute's data
  86485. */
  86486. attributes: {
  86487. [name: string]: number;
  86488. };
  86489. /**
  86490. * The index of the accessor that contains the indices
  86491. */
  86492. indices?: number;
  86493. /**
  86494. * The index of the material to apply to this primitive when rendering
  86495. */
  86496. material?: number;
  86497. /**
  86498. * The type of primitives to render. All valid values correspond to WebGL enums
  86499. */
  86500. mode?: MeshPrimitiveMode;
  86501. /**
  86502. * An array of Morph Targets, each Morph Target is a dictionary mapping attributes (only POSITION, NORMAL, and TANGENT supported) to their deviations in the Morph Target
  86503. */
  86504. targets?: {
  86505. [name: string]: number;
  86506. }[];
  86507. }
  86508. /**
  86509. * A set of primitives to be rendered. A node can contain one mesh. A node's transform places the mesh in the scene
  86510. */
  86511. interface IMesh extends IChildRootProperty {
  86512. /**
  86513. * An array of primitives, each defining geometry to be rendered with a material
  86514. */
  86515. primitives: IMeshPrimitive[];
  86516. /**
  86517. * Array of weights to be applied to the Morph Targets
  86518. */
  86519. weights?: number[];
  86520. }
  86521. /**
  86522. * A node in the node hierarchy
  86523. */
  86524. interface INode extends IChildRootProperty {
  86525. /**
  86526. * The index of the camera referenced by this node
  86527. */
  86528. camera?: number;
  86529. /**
  86530. * The indices of this node's children
  86531. */
  86532. children?: number[];
  86533. /**
  86534. * The index of the skin referenced by this node
  86535. */
  86536. skin?: number;
  86537. /**
  86538. * A floating-point 4x4 transformation matrix stored in column-major order
  86539. */
  86540. matrix?: number[];
  86541. /**
  86542. * The index of the mesh in this node
  86543. */
  86544. mesh?: number;
  86545. /**
  86546. * The node's unit quaternion rotation in the order (x, y, z, w), where w is the scalar
  86547. */
  86548. rotation?: number[];
  86549. /**
  86550. * The node's non-uniform scale, given as the scaling factors along the x, y, and z axes
  86551. */
  86552. scale?: number[];
  86553. /**
  86554. * The node's translation along the x, y, and z axes
  86555. */
  86556. translation?: number[];
  86557. /**
  86558. * The weights of the instantiated Morph Target. Number of elements must match number of Morph Targets of used mesh
  86559. */
  86560. weights?: number[];
  86561. }
  86562. /**
  86563. * Texture sampler properties for filtering and wrapping modes
  86564. */
  86565. interface ISampler extends IChildRootProperty {
  86566. /**
  86567. * Magnification filter. Valid values correspond to WebGL enums: 9728 (NEAREST) and 9729 (LINEAR)
  86568. */
  86569. magFilter?: TextureMagFilter;
  86570. /**
  86571. * Minification filter. All valid values correspond to WebGL enums
  86572. */
  86573. minFilter?: TextureMinFilter;
  86574. /**
  86575. * S (U) wrapping mode. All valid values correspond to WebGL enums
  86576. */
  86577. wrapS?: TextureWrapMode;
  86578. /**
  86579. * T (V) wrapping mode. All valid values correspond to WebGL enums
  86580. */
  86581. wrapT?: TextureWrapMode;
  86582. }
  86583. /**
  86584. * The root nodes of a scene
  86585. */
  86586. interface IScene extends IChildRootProperty {
  86587. /**
  86588. * The indices of each root node
  86589. */
  86590. nodes: number[];
  86591. }
  86592. /**
  86593. * Joints and matrices defining a skin
  86594. */
  86595. interface ISkin extends IChildRootProperty {
  86596. /**
  86597. * The index of the accessor containing the floating-point 4x4 inverse-bind matrices. The default is that each matrix is a 4x4 identity matrix, which implies that inverse-bind matrices were pre-applied
  86598. */
  86599. inverseBindMatrices?: number;
  86600. /**
  86601. * The index of the node used as a skeleton root. When undefined, joints transforms resolve to scene root
  86602. */
  86603. skeleton?: number;
  86604. /**
  86605. * Indices of skeleton nodes, used as joints in this skin. The array length must be the same as the count property of the inverseBindMatrices accessor (when defined)
  86606. */
  86607. joints: number[];
  86608. }
  86609. /**
  86610. * A texture and its sampler
  86611. */
  86612. interface ITexture extends IChildRootProperty {
  86613. /**
  86614. * The index of the sampler used by this texture. When undefined, a sampler with repeat wrapping and auto filtering should be used
  86615. */
  86616. sampler?: number;
  86617. /**
  86618. * The index of the image used by this texture
  86619. */
  86620. source: number;
  86621. }
  86622. /**
  86623. * Reference to a texture
  86624. */
  86625. interface ITextureInfo extends IProperty {
  86626. /**
  86627. * The index of the texture
  86628. */
  86629. index: number;
  86630. /**
  86631. * The set index of texture's TEXCOORD attribute used for texture coordinate mapping
  86632. */
  86633. texCoord?: number;
  86634. }
  86635. /**
  86636. * The root object for a glTF asset
  86637. */
  86638. interface IGLTF extends IProperty {
  86639. /**
  86640. * An array of accessors. An accessor is a typed view into a bufferView
  86641. */
  86642. accessors?: IAccessor[];
  86643. /**
  86644. * An array of keyframe animations
  86645. */
  86646. animations?: IAnimation[];
  86647. /**
  86648. * Metadata about the glTF asset
  86649. */
  86650. asset: IAsset;
  86651. /**
  86652. * An array of buffers. A buffer points to binary geometry, animation, or skins
  86653. */
  86654. buffers?: IBuffer[];
  86655. /**
  86656. * An array of bufferViews. A bufferView is a view into a buffer generally representing a subset of the buffer
  86657. */
  86658. bufferViews?: IBufferView[];
  86659. /**
  86660. * An array of cameras
  86661. */
  86662. cameras?: ICamera[];
  86663. /**
  86664. * Names of glTF extensions used somewhere in this asset
  86665. */
  86666. extensionsUsed?: string[];
  86667. /**
  86668. * Names of glTF extensions required to properly load this asset
  86669. */
  86670. extensionsRequired?: string[];
  86671. /**
  86672. * An array of images. An image defines data used to create a texture
  86673. */
  86674. images?: IImage[];
  86675. /**
  86676. * An array of materials. A material defines the appearance of a primitive
  86677. */
  86678. materials?: IMaterial[];
  86679. /**
  86680. * An array of meshes. A mesh is a set of primitives to be rendered
  86681. */
  86682. meshes?: IMesh[];
  86683. /**
  86684. * An array of nodes
  86685. */
  86686. nodes?: INode[];
  86687. /**
  86688. * An array of samplers. A sampler contains properties for texture filtering and wrapping modes
  86689. */
  86690. samplers?: ISampler[];
  86691. /**
  86692. * The index of the default scene
  86693. */
  86694. scene?: number;
  86695. /**
  86696. * An array of scenes
  86697. */
  86698. scenes?: IScene[];
  86699. /**
  86700. * An array of skins. A skin is defined by joints and matrices
  86701. */
  86702. skins?: ISkin[];
  86703. /**
  86704. * An array of textures
  86705. */
  86706. textures?: ITexture[];
  86707. }
  86708. /**
  86709. * The glTF validation results
  86710. * @ignore
  86711. */
  86712. interface IGLTFValidationResults {
  86713. info: {
  86714. generator: string;
  86715. hasAnimations: boolean;
  86716. hasDefaultScene: boolean;
  86717. hasMaterials: boolean;
  86718. hasMorphTargets: boolean;
  86719. hasSkins: boolean;
  86720. hasTextures: boolean;
  86721. maxAttributesUsed: number;
  86722. primitivesCount: number
  86723. };
  86724. issues: {
  86725. messages: Array<string>;
  86726. numErrors: number;
  86727. numHints: number;
  86728. numInfos: number;
  86729. numWarnings: number;
  86730. truncated: boolean
  86731. };
  86732. mimeType: string;
  86733. uri: string;
  86734. validatedAt: string;
  86735. validatorVersion: string;
  86736. }
  86737. /**
  86738. * The glTF validation options
  86739. */
  86740. interface IGLTFValidationOptions {
  86741. /** Uri to use */
  86742. uri?: string;
  86743. /** Function used to load external resources */
  86744. externalResourceFunction?: (uri: string) => Promise<Uint8Array>;
  86745. /** Boolean indicating that we need to validate accessor data */
  86746. validateAccessorData?: boolean;
  86747. /** max number of issues allowed */
  86748. maxIssues?: number;
  86749. /** Ignored issues */
  86750. ignoredIssues?: Array<string>;
  86751. /** Value to override severy settings */
  86752. severityOverrides?: Object;
  86753. }
  86754. /**
  86755. * The glTF validator object
  86756. * @ignore
  86757. */
  86758. interface IGLTFValidator {
  86759. validateBytes: (data: Uint8Array, options?: IGLTFValidationOptions) => Promise<IGLTFValidationResults>;
  86760. validateString: (json: string, options?: IGLTFValidationOptions) => Promise<IGLTFValidationResults>;
  86761. }
  86762. /**
  86763. * Interfaces from the EXT_lights_image_based extension
  86764. */
  86765. /** @hidden */
  86766. interface IEXTLightsImageBased_LightReferenceImageBased {
  86767. light: number;
  86768. }
  86769. /** @hidden */
  86770. interface IEXTLightsImageBased_LightImageBased extends IChildRootProperty {
  86771. intensity: number;
  86772. rotation: number[];
  86773. specularImageSize: number;
  86774. specularImages: number[][];
  86775. irradianceCoefficients: number[][];
  86776. }
  86777. /** @hidden */
  86778. interface IEXTLightsImageBased {
  86779. lights: IEXTLightsImageBased_LightImageBased[];
  86780. }
  86781. /**
  86782. * Interfaces from the EXT_mesh_gpu_instancing extension
  86783. * !!! Experimental Extension Subject to Changes !!!
  86784. */
  86785. /** @hidden */
  86786. interface IEXTMeshGpuInstancing {
  86787. mesh?: number;
  86788. attributes: { [name: string]: number };
  86789. }
  86790. /**
  86791. * Interfaces from the KHR_draco_mesh_compression extension
  86792. */
  86793. /** @hidden */
  86794. interface IKHRDracoMeshCompression {
  86795. bufferView: number;
  86796. attributes: { [name: string]: number };
  86797. }
  86798. /**
  86799. * Interfaces from the KHR_lights_punctual extension
  86800. */
  86801. /** @hidden */
  86802. const enum IKHRLightsPunctual_LightType {
  86803. DIRECTIONAL = "directional",
  86804. POINT = "point",
  86805. SPOT = "spot"
  86806. }
  86807. /** @hidden */
  86808. interface IKHRLightsPunctual_LightReference {
  86809. light: number;
  86810. }
  86811. /** @hidden */
  86812. interface IKHRLightsPunctual_Light extends IChildRootProperty {
  86813. type: IKHRLightsPunctual_LightType;
  86814. color?: number[];
  86815. intensity?: number;
  86816. range?: number;
  86817. spot?: {
  86818. innerConeAngle?: number;
  86819. outerConeAngle?: number;
  86820. };
  86821. }
  86822. /** @hidden */
  86823. interface IKHRLightsPunctual {
  86824. lights: IKHRLightsPunctual_Light[];
  86825. }
  86826. /**
  86827. * Interfaces from the KHR_materials_clearcoat extension
  86828. * !!! Experimental Extension Subject to Changes !!!
  86829. */
  86830. /** @hidden */
  86831. interface IKHRMaterialsClearcoat {
  86832. clearcoatFactor: number;
  86833. clearcoatTexture: ITextureInfo;
  86834. clearcoatRoughnessFactor: number;
  86835. clearcoatRoughnessTexture: ITextureInfo;
  86836. clearcoatNormalTexture: IMaterialNormalTextureInfo;
  86837. }
  86838. /**
  86839. * Interfaces from the KHR_materials_ior extension
  86840. * !!! Experimental Extension Subject to Changes !!!
  86841. */
  86842. /** @hidden */
  86843. interface IKHRMaterialsIor {
  86844. ior: number;
  86845. }
  86846. /**
  86847. * Interfaces from the KHR_materials_pbrSpecularGlossiness extension
  86848. */
  86849. /** @hidden */
  86850. interface IKHRMaterialsPbrSpecularGlossiness {
  86851. diffuseFactor: number[];
  86852. diffuseTexture: ITextureInfo;
  86853. specularFactor: number[];
  86854. glossinessFactor: number;
  86855. specularGlossinessTexture: ITextureInfo;
  86856. }
  86857. /**
  86858. * Interfaces from the KHR_materials_sheen extension
  86859. * !!! Experimental Extension Subject to Changes !!!
  86860. */
  86861. /** @hidden */
  86862. interface IKHRMaterialsSheen {
  86863. sheenColorFactor?: number[];
  86864. sheenColorTexture?: ITextureInfo;
  86865. sheenRoughnessFactor?: number;
  86866. sheenRoughnessTexture?: ITextureInfo;
  86867. }
  86868. /**
  86869. * Interfaces from the KHR_materials_specular extension
  86870. * !!! Experimental Extension Subject to Changes !!!
  86871. */
  86872. /** @hidden */
  86873. interface IKHRMaterialsSpecular {
  86874. specularFactor: number;
  86875. specularColorFactor: number[];
  86876. specularTexture: ITextureInfo;
  86877. }
  86878. /**
  86879. * Interfaces from the KHR_materials_transmission extension
  86880. * !!! Experimental Extension Subject to Changes !!!
  86881. */
  86882. /** @hidden */
  86883. interface IKHRMaterialsTransmission {
  86884. transmissionFactor?: number;
  86885. transmissionTexture?: ITextureInfo;
  86886. }
  86887. /**
  86888. * Interfaces from the KHR_materials_translucency extension
  86889. * !!! Experimental Extension Subject to Changes !!!
  86890. */
  86891. /** @hidden */
  86892. interface IKHRMaterialsTranslucency {
  86893. translucencyFactor?: number;
  86894. translucencyTexture?: ITextureInfo;
  86895. }
  86896. /**
  86897. * Interfaces from the KHR_materials_variants extension
  86898. * !!! Experimental Extension Subject to Changes !!!
  86899. */
  86900. /** @hidden */
  86901. interface IKHRMaterialVariants_Mapping extends IProperty {
  86902. mappings: Array<{
  86903. variants: number[];
  86904. material: number;
  86905. }>;
  86906. }
  86907. /** @hidden */
  86908. interface IKHRMaterialVariants_Variant extends IProperty {
  86909. name: string;
  86910. }
  86911. /** @hidden */
  86912. interface IKHRMaterialVariants_Variants extends IChildRootProperty {
  86913. variants: Array<IKHRMaterialVariants_Variant>;
  86914. }
  86915. /**
  86916. * Interfaces from the KHR_texture_basisu extension
  86917. * !!! Experimental Extension Subject to Changes !!!
  86918. */
  86919. /** @hidden */
  86920. interface IKHRTextureBasisU {
  86921. source: number;
  86922. }
  86923. /**
  86924. * Interfaces from the EXT_texture_webp extension
  86925. */
  86926. /** @hidden */
  86927. interface IEXTTextureWebP {
  86928. source: number;
  86929. }
  86930. /**
  86931. * Interfaces from the KHR_texture_transform extension
  86932. */
  86933. /** @hidden */
  86934. interface IKHRTextureTransform {
  86935. offset?: number[];
  86936. rotation?: number;
  86937. scale?: number[];
  86938. texCoord?: number;
  86939. }
  86940. /**
  86941. * Interfaces from the KHR_xmp extension
  86942. * !!! Experimental Extension Subject to Changes !!!
  86943. */
  86944. /** @hidden */
  86945. interface IKHRXmp_Data {
  86946. [key: string]: unknown;
  86947. }
  86948. /** @hidden */
  86949. interface IKHRXmp_Gltf {
  86950. packets: IKHRXmp_Data[];
  86951. }
  86952. /** @hidden */
  86953. interface IKHRXmp_Node {
  86954. packet: number;
  86955. }
  86956. /**
  86957. * Interfaces from the MSFT_audio_emitter extension
  86958. */
  86959. /** @hidden */
  86960. interface IMSFTAudioEmitter_ClipReference {
  86961. clip: number;
  86962. weight?: number;
  86963. }
  86964. /** @hidden */
  86965. interface IMSFTAudioEmitter_EmittersReference {
  86966. emitters: number[];
  86967. }
  86968. /** @hidden */
  86969. const enum IMSFTAudioEmitter_DistanceModel {
  86970. linear = "linear",
  86971. inverse = "inverse",
  86972. exponential = "exponential",
  86973. }
  86974. /** @hidden */
  86975. interface IMSFTAudioEmitter_Emitter {
  86976. name?: string;
  86977. distanceModel?: IMSFTAudioEmitter_DistanceModel;
  86978. refDistance?: number;
  86979. maxDistance?: number;
  86980. rolloffFactor?: number;
  86981. innerAngle?: number;
  86982. outerAngle?: number;
  86983. loop?: boolean;
  86984. volume?: number;
  86985. clips: IMSFTAudioEmitter_ClipReference[];
  86986. }
  86987. /** @hidden */
  86988. const enum IMSFTAudioEmitter_AudioMimeType {
  86989. WAV = "audio/wav",
  86990. }
  86991. /** @hidden */
  86992. interface IMSFTAudioEmitter_Clip extends IProperty {
  86993. uri?: string;
  86994. bufferView?: number;
  86995. mimeType?: IMSFTAudioEmitter_AudioMimeType;
  86996. }
  86997. /** @hidden */
  86998. const enum IMSFTAudioEmitter_AnimationEventAction {
  86999. play = "play",
  87000. pause = "pause",
  87001. stop = "stop",
  87002. }
  87003. /** @hidden */
  87004. interface IMSFTAudioEmitter_AnimationEvent {
  87005. action: IMSFTAudioEmitter_AnimationEventAction;
  87006. emitter: number;
  87007. time: number;
  87008. startOffset?: number;
  87009. }
  87010. /**
  87011. * Interfaces from the MSFT_lod extension
  87012. */
  87013. /** @hidden */
  87014. interface IMSFTLOD {
  87015. ids: number[];
  87016. }
  87017. }
  87018. declare module BABYLON {
  87019. /** @hidden */
  87020. export var cellPixelShader: {
  87021. name: string;
  87022. shader: string;
  87023. };
  87024. }
  87025. declare module BABYLON {
  87026. /** @hidden */
  87027. export var cellVertexShader: {
  87028. name: string;
  87029. shader: string;
  87030. };
  87031. }
  87032. declare module BABYLON {
  87033. export class CellMaterial extends BABYLON.PushMaterial {
  87034. private _diffuseTexture;
  87035. diffuseTexture: BABYLON.BaseTexture;
  87036. diffuseColor: BABYLON.Color3;
  87037. _computeHighLevel: boolean;
  87038. computeHighLevel: boolean;
  87039. private _disableLighting;
  87040. disableLighting: boolean;
  87041. private _maxSimultaneousLights;
  87042. maxSimultaneousLights: number;
  87043. constructor(name: string, scene: BABYLON.Scene);
  87044. needAlphaBlending(): boolean;
  87045. needAlphaTesting(): boolean;
  87046. getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
  87047. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  87048. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  87049. getAnimatables(): BABYLON.IAnimatable[];
  87050. getActiveTextures(): BABYLON.BaseTexture[];
  87051. hasTexture(texture: BABYLON.BaseTexture): boolean;
  87052. dispose(forceDisposeEffect?: boolean): void;
  87053. getClassName(): string;
  87054. clone(name: string): CellMaterial;
  87055. serialize(): any;
  87056. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): CellMaterial;
  87057. }
  87058. }
  87059. declare module BABYLON {
  87060. export class CustomShaderStructure {
  87061. FragmentStore: string;
  87062. VertexStore: string;
  87063. constructor();
  87064. }
  87065. export class ShaderSpecialParts {
  87066. constructor();
  87067. Fragment_Begin: string;
  87068. Fragment_Definitions: string;
  87069. Fragment_MainBegin: string;
  87070. Fragment_Custom_Diffuse: string;
  87071. Fragment_Before_Lights: string;
  87072. Fragment_Before_Fog: string;
  87073. Fragment_Custom_Alpha: string;
  87074. Fragment_Before_FragColor: string;
  87075. Vertex_Begin: string;
  87076. Vertex_Definitions: string;
  87077. Vertex_MainBegin: string;
  87078. Vertex_Before_PositionUpdated: string;
  87079. Vertex_Before_NormalUpdated: string;
  87080. Vertex_After_WorldPosComputed: string;
  87081. Vertex_MainEnd: string;
  87082. }
  87083. export class CustomMaterial extends BABYLON.StandardMaterial {
  87084. static ShaderIndexer: number;
  87085. CustomParts: ShaderSpecialParts;
  87086. _isCreatedShader: boolean;
  87087. _createdShaderName: string;
  87088. _customUniform: string[];
  87089. _newUniforms: string[];
  87090. _newUniformInstances: {
  87091. [name: string]: any;
  87092. };
  87093. _newSamplerInstances: {
  87094. [name: string]: BABYLON.Texture;
  87095. };
  87096. _customAttributes: string[];
  87097. FragmentShader: string;
  87098. VertexShader: string;
  87099. AttachAfterBind(mesh: BABYLON.Mesh, effect: BABYLON.Effect): void;
  87100. ReviewUniform(name: string, arr: string[]): string[];
  87101. Builder(shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: BABYLON.MaterialDefines | string[], attributes?: string[]): string;
  87102. constructor(name: string, scene: BABYLON.Scene);
  87103. AddUniform(name: string, kind: string, param: any): CustomMaterial;
  87104. AddAttribute(name: string): CustomMaterial;
  87105. Fragment_Begin(shaderPart: string): CustomMaterial;
  87106. Fragment_Definitions(shaderPart: string): CustomMaterial;
  87107. Fragment_MainBegin(shaderPart: string): CustomMaterial;
  87108. Fragment_Custom_Diffuse(shaderPart: string): CustomMaterial;
  87109. Fragment_Custom_Alpha(shaderPart: string): CustomMaterial;
  87110. Fragment_Before_Lights(shaderPart: string): CustomMaterial;
  87111. Fragment_Before_Fog(shaderPart: string): CustomMaterial;
  87112. Fragment_Before_FragColor(shaderPart: string): CustomMaterial;
  87113. Vertex_Begin(shaderPart: string): CustomMaterial;
  87114. Vertex_Definitions(shaderPart: string): CustomMaterial;
  87115. Vertex_MainBegin(shaderPart: string): CustomMaterial;
  87116. Vertex_Before_PositionUpdated(shaderPart: string): CustomMaterial;
  87117. Vertex_Before_NormalUpdated(shaderPart: string): CustomMaterial;
  87118. Vertex_After_WorldPosComputed(shaderPart: string): CustomMaterial;
  87119. Vertex_MainEnd(shaderPart: string): CustomMaterial;
  87120. }
  87121. }
  87122. declare module BABYLON {
  87123. export class ShaderAlebdoParts {
  87124. constructor();
  87125. Fragment_Begin: string;
  87126. Fragment_Definitions: string;
  87127. Fragment_MainBegin: string;
  87128. Fragment_Custom_Albedo: string;
  87129. Fragment_Before_Lights: string;
  87130. Fragment_Custom_MetallicRoughness: string;
  87131. Fragment_Custom_MicroSurface: string;
  87132. Fragment_Before_Fog: string;
  87133. Fragment_Custom_Alpha: string;
  87134. Fragment_Before_FragColor: string;
  87135. Vertex_Begin: string;
  87136. Vertex_Definitions: string;
  87137. Vertex_MainBegin: string;
  87138. Vertex_Before_PositionUpdated: string;
  87139. Vertex_Before_NormalUpdated: string;
  87140. Vertex_After_WorldPosComputed: string;
  87141. Vertex_MainEnd: string;
  87142. }
  87143. export class PBRCustomMaterial extends BABYLON.PBRMaterial {
  87144. static ShaderIndexer: number;
  87145. CustomParts: ShaderAlebdoParts;
  87146. _isCreatedShader: boolean;
  87147. _createdShaderName: string;
  87148. _customUniform: string[];
  87149. _newUniforms: string[];
  87150. _newUniformInstances: {
  87151. [name: string]: any;
  87152. };
  87153. _newSamplerInstances: {
  87154. [name: string]: BABYLON.Texture;
  87155. };
  87156. _customAttributes: string[];
  87157. FragmentShader: string;
  87158. VertexShader: string;
  87159. AttachAfterBind(mesh: BABYLON.Mesh, effect: BABYLON.Effect): void;
  87160. ReviewUniform(name: string, arr: string[]): string[];
  87161. Builder(shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: BABYLON.MaterialDefines | string[], attributes?: string[]): string;
  87162. constructor(name: string, scene: BABYLON.Scene);
  87163. AddUniform(name: string, kind: string, param: any): PBRCustomMaterial;
  87164. AddAttribute(name: string): PBRCustomMaterial;
  87165. Fragment_Begin(shaderPart: string): PBRCustomMaterial;
  87166. Fragment_Definitions(shaderPart: string): PBRCustomMaterial;
  87167. Fragment_MainBegin(shaderPart: string): PBRCustomMaterial;
  87168. Fragment_Custom_Albedo(shaderPart: string): PBRCustomMaterial;
  87169. Fragment_Custom_Alpha(shaderPart: string): PBRCustomMaterial;
  87170. Fragment_Before_Lights(shaderPart: string): PBRCustomMaterial;
  87171. Fragment_Custom_MetallicRoughness(shaderPart: string): PBRCustomMaterial;
  87172. Fragment_Custom_MicroSurface(shaderPart: string): PBRCustomMaterial;
  87173. Fragment_Before_Fog(shaderPart: string): PBRCustomMaterial;
  87174. Fragment_Before_FragColor(shaderPart: string): PBRCustomMaterial;
  87175. Vertex_Begin(shaderPart: string): PBRCustomMaterial;
  87176. Vertex_Definitions(shaderPart: string): PBRCustomMaterial;
  87177. Vertex_MainBegin(shaderPart: string): PBRCustomMaterial;
  87178. Vertex_Before_PositionUpdated(shaderPart: string): PBRCustomMaterial;
  87179. Vertex_Before_NormalUpdated(shaderPart: string): PBRCustomMaterial;
  87180. Vertex_After_WorldPosComputed(shaderPart: string): PBRCustomMaterial;
  87181. Vertex_MainEnd(shaderPart: string): PBRCustomMaterial;
  87182. }
  87183. }
  87184. declare module BABYLON {
  87185. /** @hidden */
  87186. export var firePixelShader: {
  87187. name: string;
  87188. shader: string;
  87189. };
  87190. }
  87191. declare module BABYLON {
  87192. /** @hidden */
  87193. export var fireVertexShader: {
  87194. name: string;
  87195. shader: string;
  87196. };
  87197. }
  87198. declare module BABYLON {
  87199. export class FireMaterial extends BABYLON.PushMaterial {
  87200. private _diffuseTexture;
  87201. diffuseTexture: BABYLON.Nullable<BABYLON.BaseTexture>;
  87202. private _distortionTexture;
  87203. distortionTexture: BABYLON.Nullable<BABYLON.BaseTexture>;
  87204. private _opacityTexture;
  87205. opacityTexture: BABYLON.Nullable<BABYLON.BaseTexture>;
  87206. diffuseColor: BABYLON.Color3;
  87207. speed: number;
  87208. private _scaledDiffuse;
  87209. private _lastTime;
  87210. constructor(name: string, scene: BABYLON.Scene);
  87211. needAlphaBlending(): boolean;
  87212. needAlphaTesting(): boolean;
  87213. getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
  87214. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  87215. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  87216. getAnimatables(): BABYLON.IAnimatable[];
  87217. getActiveTextures(): BABYLON.BaseTexture[];
  87218. hasTexture(texture: BABYLON.BaseTexture): boolean;
  87219. getClassName(): string;
  87220. dispose(forceDisposeEffect?: boolean): void;
  87221. clone(name: string): FireMaterial;
  87222. serialize(): any;
  87223. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): FireMaterial;
  87224. }
  87225. }
  87226. declare module BABYLON {
  87227. /** @hidden */
  87228. export var furPixelShader: {
  87229. name: string;
  87230. shader: string;
  87231. };
  87232. }
  87233. declare module BABYLON {
  87234. /** @hidden */
  87235. export var furVertexShader: {
  87236. name: string;
  87237. shader: string;
  87238. };
  87239. }
  87240. declare module BABYLON {
  87241. export class FurMaterial extends BABYLON.PushMaterial {
  87242. private _diffuseTexture;
  87243. diffuseTexture: BABYLON.BaseTexture;
  87244. private _heightTexture;
  87245. heightTexture: BABYLON.BaseTexture;
  87246. diffuseColor: BABYLON.Color3;
  87247. furLength: number;
  87248. furAngle: number;
  87249. furColor: BABYLON.Color3;
  87250. furOffset: number;
  87251. furSpacing: number;
  87252. furGravity: BABYLON.Vector3;
  87253. furSpeed: number;
  87254. furDensity: number;
  87255. furOcclusion: number;
  87256. furTexture: BABYLON.DynamicTexture;
  87257. private _disableLighting;
  87258. disableLighting: boolean;
  87259. private _maxSimultaneousLights;
  87260. maxSimultaneousLights: number;
  87261. highLevelFur: boolean;
  87262. _meshes: BABYLON.AbstractMesh[];
  87263. private _furTime;
  87264. constructor(name: string, scene: BABYLON.Scene);
  87265. get furTime(): number;
  87266. set furTime(furTime: number);
  87267. needAlphaBlending(): boolean;
  87268. needAlphaTesting(): boolean;
  87269. getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
  87270. updateFur(): void;
  87271. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  87272. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  87273. getAnimatables(): BABYLON.IAnimatable[];
  87274. getActiveTextures(): BABYLON.BaseTexture[];
  87275. hasTexture(texture: BABYLON.BaseTexture): boolean;
  87276. dispose(forceDisposeEffect?: boolean): void;
  87277. clone(name: string): FurMaterial;
  87278. serialize(): any;
  87279. getClassName(): string;
  87280. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): FurMaterial;
  87281. static GenerateTexture(name: string, scene: BABYLON.Scene): BABYLON.DynamicTexture;
  87282. static FurifyMesh(sourceMesh: BABYLON.Mesh, quality: number): BABYLON.Mesh[];
  87283. }
  87284. }
  87285. declare module BABYLON {
  87286. /** @hidden */
  87287. export var gradientPixelShader: {
  87288. name: string;
  87289. shader: string;
  87290. };
  87291. }
  87292. declare module BABYLON {
  87293. /** @hidden */
  87294. export var gradientVertexShader: {
  87295. name: string;
  87296. shader: string;
  87297. };
  87298. }
  87299. declare module BABYLON {
  87300. export class GradientMaterial extends BABYLON.PushMaterial {
  87301. private _maxSimultaneousLights;
  87302. maxSimultaneousLights: number;
  87303. topColor: BABYLON.Color3;
  87304. topColorAlpha: number;
  87305. bottomColor: BABYLON.Color3;
  87306. bottomColorAlpha: number;
  87307. offset: number;
  87308. scale: number;
  87309. smoothness: number;
  87310. private _disableLighting;
  87311. disableLighting: boolean;
  87312. constructor(name: string, scene: BABYLON.Scene);
  87313. needAlphaBlending(): boolean;
  87314. needAlphaTesting(): boolean;
  87315. getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
  87316. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  87317. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  87318. getAnimatables(): BABYLON.IAnimatable[];
  87319. dispose(forceDisposeEffect?: boolean): void;
  87320. clone(name: string): GradientMaterial;
  87321. serialize(): any;
  87322. getClassName(): string;
  87323. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): GradientMaterial;
  87324. }
  87325. }
  87326. declare module BABYLON {
  87327. /** @hidden */
  87328. export var gridPixelShader: {
  87329. name: string;
  87330. shader: string;
  87331. };
  87332. }
  87333. declare module BABYLON {
  87334. /** @hidden */
  87335. export var gridVertexShader: {
  87336. name: string;
  87337. shader: string;
  87338. };
  87339. }
  87340. declare module BABYLON {
  87341. /**
  87342. * The grid materials allows you to wrap any shape with a grid.
  87343. * Colors are customizable.
  87344. */
  87345. export class GridMaterial extends BABYLON.PushMaterial {
  87346. /**
  87347. * Main color of the grid (e.g. between lines)
  87348. */
  87349. mainColor: BABYLON.Color3;
  87350. /**
  87351. * Color of the grid lines.
  87352. */
  87353. lineColor: BABYLON.Color3;
  87354. /**
  87355. * The scale of the grid compared to unit.
  87356. */
  87357. gridRatio: number;
  87358. /**
  87359. * Allows setting an offset for the grid lines.
  87360. */
  87361. gridOffset: BABYLON.Vector3;
  87362. /**
  87363. * The frequency of thicker lines.
  87364. */
  87365. majorUnitFrequency: number;
  87366. /**
  87367. * The visibility of minor units in the grid.
  87368. */
  87369. minorUnitVisibility: number;
  87370. /**
  87371. * The grid opacity outside of the lines.
  87372. */
  87373. opacity: number;
  87374. /**
  87375. * Determine RBG output is premultiplied by alpha value.
  87376. */
  87377. preMultiplyAlpha: boolean;
  87378. private _opacityTexture;
  87379. opacityTexture: BABYLON.BaseTexture;
  87380. private _gridControl;
  87381. /**
  87382. * constructor
  87383. * @param name The name given to the material in order to identify it afterwards.
  87384. * @param scene The scene the material is used in.
  87385. */
  87386. constructor(name: string, scene: BABYLON.Scene);
  87387. /**
  87388. * Returns wehter or not the grid requires alpha blending.
  87389. */
  87390. needAlphaBlending(): boolean;
  87391. needAlphaBlendingForMesh(mesh: BABYLON.AbstractMesh): boolean;
  87392. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  87393. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  87394. /**
  87395. * Dispose the material and its associated resources.
  87396. * @param forceDisposeEffect will also dispose the used effect when true
  87397. */
  87398. dispose(forceDisposeEffect?: boolean): void;
  87399. clone(name: string): GridMaterial;
  87400. serialize(): any;
  87401. getClassName(): string;
  87402. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): GridMaterial;
  87403. }
  87404. }
  87405. declare module BABYLON {
  87406. /** @hidden */
  87407. export var lavaPixelShader: {
  87408. name: string;
  87409. shader: string;
  87410. };
  87411. }
  87412. declare module BABYLON {
  87413. /** @hidden */
  87414. export var lavaVertexShader: {
  87415. name: string;
  87416. shader: string;
  87417. };
  87418. }
  87419. declare module BABYLON {
  87420. export class LavaMaterial extends BABYLON.PushMaterial {
  87421. private _diffuseTexture;
  87422. diffuseTexture: BABYLON.BaseTexture;
  87423. noiseTexture: BABYLON.BaseTexture;
  87424. fogColor: BABYLON.Color3;
  87425. speed: number;
  87426. movingSpeed: number;
  87427. lowFrequencySpeed: number;
  87428. fogDensity: number;
  87429. private _lastTime;
  87430. diffuseColor: BABYLON.Color3;
  87431. private _disableLighting;
  87432. disableLighting: boolean;
  87433. private _unlit;
  87434. unlit: boolean;
  87435. private _maxSimultaneousLights;
  87436. maxSimultaneousLights: number;
  87437. private _scaledDiffuse;
  87438. constructor(name: string, scene: BABYLON.Scene);
  87439. needAlphaBlending(): boolean;
  87440. needAlphaTesting(): boolean;
  87441. getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
  87442. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  87443. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  87444. getAnimatables(): BABYLON.IAnimatable[];
  87445. getActiveTextures(): BABYLON.BaseTexture[];
  87446. hasTexture(texture: BABYLON.BaseTexture): boolean;
  87447. dispose(forceDisposeEffect?: boolean): void;
  87448. clone(name: string): LavaMaterial;
  87449. serialize(): any;
  87450. getClassName(): string;
  87451. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): LavaMaterial;
  87452. }
  87453. }
  87454. declare module BABYLON {
  87455. /** @hidden */
  87456. export var mixPixelShader: {
  87457. name: string;
  87458. shader: string;
  87459. };
  87460. }
  87461. declare module BABYLON {
  87462. /** @hidden */
  87463. export var mixVertexShader: {
  87464. name: string;
  87465. shader: string;
  87466. };
  87467. }
  87468. declare module BABYLON {
  87469. export class MixMaterial extends BABYLON.PushMaterial {
  87470. /**
  87471. * Mix textures
  87472. */
  87473. private _mixTexture1;
  87474. mixTexture1: BABYLON.BaseTexture;
  87475. private _mixTexture2;
  87476. mixTexture2: BABYLON.BaseTexture;
  87477. /**
  87478. * Diffuse textures
  87479. */
  87480. private _diffuseTexture1;
  87481. diffuseTexture1: BABYLON.Texture;
  87482. private _diffuseTexture2;
  87483. diffuseTexture2: BABYLON.Texture;
  87484. private _diffuseTexture3;
  87485. diffuseTexture3: BABYLON.Texture;
  87486. private _diffuseTexture4;
  87487. diffuseTexture4: BABYLON.Texture;
  87488. private _diffuseTexture5;
  87489. diffuseTexture5: BABYLON.Texture;
  87490. private _diffuseTexture6;
  87491. diffuseTexture6: BABYLON.Texture;
  87492. private _diffuseTexture7;
  87493. diffuseTexture7: BABYLON.Texture;
  87494. private _diffuseTexture8;
  87495. diffuseTexture8: BABYLON.Texture;
  87496. /**
  87497. * Uniforms
  87498. */
  87499. diffuseColor: BABYLON.Color3;
  87500. specularColor: BABYLON.Color3;
  87501. specularPower: number;
  87502. private _disableLighting;
  87503. disableLighting: boolean;
  87504. private _maxSimultaneousLights;
  87505. maxSimultaneousLights: number;
  87506. constructor(name: string, scene: BABYLON.Scene);
  87507. needAlphaBlending(): boolean;
  87508. needAlphaTesting(): boolean;
  87509. getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
  87510. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  87511. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  87512. getAnimatables(): BABYLON.IAnimatable[];
  87513. getActiveTextures(): BABYLON.BaseTexture[];
  87514. hasTexture(texture: BABYLON.BaseTexture): boolean;
  87515. dispose(forceDisposeEffect?: boolean): void;
  87516. clone(name: string): MixMaterial;
  87517. serialize(): any;
  87518. getClassName(): string;
  87519. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): MixMaterial;
  87520. }
  87521. }
  87522. declare module BABYLON {
  87523. /** @hidden */
  87524. export var normalPixelShader: {
  87525. name: string;
  87526. shader: string;
  87527. };
  87528. }
  87529. declare module BABYLON {
  87530. /** @hidden */
  87531. export var normalVertexShader: {
  87532. name: string;
  87533. shader: string;
  87534. };
  87535. }
  87536. declare module BABYLON {
  87537. export class NormalMaterial extends BABYLON.PushMaterial {
  87538. private _diffuseTexture;
  87539. diffuseTexture: BABYLON.BaseTexture;
  87540. diffuseColor: BABYLON.Color3;
  87541. private _disableLighting;
  87542. disableLighting: boolean;
  87543. private _maxSimultaneousLights;
  87544. maxSimultaneousLights: number;
  87545. constructor(name: string, scene: BABYLON.Scene);
  87546. needAlphaBlending(): boolean;
  87547. needAlphaBlendingForMesh(mesh: BABYLON.AbstractMesh): boolean;
  87548. needAlphaTesting(): boolean;
  87549. getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
  87550. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  87551. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  87552. getAnimatables(): BABYLON.IAnimatable[];
  87553. getActiveTextures(): BABYLON.BaseTexture[];
  87554. hasTexture(texture: BABYLON.BaseTexture): boolean;
  87555. dispose(forceDisposeEffect?: boolean): void;
  87556. clone(name: string): NormalMaterial;
  87557. serialize(): any;
  87558. getClassName(): string;
  87559. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): NormalMaterial;
  87560. }
  87561. }
  87562. declare module BABYLON {
  87563. /** @hidden */
  87564. export var shadowOnlyPixelShader: {
  87565. name: string;
  87566. shader: string;
  87567. };
  87568. }
  87569. declare module BABYLON {
  87570. /** @hidden */
  87571. export var shadowOnlyVertexShader: {
  87572. name: string;
  87573. shader: string;
  87574. };
  87575. }
  87576. declare module BABYLON {
  87577. export class ShadowOnlyMaterial extends BABYLON.PushMaterial {
  87578. private _activeLight;
  87579. private _needAlphaBlending;
  87580. constructor(name: string, scene: BABYLON.Scene);
  87581. shadowColor: BABYLON.Color3;
  87582. needAlphaBlending(): boolean;
  87583. needAlphaTesting(): boolean;
  87584. getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
  87585. get activeLight(): BABYLON.IShadowLight;
  87586. set activeLight(light: BABYLON.IShadowLight);
  87587. private _getFirstShadowLightForMesh;
  87588. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  87589. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  87590. clone(name: string): ShadowOnlyMaterial;
  87591. serialize(): any;
  87592. getClassName(): string;
  87593. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): ShadowOnlyMaterial;
  87594. }
  87595. }
  87596. declare module BABYLON {
  87597. /** @hidden */
  87598. export var simplePixelShader: {
  87599. name: string;
  87600. shader: string;
  87601. };
  87602. }
  87603. declare module BABYLON {
  87604. /** @hidden */
  87605. export var simpleVertexShader: {
  87606. name: string;
  87607. shader: string;
  87608. };
  87609. }
  87610. declare module BABYLON {
  87611. export class SimpleMaterial extends BABYLON.PushMaterial {
  87612. private _diffuseTexture;
  87613. diffuseTexture: BABYLON.BaseTexture;
  87614. diffuseColor: BABYLON.Color3;
  87615. private _disableLighting;
  87616. disableLighting: boolean;
  87617. private _maxSimultaneousLights;
  87618. maxSimultaneousLights: number;
  87619. constructor(name: string, scene: BABYLON.Scene);
  87620. needAlphaBlending(): boolean;
  87621. needAlphaTesting(): boolean;
  87622. getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
  87623. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  87624. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  87625. getAnimatables(): BABYLON.IAnimatable[];
  87626. getActiveTextures(): BABYLON.BaseTexture[];
  87627. hasTexture(texture: BABYLON.BaseTexture): boolean;
  87628. dispose(forceDisposeEffect?: boolean): void;
  87629. clone(name: string): SimpleMaterial;
  87630. serialize(): any;
  87631. getClassName(): string;
  87632. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): SimpleMaterial;
  87633. }
  87634. }
  87635. declare module BABYLON {
  87636. /** @hidden */
  87637. export var skyPixelShader: {
  87638. name: string;
  87639. shader: string;
  87640. };
  87641. }
  87642. declare module BABYLON {
  87643. /** @hidden */
  87644. export var skyVertexShader: {
  87645. name: string;
  87646. shader: string;
  87647. };
  87648. }
  87649. declare module BABYLON {
  87650. /**
  87651. * This is the sky material which allows to create dynamic and texture free effects for skyboxes.
  87652. * @see https://doc.babylonjs.com/extensions/sky
  87653. */
  87654. export class SkyMaterial extends BABYLON.PushMaterial {
  87655. /**
  87656. * Defines the overall luminance of sky in interval ]0, 1[.
  87657. */
  87658. luminance: number;
  87659. /**
  87660. * Defines the amount (scattering) of haze as opposed to molecules in atmosphere.
  87661. */
  87662. turbidity: number;
  87663. /**
  87664. * Defines the sky appearance (light intensity).
  87665. */
  87666. rayleigh: number;
  87667. /**
  87668. * Defines the mieCoefficient in interval [0, 0.1] which affects the property .mieDirectionalG.
  87669. */
  87670. mieCoefficient: number;
  87671. /**
  87672. * Defines the amount of haze particles following the Mie scattering theory.
  87673. */
  87674. mieDirectionalG: number;
  87675. /**
  87676. * Defines the distance of the sun according to the active scene camera.
  87677. */
  87678. distance: number;
  87679. /**
  87680. * Defines the sun inclination, in interval [-0.5, 0.5]. When the inclination is not 0, the sun is said
  87681. * "inclined".
  87682. */
  87683. inclination: number;
  87684. /**
  87685. * Defines the solar azimuth in interval [0, 1]. The azimuth is the angle in the horizontal plan between
  87686. * an object direction and a reference direction.
  87687. */
  87688. azimuth: number;
  87689. /**
  87690. * Defines the sun position in the sky on (x,y,z). If the property .useSunPosition is set to false, then
  87691. * the property is overriden by the inclination and the azimuth and can be read at any moment.
  87692. */
  87693. sunPosition: BABYLON.Vector3;
  87694. /**
  87695. * Defines if the sun position should be computed (inclination and azimuth) according to the given
  87696. * .sunPosition property.
  87697. */
  87698. useSunPosition: boolean;
  87699. /**
  87700. * Defines an offset vector used to get a horizon offset.
  87701. * @example skyMaterial.cameraOffset.y = camera.globalPosition.y // Set horizon relative to 0 on the Y axis
  87702. */
  87703. cameraOffset: BABYLON.Vector3;
  87704. private _cameraPosition;
  87705. /**
  87706. * Instantiates a new sky material.
  87707. * This material allows to create dynamic and texture free
  87708. * effects for skyboxes by taking care of the atmosphere state.
  87709. * @see https://doc.babylonjs.com/extensions/sky
  87710. * @param name Define the name of the material in the scene
  87711. * @param scene Define the scene the material belong to
  87712. */
  87713. constructor(name: string, scene: BABYLON.Scene);
  87714. /**
  87715. * Specifies if the material will require alpha blending
  87716. * @returns a boolean specifying if alpha blending is needed
  87717. */
  87718. needAlphaBlending(): boolean;
  87719. /**
  87720. * Specifies if this material should be rendered in alpha test mode
  87721. * @returns false as the sky material doesn't need alpha testing.
  87722. */
  87723. needAlphaTesting(): boolean;
  87724. /**
  87725. * Get the texture used for alpha test purpose.
  87726. * @returns null as the sky material has no texture.
  87727. */
  87728. getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
  87729. /**
  87730. * Get if the submesh is ready to be used and all its information available.
  87731. * Child classes can use it to update shaders
  87732. * @param mesh defines the mesh to check
  87733. * @param subMesh defines which submesh to check
  87734. * @param useInstances specifies that instances should be used
  87735. * @returns a boolean indicating that the submesh is ready or not
  87736. */
  87737. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  87738. /**
  87739. * Binds the submesh to this material by preparing the effect and shader to draw
  87740. * @param world defines the world transformation matrix
  87741. * @param mesh defines the mesh containing the submesh
  87742. * @param subMesh defines the submesh to bind the material to
  87743. */
  87744. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  87745. /**
  87746. * Get the list of animatables in the material.
  87747. * @returns the list of animatables object used in the material
  87748. */
  87749. getAnimatables(): BABYLON.IAnimatable[];
  87750. /**
  87751. * Disposes the material
  87752. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  87753. */
  87754. dispose(forceDisposeEffect?: boolean): void;
  87755. /**
  87756. * Makes a duplicate of the material, and gives it a new name
  87757. * @param name defines the new name for the duplicated material
  87758. * @returns the cloned material
  87759. */
  87760. clone(name: string): SkyMaterial;
  87761. /**
  87762. * Serializes this material in a JSON representation
  87763. * @returns the serialized material object
  87764. */
  87765. serialize(): any;
  87766. /**
  87767. * Gets the current class name of the material e.g. "SkyMaterial"
  87768. * Mainly use in serialization.
  87769. * @returns the class name
  87770. */
  87771. getClassName(): string;
  87772. /**
  87773. * Creates a sky material from parsed material data
  87774. * @param source defines the JSON representation of the material
  87775. * @param scene defines the hosting scene
  87776. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  87777. * @returns a new sky material
  87778. */
  87779. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): SkyMaterial;
  87780. }
  87781. }
  87782. declare module BABYLON {
  87783. /** @hidden */
  87784. export var terrainPixelShader: {
  87785. name: string;
  87786. shader: string;
  87787. };
  87788. }
  87789. declare module BABYLON {
  87790. /** @hidden */
  87791. export var terrainVertexShader: {
  87792. name: string;
  87793. shader: string;
  87794. };
  87795. }
  87796. declare module BABYLON {
  87797. export class TerrainMaterial extends BABYLON.PushMaterial {
  87798. private _mixTexture;
  87799. mixTexture: BABYLON.BaseTexture;
  87800. private _diffuseTexture1;
  87801. diffuseTexture1: BABYLON.Texture;
  87802. private _diffuseTexture2;
  87803. diffuseTexture2: BABYLON.Texture;
  87804. private _diffuseTexture3;
  87805. diffuseTexture3: BABYLON.Texture;
  87806. private _bumpTexture1;
  87807. bumpTexture1: BABYLON.Texture;
  87808. private _bumpTexture2;
  87809. bumpTexture2: BABYLON.Texture;
  87810. private _bumpTexture3;
  87811. bumpTexture3: BABYLON.Texture;
  87812. diffuseColor: BABYLON.Color3;
  87813. specularColor: BABYLON.Color3;
  87814. specularPower: number;
  87815. private _disableLighting;
  87816. disableLighting: boolean;
  87817. private _maxSimultaneousLights;
  87818. maxSimultaneousLights: number;
  87819. constructor(name: string, scene: BABYLON.Scene);
  87820. needAlphaBlending(): boolean;
  87821. needAlphaTesting(): boolean;
  87822. getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
  87823. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  87824. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  87825. getAnimatables(): BABYLON.IAnimatable[];
  87826. getActiveTextures(): BABYLON.BaseTexture[];
  87827. hasTexture(texture: BABYLON.BaseTexture): boolean;
  87828. dispose(forceDisposeEffect?: boolean): void;
  87829. clone(name: string): TerrainMaterial;
  87830. serialize(): any;
  87831. getClassName(): string;
  87832. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): TerrainMaterial;
  87833. }
  87834. }
  87835. declare module BABYLON {
  87836. /** @hidden */
  87837. export var triplanarPixelShader: {
  87838. name: string;
  87839. shader: string;
  87840. };
  87841. }
  87842. declare module BABYLON {
  87843. /** @hidden */
  87844. export var triplanarVertexShader: {
  87845. name: string;
  87846. shader: string;
  87847. };
  87848. }
  87849. declare module BABYLON {
  87850. export class TriPlanarMaterial extends BABYLON.PushMaterial {
  87851. mixTexture: BABYLON.BaseTexture;
  87852. private _diffuseTextureX;
  87853. diffuseTextureX: BABYLON.BaseTexture;
  87854. private _diffuseTextureY;
  87855. diffuseTextureY: BABYLON.BaseTexture;
  87856. private _diffuseTextureZ;
  87857. diffuseTextureZ: BABYLON.BaseTexture;
  87858. private _normalTextureX;
  87859. normalTextureX: BABYLON.BaseTexture;
  87860. private _normalTextureY;
  87861. normalTextureY: BABYLON.BaseTexture;
  87862. private _normalTextureZ;
  87863. normalTextureZ: BABYLON.BaseTexture;
  87864. tileSize: number;
  87865. diffuseColor: BABYLON.Color3;
  87866. specularColor: BABYLON.Color3;
  87867. specularPower: number;
  87868. private _disableLighting;
  87869. disableLighting: boolean;
  87870. private _maxSimultaneousLights;
  87871. maxSimultaneousLights: number;
  87872. constructor(name: string, scene: BABYLON.Scene);
  87873. needAlphaBlending(): boolean;
  87874. needAlphaTesting(): boolean;
  87875. getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
  87876. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  87877. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  87878. getAnimatables(): BABYLON.IAnimatable[];
  87879. getActiveTextures(): BABYLON.BaseTexture[];
  87880. hasTexture(texture: BABYLON.BaseTexture): boolean;
  87881. dispose(forceDisposeEffect?: boolean): void;
  87882. clone(name: string): TriPlanarMaterial;
  87883. serialize(): any;
  87884. getClassName(): string;
  87885. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): TriPlanarMaterial;
  87886. }
  87887. }
  87888. declare module BABYLON {
  87889. /** @hidden */
  87890. export var waterPixelShader: {
  87891. name: string;
  87892. shader: string;
  87893. };
  87894. }
  87895. declare module BABYLON {
  87896. /** @hidden */
  87897. export var waterVertexShader: {
  87898. name: string;
  87899. shader: string;
  87900. };
  87901. }
  87902. declare module BABYLON {
  87903. export class WaterMaterial extends BABYLON.PushMaterial {
  87904. renderTargetSize: BABYLON.Vector2;
  87905. private _bumpTexture;
  87906. bumpTexture: BABYLON.BaseTexture;
  87907. diffuseColor: BABYLON.Color3;
  87908. specularColor: BABYLON.Color3;
  87909. specularPower: number;
  87910. private _disableLighting;
  87911. disableLighting: boolean;
  87912. private _maxSimultaneousLights;
  87913. maxSimultaneousLights: number;
  87914. /**
  87915. * Defines the wind force.
  87916. */
  87917. windForce: number;
  87918. /**
  87919. * Defines the direction of the wind in the plane (X, Z).
  87920. */
  87921. windDirection: BABYLON.Vector2;
  87922. /**
  87923. * Defines the height of the waves.
  87924. */
  87925. waveHeight: number;
  87926. /**
  87927. * Defines the bump height related to the bump map.
  87928. */
  87929. bumpHeight: number;
  87930. /**
  87931. * Defines wether or not: to add a smaller moving bump to less steady waves.
  87932. */
  87933. private _bumpSuperimpose;
  87934. bumpSuperimpose: boolean;
  87935. /**
  87936. * Defines wether or not color refraction and reflection differently with .waterColor2 and .colorBlendFactor2. Non-linear (physically correct) fresnel.
  87937. */
  87938. private _fresnelSeparate;
  87939. fresnelSeparate: boolean;
  87940. /**
  87941. * Defines wether or not bump Wwves modify the reflection.
  87942. */
  87943. private _bumpAffectsReflection;
  87944. bumpAffectsReflection: boolean;
  87945. /**
  87946. * Defines the water color blended with the refraction (near).
  87947. */
  87948. waterColor: BABYLON.Color3;
  87949. /**
  87950. * Defines the blend factor related to the water color.
  87951. */
  87952. colorBlendFactor: number;
  87953. /**
  87954. * Defines the water color blended with the reflection (far).
  87955. */
  87956. waterColor2: BABYLON.Color3;
  87957. /**
  87958. * Defines the blend factor related to the water color (reflection, far).
  87959. */
  87960. colorBlendFactor2: number;
  87961. /**
  87962. * Defines the maximum length of a wave.
  87963. */
  87964. waveLength: number;
  87965. /**
  87966. * Defines the waves speed.
  87967. */
  87968. waveSpeed: number;
  87969. /**
  87970. * Defines the number of times waves are repeated. This is typically used to adjust waves count according to the ground's size where the material is applied on.
  87971. */
  87972. waveCount: number;
  87973. /**
  87974. * Sets or gets whether or not automatic clipping should be enabled or not. Setting to true will save performances and
  87975. * will avoid calculating useless pixels in the pixel shader of the water material.
  87976. */
  87977. disableClipPlane: boolean;
  87978. protected _renderTargets: BABYLON.SmartArray<BABYLON.RenderTargetTexture>;
  87979. private _mesh;
  87980. private _refractionRTT;
  87981. private _reflectionRTT;
  87982. private _reflectionTransform;
  87983. private _lastTime;
  87984. private _lastDeltaTime;
  87985. private _useLogarithmicDepth;
  87986. private _waitingRenderList;
  87987. private _imageProcessingConfiguration;
  87988. private _imageProcessingObserver;
  87989. /**
  87990. * Gets a boolean indicating that current material needs to register RTT
  87991. */
  87992. get hasRenderTargetTextures(): boolean;
  87993. /**
  87994. * Constructor
  87995. */
  87996. constructor(name: string, scene: BABYLON.Scene, renderTargetSize?: BABYLON.Vector2);
  87997. get useLogarithmicDepth(): boolean;
  87998. set useLogarithmicDepth(value: boolean);
  87999. get refractionTexture(): BABYLON.Nullable<BABYLON.RenderTargetTexture>;
  88000. get reflectionTexture(): BABYLON.Nullable<BABYLON.RenderTargetTexture>;
  88001. addToRenderList(node: any): void;
  88002. enableRenderTargets(enable: boolean): void;
  88003. getRenderList(): BABYLON.Nullable<BABYLON.AbstractMesh[]>;
  88004. get renderTargetsEnabled(): boolean;
  88005. needAlphaBlending(): boolean;
  88006. needAlphaTesting(): boolean;
  88007. getAlphaTestTexture(): BABYLON.Nullable<BABYLON.BaseTexture>;
  88008. isReadyForSubMesh(mesh: BABYLON.AbstractMesh, subMesh: BABYLON.SubMesh, useInstances?: boolean): boolean;
  88009. bindForSubMesh(world: BABYLON.Matrix, mesh: BABYLON.Mesh, subMesh: BABYLON.SubMesh): void;
  88010. private _createRenderTargets;
  88011. getAnimatables(): BABYLON.IAnimatable[];
  88012. getActiveTextures(): BABYLON.BaseTexture[];
  88013. hasTexture(texture: BABYLON.BaseTexture): boolean;
  88014. dispose(forceDisposeEffect?: boolean): void;
  88015. clone(name: string): WaterMaterial;
  88016. serialize(): any;
  88017. getClassName(): string;
  88018. static Parse(source: any, scene: BABYLON.Scene, rootUrl: string): WaterMaterial;
  88019. static CreateDefaultMesh(name: string, scene: BABYLON.Scene): BABYLON.Mesh;
  88020. }
  88021. }
  88022. declare module BABYLON {
  88023. /** @hidden */
  88024. export var asciiartPixelShader: {
  88025. name: string;
  88026. shader: string;
  88027. };
  88028. }
  88029. declare module BABYLON {
  88030. /**
  88031. * AsciiArtFontTexture is the helper class used to easily create your ascii art font texture.
  88032. *
  88033. * It basically takes care rendering the font front the given font size to a texture.
  88034. * This is used later on in the postprocess.
  88035. */
  88036. export class AsciiArtFontTexture extends BABYLON.BaseTexture {
  88037. private _font;
  88038. private _text;
  88039. private _charSize;
  88040. /**
  88041. * Gets the size of one char in the texture (each char fits in size * size space in the texture).
  88042. */
  88043. get charSize(): number;
  88044. /**
  88045. * Create a new instance of the Ascii Art FontTexture class
  88046. * @param name the name of the texture
  88047. * @param font the font to use, use the W3C CSS notation
  88048. * @param text the caracter set to use in the rendering.
  88049. * @param scene the scene that owns the texture
  88050. */
  88051. constructor(name: string, font: string, text: string, scene?: BABYLON.Nullable<BABYLON.Scene>);
  88052. /**
  88053. * Gets the max char width of a font.
  88054. * @param font the font to use, use the W3C CSS notation
  88055. * @return the max char width
  88056. */
  88057. private getFontWidth;
  88058. /**
  88059. * Gets the max char height of a font.
  88060. * @param font the font to use, use the W3C CSS notation
  88061. * @return the max char height
  88062. */
  88063. private getFontHeight;
  88064. /**
  88065. * Clones the current AsciiArtTexture.
  88066. * @return the clone of the texture.
  88067. */
  88068. clone(): AsciiArtFontTexture;
  88069. /**
  88070. * Parses a json object representing the texture and returns an instance of it.
  88071. * @param source the source JSON representation
  88072. * @param scene the scene to create the texture for
  88073. * @return the parsed texture
  88074. */
  88075. static Parse(source: any, scene: BABYLON.Scene): AsciiArtFontTexture;
  88076. }
  88077. /**
  88078. * Option available in the Ascii Art Post Process.
  88079. */
  88080. export interface IAsciiArtPostProcessOptions {
  88081. /**
  88082. * The font to use following the w3c font definition.
  88083. */
  88084. font?: string;
  88085. /**
  88086. * The character set to use in the postprocess.
  88087. */
  88088. characterSet?: string;
  88089. /**
  88090. * This defines the amount you want to mix the "tile" or caracter space colored in the ascii art.
  88091. * This number is defined between 0 and 1;
  88092. */
  88093. mixToTile?: number;
  88094. /**
  88095. * This defines the amount you want to mix the normal rendering pass in the ascii art.
  88096. * This number is defined between 0 and 1;
  88097. */
  88098. mixToNormal?: number;
  88099. }
  88100. /**
  88101. * AsciiArtPostProcess helps rendering everithing in Ascii Art.
  88102. *
  88103. * Simmply add it to your scene and let the nerd that lives in you have fun.
  88104. * Example usage: var pp = new AsciiArtPostProcess("myAscii", "20px Monospace", camera);
  88105. */
  88106. export class AsciiArtPostProcess extends BABYLON.PostProcess {
  88107. /**
  88108. * The font texture used to render the char in the post process.
  88109. */
  88110. private _asciiArtFontTexture;
  88111. /**
  88112. * This defines the amount you want to mix the "tile" or caracter space colored in the ascii art.
  88113. * This number is defined between 0 and 1;
  88114. */
  88115. mixToTile: number;
  88116. /**
  88117. * This defines the amount you want to mix the normal rendering pass in the ascii art.
  88118. * This number is defined between 0 and 1;
  88119. */
  88120. mixToNormal: number;
  88121. /**
  88122. * Instantiates a new Ascii Art Post Process.
  88123. * @param name the name to give to the postprocess
  88124. * @camera the camera to apply the post process to.
  88125. * @param options can either be the font name or an option object following the IAsciiArtPostProcessOptions format
  88126. */
  88127. constructor(name: string, camera: BABYLON.Camera, options?: string | IAsciiArtPostProcessOptions);
  88128. }
  88129. }
  88130. declare module BABYLON {
  88131. /** @hidden */
  88132. export var digitalrainPixelShader: {
  88133. name: string;
  88134. shader: string;
  88135. };
  88136. }
  88137. declare module BABYLON {
  88138. /**
  88139. * DigitalRainFontTexture is the helper class used to easily create your digital rain font texture.
  88140. *
  88141. * It basically takes care rendering the font front the given font size to a texture.
  88142. * This is used later on in the postprocess.
  88143. */
  88144. export class DigitalRainFontTexture extends BABYLON.BaseTexture {
  88145. private _font;
  88146. private _text;
  88147. private _charSize;
  88148. /**
  88149. * Gets the size of one char in the texture (each char fits in size * size space in the texture).
  88150. */
  88151. get charSize(): number;
  88152. /**
  88153. * Create a new instance of the Digital Rain FontTexture class
  88154. * @param name the name of the texture
  88155. * @param font the font to use, use the W3C CSS notation
  88156. * @param text the caracter set to use in the rendering.
  88157. * @param scene the scene that owns the texture
  88158. */
  88159. constructor(name: string, font: string, text: string, scene?: BABYLON.Nullable<BABYLON.Scene>);
  88160. /**
  88161. * Gets the max char width of a font.
  88162. * @param font the font to use, use the W3C CSS notation
  88163. * @return the max char width
  88164. */
  88165. private getFontWidth;
  88166. /**
  88167. * Gets the max char height of a font.
  88168. * @param font the font to use, use the W3C CSS notation
  88169. * @return the max char height
  88170. */
  88171. private getFontHeight;
  88172. /**
  88173. * Clones the current DigitalRainFontTexture.
  88174. * @return the clone of the texture.
  88175. */
  88176. clone(): DigitalRainFontTexture;
  88177. /**
  88178. * Parses a json object representing the texture and returns an instance of it.
  88179. * @param source the source JSON representation
  88180. * @param scene the scene to create the texture for
  88181. * @return the parsed texture
  88182. */
  88183. static Parse(source: any, scene: BABYLON.Scene): DigitalRainFontTexture;
  88184. }
  88185. /**
  88186. * Option available in the Digital Rain Post Process.
  88187. */
  88188. export interface IDigitalRainPostProcessOptions {
  88189. /**
  88190. * The font to use following the w3c font definition.
  88191. */
  88192. font?: string;
  88193. /**
  88194. * This defines the amount you want to mix the "tile" or caracter space colored in the digital rain.
  88195. * This number is defined between 0 and 1;
  88196. */
  88197. mixToTile?: number;
  88198. /**
  88199. * This defines the amount you want to mix the normal rendering pass in the digital rain.
  88200. * This number is defined between 0 and 1;
  88201. */
  88202. mixToNormal?: number;
  88203. }
  88204. /**
  88205. * DigitalRainPostProcess helps rendering everithing in digital rain.
  88206. *
  88207. * Simmply add it to your scene and let the nerd that lives in you have fun.
  88208. * Example usage: var pp = new DigitalRainPostProcess("digitalRain", "20px Monospace", camera);
  88209. */
  88210. export class DigitalRainPostProcess extends BABYLON.PostProcess {
  88211. /**
  88212. * The font texture used to render the char in the post process.
  88213. */
  88214. private _digitalRainFontTexture;
  88215. /**
  88216. * This defines the amount you want to mix the "tile" or caracter space colored in the digital rain.
  88217. * This number is defined between 0 and 1;
  88218. */
  88219. mixToTile: number;
  88220. /**
  88221. * This defines the amount you want to mix the normal rendering pass in the digital rain.
  88222. * This number is defined between 0 and 1;
  88223. */
  88224. mixToNormal: number;
  88225. /**
  88226. * Instantiates a new Digital Rain Post Process.
  88227. * @param name the name to give to the postprocess
  88228. * @camera the camera to apply the post process to.
  88229. * @param options can either be the font name or an option object following the IDigitalRainPostProcessOptions format
  88230. */
  88231. constructor(name: string, camera: BABYLON.Camera, options?: string | IDigitalRainPostProcessOptions);
  88232. }
  88233. }
  88234. declare module BABYLON {
  88235. /** @hidden */
  88236. export var brickProceduralTexturePixelShader: {
  88237. name: string;
  88238. shader: string;
  88239. };
  88240. }
  88241. declare module BABYLON {
  88242. export class BrickProceduralTexture extends BABYLON.ProceduralTexture {
  88243. private _numberOfBricksHeight;
  88244. private _numberOfBricksWidth;
  88245. private _jointColor;
  88246. private _brickColor;
  88247. constructor(name: string, size: number, scene: BABYLON.Scene, fallbackTexture?: BABYLON.Texture, generateMipMaps?: boolean);
  88248. updateShaderUniforms(): void;
  88249. get numberOfBricksHeight(): number;
  88250. set numberOfBricksHeight(value: number);
  88251. get numberOfBricksWidth(): number;
  88252. set numberOfBricksWidth(value: number);
  88253. get jointColor(): BABYLON.Color3;
  88254. set jointColor(value: BABYLON.Color3);
  88255. get brickColor(): BABYLON.Color3;
  88256. set brickColor(value: BABYLON.Color3);
  88257. /**
  88258. * Serializes this brick procedural texture
  88259. * @returns a serialized brick procedural texture object
  88260. */
  88261. serialize(): any;
  88262. /**
  88263. * Creates a Brick Procedural BABYLON.Texture from parsed brick procedural texture data
  88264. * @param parsedTexture defines parsed texture data
  88265. * @param scene defines the current scene
  88266. * @param rootUrl defines the root URL containing brick procedural texture information
  88267. * @returns a parsed Brick Procedural BABYLON.Texture
  88268. */
  88269. static Parse(parsedTexture: any, scene: BABYLON.Scene, rootUrl: string): BrickProceduralTexture;
  88270. }
  88271. }
  88272. declare module BABYLON {
  88273. /** @hidden */
  88274. export var cloudProceduralTexturePixelShader: {
  88275. name: string;
  88276. shader: string;
  88277. };
  88278. }
  88279. declare module BABYLON {
  88280. export class CloudProceduralTexture extends BABYLON.ProceduralTexture {
  88281. private _skyColor;
  88282. private _cloudColor;
  88283. constructor(name: string, size: number, scene: BABYLON.Scene, fallbackTexture?: BABYLON.Texture, generateMipMaps?: boolean);
  88284. updateShaderUniforms(): void;
  88285. get skyColor(): BABYLON.Color4;
  88286. set skyColor(value: BABYLON.Color4);
  88287. get cloudColor(): BABYLON.Color4;
  88288. set cloudColor(value: BABYLON.Color4);
  88289. /**
  88290. * Serializes this cloud procedural texture
  88291. * @returns a serialized cloud procedural texture object
  88292. */
  88293. serialize(): any;
  88294. /**
  88295. * Creates a Cloud Procedural BABYLON.Texture from parsed cloud procedural texture data
  88296. * @param parsedTexture defines parsed texture data
  88297. * @param scene defines the current scene
  88298. * @param rootUrl defines the root URL containing cloud procedural texture information
  88299. * @returns a parsed Cloud Procedural BABYLON.Texture
  88300. */
  88301. static Parse(parsedTexture: any, scene: BABYLON.Scene, rootUrl: string): CloudProceduralTexture;
  88302. }
  88303. }
  88304. declare module BABYLON {
  88305. /** @hidden */
  88306. export var fireProceduralTexturePixelShader: {
  88307. name: string;
  88308. shader: string;
  88309. };
  88310. }
  88311. declare module BABYLON {
  88312. export class FireProceduralTexture extends BABYLON.ProceduralTexture {
  88313. private _time;
  88314. private _speed;
  88315. private _autoGenerateTime;
  88316. private _fireColors;
  88317. private _alphaThreshold;
  88318. constructor(name: string, size: number, scene: BABYLON.Scene, fallbackTexture?: BABYLON.Texture, generateMipMaps?: boolean);
  88319. updateShaderUniforms(): void;
  88320. render(useCameraPostProcess?: boolean): void;
  88321. static get PurpleFireColors(): BABYLON.Color3[];
  88322. static get GreenFireColors(): BABYLON.Color3[];
  88323. static get RedFireColors(): BABYLON.Color3[];
  88324. static get BlueFireColors(): BABYLON.Color3[];
  88325. get autoGenerateTime(): boolean;
  88326. set autoGenerateTime(value: boolean);
  88327. get fireColors(): BABYLON.Color3[];
  88328. set fireColors(value: BABYLON.Color3[]);
  88329. get time(): number;
  88330. set time(value: number);
  88331. get speed(): BABYLON.Vector2;
  88332. set speed(value: BABYLON.Vector2);
  88333. get alphaThreshold(): number;
  88334. set alphaThreshold(value: number);
  88335. /**
  88336. * Serializes this fire procedural texture
  88337. * @returns a serialized fire procedural texture object
  88338. */
  88339. serialize(): any;
  88340. /**
  88341. * Creates a Fire Procedural BABYLON.Texture from parsed fire procedural texture data
  88342. * @param parsedTexture defines parsed texture data
  88343. * @param scene defines the current scene
  88344. * @param rootUrl defines the root URL containing fire procedural texture information
  88345. * @returns a parsed Fire Procedural BABYLON.Texture
  88346. */
  88347. static Parse(parsedTexture: any, scene: BABYLON.Scene, rootUrl: string): FireProceduralTexture;
  88348. }
  88349. }
  88350. declare module BABYLON {
  88351. /** @hidden */
  88352. export var grassProceduralTexturePixelShader: {
  88353. name: string;
  88354. shader: string;
  88355. };
  88356. }
  88357. declare module BABYLON {
  88358. export class GrassProceduralTexture extends BABYLON.ProceduralTexture {
  88359. private _grassColors;
  88360. private _groundColor;
  88361. constructor(name: string, size: number, scene: BABYLON.Scene, fallbackTexture?: BABYLON.Texture, generateMipMaps?: boolean);
  88362. updateShaderUniforms(): void;
  88363. get grassColors(): BABYLON.Color3[];
  88364. set grassColors(value: BABYLON.Color3[]);
  88365. get groundColor(): BABYLON.Color3;
  88366. set groundColor(value: BABYLON.Color3);
  88367. /**
  88368. * Serializes this grass procedural texture
  88369. * @returns a serialized grass procedural texture object
  88370. */
  88371. serialize(): any;
  88372. /**
  88373. * Creates a Grass Procedural BABYLON.Texture from parsed grass procedural texture data
  88374. * @param parsedTexture defines parsed texture data
  88375. * @param scene defines the current scene
  88376. * @param rootUrl defines the root URL containing grass procedural texture information
  88377. * @returns a parsed Grass Procedural BABYLON.Texture
  88378. */
  88379. static Parse(parsedTexture: any, scene: BABYLON.Scene, rootUrl: string): GrassProceduralTexture;
  88380. }
  88381. }
  88382. declare module BABYLON {
  88383. /** @hidden */
  88384. export var marbleProceduralTexturePixelShader: {
  88385. name: string;
  88386. shader: string;
  88387. };
  88388. }
  88389. declare module BABYLON {
  88390. export class MarbleProceduralTexture extends BABYLON.ProceduralTexture {
  88391. private _numberOfTilesHeight;
  88392. private _numberOfTilesWidth;
  88393. private _amplitude;
  88394. private _jointColor;
  88395. constructor(name: string, size: number, scene: BABYLON.Scene, fallbackTexture?: BABYLON.Texture, generateMipMaps?: boolean);
  88396. updateShaderUniforms(): void;
  88397. get numberOfTilesHeight(): number;
  88398. set numberOfTilesHeight(value: number);
  88399. get amplitude(): number;
  88400. set amplitude(value: number);
  88401. get numberOfTilesWidth(): number;
  88402. set numberOfTilesWidth(value: number);
  88403. get jointColor(): BABYLON.Color3;
  88404. set jointColor(value: BABYLON.Color3);
  88405. /**
  88406. * Serializes this marble procedural texture
  88407. * @returns a serialized marble procedural texture object
  88408. */
  88409. serialize(): any;
  88410. /**
  88411. * Creates a Marble Procedural BABYLON.Texture from parsed marble procedural texture data
  88412. * @param parsedTexture defines parsed texture data
  88413. * @param scene defines the current scene
  88414. * @param rootUrl defines the root URL containing marble procedural texture information
  88415. * @returns a parsed Marble Procedural BABYLON.Texture
  88416. */
  88417. static Parse(parsedTexture: any, scene: BABYLON.Scene, rootUrl: string): MarbleProceduralTexture;
  88418. }
  88419. }
  88420. declare module BABYLON {
  88421. /** @hidden */
  88422. export var normalMapProceduralTexturePixelShader: {
  88423. name: string;
  88424. shader: string;
  88425. };
  88426. }
  88427. declare module BABYLON {
  88428. export class NormalMapProceduralTexture extends BABYLON.ProceduralTexture {
  88429. private _baseTexture;
  88430. constructor(name: string, size: number, scene: BABYLON.Scene, fallbackTexture?: BABYLON.Texture, generateMipMaps?: boolean);
  88431. updateShaderUniforms(): void;
  88432. render(useCameraPostProcess?: boolean): void;
  88433. resize(size: any, generateMipMaps: any): void;
  88434. get baseTexture(): BABYLON.Texture;
  88435. set baseTexture(texture: BABYLON.Texture);
  88436. /**
  88437. * Serializes this normal map procedural texture
  88438. * @returns a serialized normal map procedural texture object
  88439. */
  88440. serialize(): any;
  88441. /**
  88442. * Creates a Normal Map Procedural BABYLON.Texture from parsed normal map procedural texture data
  88443. * @param parsedTexture defines parsed texture data
  88444. * @param scene defines the current scene
  88445. * @param rootUrl defines the root URL containing normal map procedural texture information
  88446. * @returns a parsed Normal Map Procedural BABYLON.Texture
  88447. */
  88448. static Parse(parsedTexture: any, scene: BABYLON.Scene, rootUrl: string): NormalMapProceduralTexture;
  88449. }
  88450. }
  88451. declare module BABYLON {
  88452. /** @hidden */
  88453. export var perlinNoiseProceduralTexturePixelShader: {
  88454. name: string;
  88455. shader: string;
  88456. };
  88457. }
  88458. declare module BABYLON {
  88459. export class PerlinNoiseProceduralTexture extends BABYLON.ProceduralTexture {
  88460. time: number;
  88461. timeScale: number;
  88462. translationSpeed: number;
  88463. private _currentTranslation;
  88464. constructor(name: string, size: number, scene: BABYLON.Scene, fallbackTexture?: BABYLON.Texture, generateMipMaps?: boolean);
  88465. updateShaderUniforms(): void;
  88466. render(useCameraPostProcess?: boolean): void;
  88467. resize(size: any, generateMipMaps: any): void;
  88468. /**
  88469. * Serializes this perlin noise procedural texture
  88470. * @returns a serialized perlin noise procedural texture object
  88471. */
  88472. serialize(): any;
  88473. /**
  88474. * Creates a Perlin Noise Procedural BABYLON.Texture from parsed perlin noise procedural texture data
  88475. * @param parsedTexture defines parsed texture data
  88476. * @param scene defines the current scene
  88477. * @param rootUrl defines the root URL containing perlin noise procedural texture information
  88478. * @returns a parsed Perlin Noise Procedural BABYLON.Texture
  88479. */
  88480. static Parse(parsedTexture: any, scene: BABYLON.Scene, rootUrl: string): PerlinNoiseProceduralTexture;
  88481. }
  88482. }
  88483. declare module BABYLON {
  88484. /** @hidden */
  88485. export var roadProceduralTexturePixelShader: {
  88486. name: string;
  88487. shader: string;
  88488. };
  88489. }
  88490. declare module BABYLON {
  88491. export class RoadProceduralTexture extends BABYLON.ProceduralTexture {
  88492. private _roadColor;
  88493. constructor(name: string, size: number, scene: BABYLON.Scene, fallbackTexture?: BABYLON.Texture, generateMipMaps?: boolean);
  88494. updateShaderUniforms(): void;
  88495. get roadColor(): BABYLON.Color3;
  88496. set roadColor(value: BABYLON.Color3);
  88497. /**
  88498. * Serializes this road procedural texture
  88499. * @returns a serialized road procedural texture object
  88500. */
  88501. serialize(): any;
  88502. /**
  88503. * Creates a Road Procedural BABYLON.Texture from parsed road procedural texture data
  88504. * @param parsedTexture defines parsed texture data
  88505. * @param scene defines the current scene
  88506. * @param rootUrl defines the root URL containing road procedural texture information
  88507. * @returns a parsed Road Procedural BABYLON.Texture
  88508. */
  88509. static Parse(parsedTexture: any, scene: BABYLON.Scene, rootUrl: string): RoadProceduralTexture;
  88510. }
  88511. }
  88512. declare module BABYLON {
  88513. /** @hidden */
  88514. export var starfieldProceduralTexturePixelShader: {
  88515. name: string;
  88516. shader: string;
  88517. };
  88518. }
  88519. declare module BABYLON {
  88520. export class StarfieldProceduralTexture extends BABYLON.ProceduralTexture {
  88521. private _time;
  88522. private _alpha;
  88523. private _beta;
  88524. private _zoom;
  88525. private _formuparam;
  88526. private _stepsize;
  88527. private _tile;
  88528. private _brightness;
  88529. private _darkmatter;
  88530. private _distfading;
  88531. private _saturation;
  88532. constructor(name: string, size: number, scene: BABYLON.Scene, fallbackTexture?: BABYLON.Texture, generateMipMaps?: boolean);
  88533. updateShaderUniforms(): void;
  88534. get time(): number;
  88535. set time(value: number);
  88536. get alpha(): number;
  88537. set alpha(value: number);
  88538. get beta(): number;
  88539. set beta(value: number);
  88540. get formuparam(): number;
  88541. set formuparam(value: number);
  88542. get stepsize(): number;
  88543. set stepsize(value: number);
  88544. get zoom(): number;
  88545. set zoom(value: number);
  88546. get tile(): number;
  88547. set tile(value: number);
  88548. get brightness(): number;
  88549. set brightness(value: number);
  88550. get darkmatter(): number;
  88551. set darkmatter(value: number);
  88552. get distfading(): number;
  88553. set distfading(value: number);
  88554. get saturation(): number;
  88555. set saturation(value: number);
  88556. /**
  88557. * Serializes this starfield procedural texture
  88558. * @returns a serialized starfield procedural texture object
  88559. */
  88560. serialize(): any;
  88561. /**
  88562. * Creates a Starfield Procedural BABYLON.Texture from parsed startfield procedural texture data
  88563. * @param parsedTexture defines parsed texture data
  88564. * @param scene defines the current scene
  88565. * @param rootUrl defines the root URL containing startfield procedural texture information
  88566. * @returns a parsed Starfield Procedural BABYLON.Texture
  88567. */
  88568. static Parse(parsedTexture: any, scene: BABYLON.Scene, rootUrl: string): StarfieldProceduralTexture;
  88569. }
  88570. }
  88571. declare module BABYLON {
  88572. /** @hidden */
  88573. export var woodProceduralTexturePixelShader: {
  88574. name: string;
  88575. shader: string;
  88576. };
  88577. }
  88578. declare module BABYLON {
  88579. export class WoodProceduralTexture extends BABYLON.ProceduralTexture {
  88580. private _ampScale;
  88581. private _woodColor;
  88582. constructor(name: string, size: number, scene: BABYLON.Scene, fallbackTexture?: BABYLON.Texture, generateMipMaps?: boolean);
  88583. updateShaderUniforms(): void;
  88584. get ampScale(): number;
  88585. set ampScale(value: number);
  88586. get woodColor(): BABYLON.Color3;
  88587. set woodColor(value: BABYLON.Color3);
  88588. /**
  88589. * Serializes this wood procedural texture
  88590. * @returns a serialized wood procedural texture object
  88591. */
  88592. serialize(): any;
  88593. /**
  88594. * Creates a Wood Procedural BABYLON.Texture from parsed wood procedural texture data
  88595. * @param parsedTexture defines parsed texture data
  88596. * @param scene defines the current scene
  88597. * @param rootUrl defines the root URL containing wood procedural texture information
  88598. * @returns a parsed Wood Procedural BABYLON.Texture
  88599. */
  88600. static Parse(parsedTexture: any, scene: BABYLON.Scene, rootUrl: string): WoodProceduralTexture;
  88601. }
  88602. }