1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379 |
- /*! *****************************************************************************
- Copyright (c) 2023 Tencent, Inc. All rights reserved.
- Permission is hereby granted, free of charge, to any person obtaining a copy of
- this software and associated documentation files (the "Software"), to deal in
- the Software without restriction, including without limitation the rights to
- use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
- of the Software, and to permit persons to whom the Software is furnished to do
- so, subject to the following conditions:
- The above copyright notice and this permission notice shall be included in all
- copies or substantial portions of the Software.
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- SOFTWARE.
- ***************************************************************************** */
- /// <reference path="./lib.wx.phys3D.d.ts" />
- declare type HTMLCanvasElement = any
- declare type ImageData = any
- declare type HTMLImageElement = any
- declare module 'XrFrame' {
- import * as xrFrameSystem from 'XrFrame/xrFrameSystem'
- import { IComponentSchema, IEntityComponents } from 'XrFrame/xrFrameSystem'
- export {
- IComponentSchema,
- IEntityComponents,
- IEffectAsset,
- IRenderStates,
- ISubMesh,
- IVideoTextureOptions,
- IRenderTarget,
- IRenderTextureOptions,
- IGLTFModelOptions,
- IEnvDataOptions,
- IKeyframeAnimationData,
- IKeyframeAnimationInfo,
- IKeyframeAnimationOptions,
- IAtlasOptions,
- IAtlasCreationOptions,
- IPostProcessOptions,
- IDataValueHandler,
- ITextureWrapper,
- ITextureOptions,
- IEngineSettings,
- IHandle,
- IVertexLayoutOptions,
- IVertexDataDescriptorOptions,
- IUniformDescriptorOptions,
- IImage,
- IRealDownloader,
- IDownloader,
- IFontSetting,
- IFeatures,
- IRect,
- IViewAction,
- IView,
- IAttachment,
- IRenderPassDescriptor,
- IGlyphInfo,
- IEventBridge,
- INativeMap,
- ILongIntNativeMap,
- ITransformData,
- IAssetsData,
- ICameraData,
- IGLTFData,
- ILightData,
- IAssetMaterialData,
- IMeshData,
- ITextData,
- IAssetRenderTextureData,
- IEnvData,
- IAnimatorData,
- IAnimationPlayOptions,
- IAnimatorAutoPlay,
- ICameraOrbitControlData,
- IARTrackerData,
- IARTrackerRawData,
- IShapeData,
- ISphereShapeData,
- IMeshShapeData,
- ICapsuleShapeData,
- ICubeShapeData,
- IRigidbodyData,
- IShapeInteractData,
- IShapeGizmosData,
- IAssetPostProcessData,
- IParticleData,
- IAssetsSystemData,
- INodeSystemData,
- ITickSystemData,
- IAnimationSystemData,
- IVideoSystemData,
- IRenderSystemData,
- IPhysicsSystemData,
- IShapeDragEvent,
- IShapeTouchEvent,
- IARSystemData,
- IARRawData,
- IShareSystemData,
- IShareCaptureOptions,
- IShareRecordOptions,
- IGizmoSystemData,
- ILoaderOptionsSchema,
- ITextureLoaderOptions,
- IImageLoaderOptions,
- ICubeTextureLoaderOptions,
- IVideoTextureLoaderOptions,
- IEnvDataLoaderOptions,
- IGLTFLoaderOptions,
- IKeyframeLoaderOptions,
- IRawLoaderOptions,
- IAtlasLoaderOptions,
- TEventCallback,
- TDirection,
- Texture,
- UniformDescriptor,
- UniformBlock,
- VertexLayout,
- TCameraBackground,
- TTrackMode,
- EVideoState,
- EVertexFormat,
- EVertexStep,
- EIndexType,
- ETextureType,
- ETextureFormat,
- EWrapMode,
- EFilterMode,
- EUniformType,
- ECullMode,
- EFaceWinding,
- ECompareFunc,
- EStencilOp,
- EBlendFactor,
- EBlendEquation,
- EColorMask,
- EPixelType,
- ELoadAction,
- EDataModelType,
- EMeshRenderType,
- EPrimitiveType,
- EShadowMode,
- EShadowFitMode,
- EVertexLayoutUsage,
- EVertexBatchOperator,
- EAnimationBlendType,
- EUseDefaultAddedAction,
- EUseDefaultRetainedAction,
- EUseDefaultRemovedAction,
- EEventType,
- EARTrackerState,
- EShapeType,
- ECapsuleShapeDirection,
- EShareRecordState
- } from 'XrFrame/xrFrameSystem'
- export type Component<IData> = xrFrameSystem.Component<IData>
- export type Element = xrFrameSystem.Element
- export type EventManager = xrFrameSystem.EventManager
- export type Effect = xrFrameSystem.Effect
- export type Geometry = xrFrameSystem.Geometry
- export type Material = xrFrameSystem.Material
- export type VideoTexture = xrFrameSystem.VideoTexture
- export type RenderTexture = xrFrameSystem.RenderTexture
- export type GLTFModel = xrFrameSystem.GLTFModel
- export type EnvData = xrFrameSystem.EnvData
- export type Animation = xrFrameSystem.Animation
- export type KeyframeAnimation = xrFrameSystem.KeyframeAnimation
- export type Atlas = xrFrameSystem.Atlas
- export type PostProcess = xrFrameSystem.PostProcess
- export type Vector2 = xrFrameSystem.Vector2
- export type Vector3 = xrFrameSystem.Vector3
- export type Vector4 = xrFrameSystem.Vector4
- export type Quaternion = xrFrameSystem.Quaternion
- export type Matrix3 = xrFrameSystem.Matrix3
- export type Matrix4 = xrFrameSystem.Matrix4
- export type Color = xrFrameSystem.Color
- export type OBB = xrFrameSystem.OBB
- export type BoundBall = xrFrameSystem.BoundBall
- export type BoundBox = xrFrameSystem.BoundBox
- export type Spherical = xrFrameSystem.Spherical
- export type Transform = xrFrameSystem.Transform
- export type AssetLoad = xrFrameSystem.AssetLoad
- export type Assets = xrFrameSystem.Assets
- export type Camera = xrFrameSystem.Camera
- export type GLTF = xrFrameSystem.GLTF
- export type Light = xrFrameSystem.Light
- export type AssetMaterial = xrFrameSystem.AssetMaterial
- export type Mesh = xrFrameSystem.Mesh
- export type Text = xrFrameSystem.Text
- export type Particle = xrFrameSystem.Particle
- export type AssetRenderTexture = xrFrameSystem.AssetRenderTexture
- export type Env = xrFrameSystem.Env
- export type Animator = xrFrameSystem.Animator
- export type CameraOrbitControl = xrFrameSystem.CameraOrbitControl
- export type ARTracker = xrFrameSystem.ARTracker
- export type Shape = xrFrameSystem.Shape
- export type SphereShape = xrFrameSystem.SphereShape
- export type MeshShape = xrFrameSystem.MeshShape
- export type CapsuleShape = xrFrameSystem.CapsuleShape
- export type CubeShape = xrFrameSystem.CubeShape
- export type Rigidbody = xrFrameSystem.Rigidbody
- export type ShapeInteract = xrFrameSystem.ShapeInteract
- export type ShapeGizmos = xrFrameSystem.ShapeGizmos
- export type AssetPostProcess = xrFrameSystem.AssetPostProcess
- export type Scene = xrFrameSystem.Scene
- export type XRNode = xrFrameSystem.XRNode
- export type XRShadow = xrFrameSystem.XRShadow
- export type XRCamera = xrFrameSystem.XRCamera
- export type XRMesh = xrFrameSystem.XRMesh
- export type XRLight = xrFrameSystem.XRLight
- export type XRGLTF = xrFrameSystem.XRGLTF
- export type XRMaterial = xrFrameSystem.XRMaterial
- export type XRAssetRenderTexture = xrFrameSystem.XRAssetRenderTexture
- export type XRAssetLoad = xrFrameSystem.XRAssetLoad
- export type XRAssets = xrFrameSystem.XRAssets
- export type XREnv = xrFrameSystem.XREnv
- export type XRARTracker = xrFrameSystem.XRARTracker
- export type XRText = xrFrameSystem.XRText
- export type XRParticle = xrFrameSystem.XRParticle
- export type XRAssetPostProcess = xrFrameSystem.XRAssetPostProcess
- export type AssetsSystem = xrFrameSystem.AssetsSystem
- export type NodeSystem = xrFrameSystem.NodeSystem
- export type TickSystem = xrFrameSystem.TickSystem
- export type AnimationSystem = xrFrameSystem.AnimationSystem
- export type VideoSystem = xrFrameSystem.VideoSystem
- export type RenderSystem = xrFrameSystem.RenderSystem
- export type PhysicsSystem = xrFrameSystem.PhysicsSystem
- export type ARSystem = xrFrameSystem.ARSystem
- export type ShareSystem = xrFrameSystem.ShareSystem
- export type GizmoSystem = xrFrameSystem.GizmoSystem
- export type AssetLoader<T, ILoadOptions> = xrFrameSystem.AssetLoader<
- T,
- ILoadOptions
- >
- export type TextureLoader = xrFrameSystem.TextureLoader
- export type ImageLoader = xrFrameSystem.ImageLoader
- export type CubeTextureLoader = xrFrameSystem.CubeTextureLoader
- export type VideoTextureLoader = xrFrameSystem.VideoTextureLoader
- export type EnvDataLoader = xrFrameSystem.EnvDataLoader
- export type GLTFLoader = xrFrameSystem.GLTFLoader
- export type KeyframeLoader = xrFrameSystem.KeyframeLoader
- export type RawLoader = xrFrameSystem.RawLoader
- export type AtlasLoader = xrFrameSystem.AtlasLoader
- export interface IXrFrameSystem {
- registerComponent: typeof xrFrameSystem.registerComponent
- registerElement: typeof xrFrameSystem.registerElement
- registerDataValue: typeof xrFrameSystem.registerDataValue
- isTextureWrapper: typeof xrFrameSystem.isTextureWrapper
- genLspMeta: typeof xrFrameSystem.genLspMeta
- registerEffect: typeof xrFrameSystem.registerEffect
- registerGeometry: typeof xrFrameSystem.registerGeometry
- registerTexture: typeof xrFrameSystem.registerTexture
- registerMaterial: typeof xrFrameSystem.registerMaterial
- registerUniformDesc: typeof xrFrameSystem.registerUniformDesc
- registerVertexDataDesc: typeof xrFrameSystem.registerVertexDataDesc
- registerVertexLayout: typeof xrFrameSystem.registerVertexLayout
- // EDracoDataType: typeof xrFrameSystem.// EDracoDataType;
- // EDracoDecodeType: typeof xrFrameSystem.// EDracoDecodeType;
- // EDracoErrorCode: typeof xrFrameSystem.// EDracoErrorCode;
- // EDracoGeometryType: typeof xrFrameSystem.// EDracoGeometryType;
- // DracoDecoded: typeof xrFrameSystem.// DracoDecoded;
- registerAssetLoader: typeof xrFrameSystem.registerAssetLoader
- Component: typeof xrFrameSystem.Component
- Element: typeof xrFrameSystem.Element
- EventManager: typeof xrFrameSystem.EventManager
- Effect: typeof xrFrameSystem.Effect
- Geometry: typeof xrFrameSystem.Geometry
- Material: typeof xrFrameSystem.Material
- VideoTexture: typeof xrFrameSystem.VideoTexture
- RenderTexture: typeof xrFrameSystem.RenderTexture
- GLTFModel: typeof xrFrameSystem.GLTFModel
- EnvData: typeof xrFrameSystem.EnvData
- Animation: typeof xrFrameSystem.Animation
- KeyframeAnimation: typeof xrFrameSystem.KeyframeAnimation
- Atlas: typeof xrFrameSystem.Atlas
- PostProcess: typeof xrFrameSystem.PostProcess
- Vector2: typeof xrFrameSystem.Vector2
- Vector3: typeof xrFrameSystem.Vector3
- Vector4: typeof xrFrameSystem.Vector4
- Quaternion: typeof xrFrameSystem.Quaternion
- Matrix3: typeof xrFrameSystem.Matrix3
- Matrix4: typeof xrFrameSystem.Matrix4
- Color: typeof xrFrameSystem.Color
- OBB: typeof xrFrameSystem.OBB
- BoundBall: typeof xrFrameSystem.BoundBall
- BoundBox: typeof xrFrameSystem.BoundBox
- Spherical: typeof xrFrameSystem.Spherical
- Transform: typeof xrFrameSystem.Transform
- AssetLoad: typeof xrFrameSystem.AssetLoad
- Assets: typeof xrFrameSystem.Assets
- Camera: typeof xrFrameSystem.Camera
- GLTF: typeof xrFrameSystem.GLTF
- Light: typeof xrFrameSystem.Light
- AssetMaterial: typeof xrFrameSystem.AssetMaterial
- Mesh: typeof xrFrameSystem.Mesh
- Text: typeof xrFrameSystem.Text
- Particle: typeof xrFrameSystem.Particle
- AssetRenderTexture: typeof xrFrameSystem.AssetRenderTexture
- Env: typeof xrFrameSystem.Env
- Animator: typeof xrFrameSystem.Animator
- CameraOrbitControl: typeof xrFrameSystem.CameraOrbitControl
- ARTracker: typeof xrFrameSystem.ARTracker
- Shape: typeof xrFrameSystem.Shape
- SphereShape: typeof xrFrameSystem.SphereShape
- MeshShape: typeof xrFrameSystem.MeshShape
- CapsuleShape: typeof xrFrameSystem.CapsuleShape
- CubeShape: typeof xrFrameSystem.CubeShape
- Rigidbody: typeof xrFrameSystem.Rigidbody
- ShapeInteract: typeof xrFrameSystem.ShapeInteract
- ShapeGizmos: typeof xrFrameSystem.ShapeGizmos
- AssetPostProcess: typeof xrFrameSystem.AssetPostProcess
- Scene: typeof xrFrameSystem.Scene
- XRNode: typeof xrFrameSystem.XRNode
- XRShadow: typeof xrFrameSystem.XRShadow
- XRCamera: typeof xrFrameSystem.XRCamera
- XRMesh: typeof xrFrameSystem.XRMesh
- XRLight: typeof xrFrameSystem.XRLight
- XRGLTF: typeof xrFrameSystem.XRGLTF
- XRMaterial: typeof xrFrameSystem.XRMaterial
- XRAssetRenderTexture: typeof xrFrameSystem.XRAssetRenderTexture
- XRAssetLoad: typeof xrFrameSystem.XRAssetLoad
- XRAssets: typeof xrFrameSystem.XRAssets
- XREnv: typeof xrFrameSystem.XREnv
- XRARTracker: typeof xrFrameSystem.XRARTracker
- XRText: typeof xrFrameSystem.XRText
- XRParticle: typeof xrFrameSystem.XRParticle
- XRAssetPostProcess: typeof xrFrameSystem.XRAssetPostProcess
- AssetsSystem: typeof xrFrameSystem.AssetsSystem
- NodeSystem: typeof xrFrameSystem.NodeSystem
- TickSystem: typeof xrFrameSystem.TickSystem
- AnimationSystem: typeof xrFrameSystem.AnimationSystem
- VideoSystem: typeof xrFrameSystem.VideoSystem
- RenderSystem: typeof xrFrameSystem.RenderSystem
- PhysicsSystem: typeof xrFrameSystem.PhysicsSystem
- ARSystem: typeof xrFrameSystem.ARSystem
- ShareSystem: typeof xrFrameSystem.ShareSystem
- GizmoSystem: typeof xrFrameSystem.GizmoSystem
- AssetLoader: typeof xrFrameSystem.AssetLoader
- TextureLoader: typeof xrFrameSystem.TextureLoader
- ImageLoader: typeof xrFrameSystem.ImageLoader
- CubeTextureLoader: typeof xrFrameSystem.CubeTextureLoader
- VideoTextureLoader: typeof xrFrameSystem.VideoTextureLoader
- EnvDataLoader: typeof xrFrameSystem.EnvDataLoader
- GLTFLoader: typeof xrFrameSystem.GLTFLoader
- KeyframeLoader: typeof xrFrameSystem.KeyframeLoader
- RawLoader: typeof xrFrameSystem.RawLoader
- AtlasLoader: typeof xrFrameSystem.AtlasLoader
- EVideoState: typeof xrFrameSystem.EVideoState
- EVertexFormat: typeof xrFrameSystem.EVertexFormat
- EVertexStep: typeof xrFrameSystem.EVertexStep
- EIndexType: typeof xrFrameSystem.EIndexType
- ETextureType: typeof xrFrameSystem.ETextureType
- ETextureFormat: typeof xrFrameSystem.ETextureFormat
- EWrapMode: typeof xrFrameSystem.EWrapMode
- EFilterMode: typeof xrFrameSystem.EFilterMode
- EUniformType: typeof xrFrameSystem.EUniformType
- ECullMode: typeof xrFrameSystem.ECullMode
- EFaceWinding: typeof xrFrameSystem.EFaceWinding
- ECompareFunc: typeof xrFrameSystem.ECompareFunc
- EStencilOp: typeof xrFrameSystem.EStencilOp
- EBlendFactor: typeof xrFrameSystem.EBlendFactor
- EBlendEquation: typeof xrFrameSystem.EBlendEquation
- EColorMask: typeof xrFrameSystem.EColorMask
- EPixelType: typeof xrFrameSystem.EPixelType
- ELoadAction: typeof xrFrameSystem.ELoadAction
- EDataModelType: typeof xrFrameSystem.EDataModelType
- EMeshRenderType: typeof xrFrameSystem.EMeshRenderType
- EPrimitiveType: typeof xrFrameSystem.EPrimitiveType
- EShadowMode: typeof xrFrameSystem.EShadowMode
- EShadowFitMode: typeof xrFrameSystem.EShadowFitMode
- EVertexLayoutUsage: typeof xrFrameSystem.EVertexLayoutUsage
- EVertexBatchOperator: typeof xrFrameSystem.EVertexBatchOperator
- EAnimationBlendType: typeof xrFrameSystem.EAnimationBlendType
- EUseDefaultAddedAction: typeof xrFrameSystem.EUseDefaultAddedAction
- EUseDefaultRetainedAction: typeof xrFrameSystem.EUseDefaultRetainedAction
- EUseDefaultRemovedAction: typeof xrFrameSystem.EUseDefaultRemovedAction
- EEventType: typeof xrFrameSystem.EEventType
- EARTrackerState: typeof xrFrameSystem.EARTrackerState
- EShapeType: typeof xrFrameSystem.EShapeType
- ECapsuleShapeDirection: typeof xrFrameSystem.ECapsuleShapeDirection
- EShareRecordState: typeof xrFrameSystem.EShareRecordState
- useParamsEaseFuncs: typeof xrFrameSystem.useParamsEaseFuncs
- noneParamsEaseFuncs: typeof xrFrameSystem.noneParamsEaseFuncs
- TransformSchema: IComponentSchema
- AssetLoadSchema: IComponentSchema
- AssetsSchema: IComponentSchema
- CameraSchema: IComponentSchema
- GLTFSchema: IComponentSchema
- LightSchema: IComponentSchema
- AssetMaterialSchema: IComponentSchema
- MeshSchema: IComponentSchema
- TextSchema: IComponentSchema
- AssetRenderTextureSchema: IComponentSchema
- EnvSchema: IComponentSchema
- AnimatorSchema: IComponentSchema
- CameraOrbitControlSchema: IComponentSchema
- ARTrackSchema: IComponentSchema
- SphereShapeSchema: IComponentSchema
- MeshShapeSchema: IComponentSchema
- CapsuleShapeSchema: IComponentSchema
- CubeShapeSchema: IComponentSchema
- RigidbodySchema: IComponentSchema
- ShapeInteractSchema: IComponentSchema
- ParticleSchema: IComponentSchema
- RenderSystemSchema: IComponentSchema
- ARSystemSchema: IComponentSchema
- BasicDefaultComponents: IEntityComponents
- SceneDefaultComponents: IEntityComponents
- NodeDefaultComponents: IEntityComponents
- ShadowDefaultComponents: IEntityComponents
- CameraDefaultComponents: IEntityComponents
- MeshDefaultComponents: IEntityComponents
- LightDefaultComponents: IEntityComponents
- GLTFDefaultComponents: IEntityComponents
- AssetMaterialDefaultComponents: IEntityComponents
- AssetRenderTextureDefaultComponents: IEntityComponents
- AssetsDefaultComponents: IEntityComponents
- EnvDefaultComponents: IEntityComponents
- ARTrackerDefaultComponents: IEntityComponents
- TextDefaultComponents: IEntityComponents
- ParticleDefaultComponents: IEntityComponents
- AssetPostProcessDefaultComponents: IEntityComponents
- BasicDataMapping: { [key: string]: string[] }
- SceneDataMapping: { [key: string]: string[] }
- NodeDataMapping: { [key: string]: string[] }
- ShadowDataMapping: { [key: string]: string[] }
- CameraDataMapping: { [key: string]: string[] }
- MeshDataMapping: { [key: string]: string[] }
- LightDataMapping: { [key: string]: string[] }
- GLTFDataMapping: { [key: string]: string[] }
- AssetMaterialDataMapping: { [key: string]: string[] }
- AssetRenderTextureDataMapping: { [key: string]: string[] }
- AssetLoadDataMapping: { [key: string]: string[] }
- EnvDataMapping: { [key: string]: string[] }
- ARTrackerDataMapping: { [key: string]: string[] }
- TextDataMapping: { [key: string]: string[] }
- ParticleDataMapping: { [key: string]: string[] }
- AssetPostProcessDataMapping: { [key: string]: string[] }
- }
- }
- declare module 'XrFrame/xrFrameSystem' {
- /**
- * xrFrameSystem.ts
- *
- * * @Date : 4/28/2022, 5:02:28 PM
- */
- import { Kanata } from 'XrFrame/ext'
- export {
- default as Component,
- registerComponent,
- IComponentSchema
- } from 'XrFrame/core/Component'
- export {
- default as Element,
- registerElement,
- IEntityComponents,
- BasicDefaultComponents,
- BasicDataMapping
- } from 'XrFrame/core/Element'
- export {
- registerDataValue,
- IDataValueHandler,
- ITextureWrapper,
- isTextureWrapper
- } from 'XrFrame/core/DataValue'
- export {
- default as EventManager,
- TEventCallback
- } from 'XrFrame/core/EventManager'
- export { genLspMeta } from 'XrFrame/genLspMeta'
- export * from 'XrFrame/components'
- export * from 'XrFrame/elements'
- export * from 'XrFrame/systems'
- export * from 'XrFrame/loader'
- export {
- default as Effect,
- IEffectAsset,
- IRenderStates
- } from 'XrFrame/assets/Effect'
- export { default as Geometry, ISubMesh } from 'XrFrame/assets/Geometry'
- export { default as Material } from 'XrFrame/assets/Material'
- export {
- default as VideoTexture,
- IVideoTextureOptions,
- EVideoState
- } from 'XrFrame/assets/VideoTexture'
- export {
- default as RenderTexture,
- IRenderTarget,
- IRenderTextureOptions
- } from 'XrFrame/assets/RenderTexture'
- export {
- default as GLTFModel,
- IGLTFModelOptions
- } from 'XrFrame/assets/GLTFModel'
- export { default as EnvData, IEnvDataOptions } from 'XrFrame/assets/EnvData'
- export {
- default as Animation,
- TDirection
- } from 'XrFrame/animation/Animation'
- export {
- default as KeyframeAnimation,
- IKeyframeAnimationData,
- IKeyframeAnimationInfo,
- IKeyframeAnimationOptions
- } from 'XrFrame/animation/KeyframeAnimation'
- export {
- default as Atlas,
- IAtlasOptions,
- IAtlasCreationOptions
- } from 'XrFrame/assets/Atlas'
- export {
- default as PostProcess,
- IPostProcessOptions
- } from 'XrFrame/assets/PostProcess'
- export {
- registerEffect,
- registerGeometry,
- registerTexture,
- registerMaterial,
- registerUniformDesc,
- registerVertexDataDesc,
- registerVertexLayout
- } from 'XrFrame/assets/factories'
- export {
- useParamsEaseFuncs,
- noneParamsEaseFuncs
- } from 'XrFrame/assets/easeFunctions'
- export * from 'XrFrame/physics/exports'
- export { default as Vector2 } from 'XrFrame/math/vector2'
- export { default as Vector3 } from 'XrFrame/math/vector3'
- export { default as Vector4 } from 'XrFrame/math/vector4'
- export { default as Quaternion } from 'XrFrame/math/quaternion'
- export { default as Matrix3 } from 'XrFrame/math/matrix3'
- export { default as Matrix4 } from 'XrFrame/math/matrix4'
- export { default as Color } from 'XrFrame/math/color'
- export { default as OBB } from 'XrFrame/math/OBB'
- export { default as BoundBall } from 'XrFrame/math/boundBall'
- export { default as BoundBox } from 'XrFrame/math/boundBox'
- export { default as Spherical } from 'XrFrame/math/Spherical'
- export {
- ITextureOptions,
- IEngineSettings,
- EVertexFormat,
- EVertexStep,
- EIndexType,
- ETextureType,
- ETextureFormat,
- EWrapMode,
- EFilterMode,
- EUniformType,
- ECullMode,
- EFaceWinding,
- ECompareFunc,
- EStencilOp,
- EBlendFactor,
- EBlendEquation,
- EColorMask,
- EPixelType,
- ELoadAction,
- EDataModelType,
- EMeshRenderType,
- EPrimitiveType,
- EShadowMode,
- EShadowFitMode,
- EVertexLayoutUsage,
- EVertexBatchOperator,
- EAnimationBlendType,
- EUseDefaultAddedAction,
- EUseDefaultRetainedAction,
- EUseDefaultRemovedAction,
- IHandle,
- IVertexLayoutOptions,
- IVertexDataDescriptorOptions,
- IUniformDescriptorOptions,
- IImage,
- IRealDownloader,
- IDownloader,
- IFontSetting,
- IFeatures,
- IRect,
- IViewAction,
- IView,
- IAttachment,
- IRenderPassDescriptor,
- EEventType,
- IGlyphInfo,
- IEventBridge,
- INativeMap,
- ILongIntNativeMap
- } from 'XrFrame/kanata/lib/kanata'
- export type Texture = Kanata.Texture
- export type UniformDescriptor = Kanata.UniformDescriptor
- export type UniformBlock = Kanata.UniformBlock
- export type VertexLayout = Kanata.VertexLayout
- }
- declare module 'XrFrame/ext' {
- /**
- * ext.ts
- *
- * * @Date : 2022/3/17下午1:43:48
- */
- import * as Kanata from 'XrFrame/kanata/lib/kanata'
- const exparser: any
- type Scene = import('XrFrame/core/Scene').default
- const _wx: any
- const Phys3D: any
- function addKanata(scene: Scene, kanata: Kanata.IKanataInstance): void
- function removeKanata(scene: Scene): void
- function getKanata(scene: Scene): Kanata.IKanataInstance
- function __getKanataSuperHackDontUseIt(): Kanata.IKanataInstance
- export {
- Kanata,
- exparser,
- Phys3D,
- _wx,
- addKanata,
- removeKanata,
- getKanata,
- __getKanataSuperHackDontUseIt
- }
- }
- declare module 'XrFrame/core/Component' {
- type Element = import('XrFrame/core/Element').default
- /**
- * `Component`属性的注解接口。
- *
- * `key`是可以写在组件对应于`xml`中的属性的名字。
- * `type`是属性的类型,由{@link registerDataValue}注册。
- * 可选的`defaultValue`可以定义默认值。
- */
- export interface IComponentSchema {
- [key: string]: {
- type: string
- defaultValue?: any
- }
- }
- /**
- * 组件,系统核心之一。
- *
- * 组件就是`wxml`的标签上写的那些`attribute`,比如`<xr-element transform="position: 1 1 1" />`中,`transform`就是一个组件,`position`是它的一个属性。
- * 这些属性可以在`schema`中被定义,变化时会触发对应的生命周期。
- * 自定义组件最后使用{@link registerComponent},组件的属性可以使用代理规则来简化,比如以上的标签可以简化为`<xr-element position="1 1 1" />`,详见{@link Element}。
- *
- * @template IData 组件数据的类型,应当和`schema`中一致,用于TS类型推断。
- */
- export default class Component<IData> {
- /**
- * @internal
- */
- static TYPE: string
- static EVENTS: string[]
- /**
- * @internal
- */
- static SPLIT_DATA(dataStr: string): {
- [key: string]: string
- }
- /**
- * 自定义组件的`schema`。
- */
- readonly schema: IComponentSchema
- /**
- * 自定义组件的更新优先级。
- */
- readonly priority: number
- __DATA_TYPE: IData
- protected _version: number
- protected _currentData: IData
- /**
- * 挂载的元素。
- */
- get el(): import('XrFrame/core/Element').default
- /**
- * 当前场景。
- */
- get scene(): import('XrFrame/core/Scene').default
- /**
- * 当前版本,每次有数据更新都会增加,可以用作和其他组件合作的依据。
- */
- get version(): number
- /**
- * 不通过`xml`而是直接设置`data`,注意值的类型需要和`schema`中一致。
- */
- setData(data: Partial<IData>): void
- /**
- * 设置一个数据。
- */
- setDataOne<T extends keyof IData>(key: T, value: IData[T]): void
- /**
- * 获取一个当前值。
- */
- getData<T extends keyof IData>(key: T): IData[T]
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- * 仅针对某些hack情况!
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * 所挂载的`element`被挂载到场景时触发的回调。
- */
- onAdd(parent: Element, data: IData): void
- /**
- * 数据更新时触发的回调。
- */
- onUpdate(data: IData, preData: IData): void
- /**
- * 渲染每帧触发的回调。
- * @param deltaTime 单位为毫秒(ms)。
- */
- onTick(deltaTime: number, data: IData): void
- /**
- * 所挂载的`element`从父节点`parent`被移除时,或者自己从`element`上被移除时,触发的回调。
- * 一般用于消除功能的运作。
- * **如果一个组件的元素直接被销毁了,那这个组件就不会经历onRemove而是直接进入onRelease。**
- */
- onRemove(parent: Element, data: IData): void
- /**
- * 从被挂载的`element`上被移除,或是`element`被销毁时,触发的回调。
- * 一般用于释放持有的资源。
- */
- onRelease(data: IData): void
- }
- export const TABLE: {
- [type: string]: new () => Component<any>
- }
- /**
- * @internal
- */
- export function getComponent(type: string): new () => Component<any>
- /**
- * 向系统中注册一个组件,然后可以在`xml`中使用。
- */
- export function registerComponent(
- type: string,
- clz: new () => Component<any>
- ): void
- export {}
- }
- declare module 'XrFrame/core/Element' {
- /**
- * Element.ts
- *
- * * @Date : 2022/4/1上午10:34:06
- */
- import Component from 'XrFrame/core/Component'
- import EventManager, {
- TFrameworkEventTrigger
- } from 'XrFrame/core/EventManager'
- /**
- * `Element`的默认组件集接口。
- *
- * `name`是组件注册时的名字,`key`是要默认设置的组件的属性名字,值是默认值,但应当和`xml`中一致,为**字符串**。
- */
- export interface IEntityComponents {
- [name: string]: {
- [key: string]: string
- }
- }
- /**
- * 空的默认组件集。
- */
- export const BasicDefaultComponents: IEntityComponents
- /**
- * 空的默认组件映射。
- */
- export const BasicDataMapping: {
- [key: string]: string[]
- }
- /**
- * 元素,系统核心之一。
- *
- * 本质上就是对应于`xml`中标签,所有的标签的实现都是继承自`Element`的,其一般不包含逻辑,仅仅是通过`defaultComponents`和`dataMapping`定义组件的集合与映射。
- * 自定义元素最后使用{#@link registerElement}。
- */
- export default class Element {
- static TYPE: string
- /**
- * `Element`的默认组件集合,详见{@link IEntityComponents}。
- */
- readonly defaultComponents: IEntityComponents
- /**
- * `Element`的数据映射。它是为了给组件的属性提供一个方便的用法,比如:
- * ```ts
- * {
- * position: [transform, position]
- * }
- * ```
- * 就是将`xml`中写在这个`Element`的`position`直接映射到了`transform`组件的`position`属性上。
- *
- * **通常来讲,所有的驼峰如`nodeId`都会被映射为小写加中划线`node-id`**。
- */
- readonly dataMapping: {
- [key: string]: string[]
- }
- /**
- * @internal
- */
- readonly neverTick: boolean
- /**
- * 名字,写在`xml`上的那个`name`,不唯一。
- */
- get name(): string
- set name(value: string)
- /**
- * @internal
- */
- /**
- * 元素是否在`xml`中,若是`xr-shadow`下的节点,则为`false`。
- */
- get inXML(): boolean
- /**
- * 场景实例。
- */
- get scene(): import('XrFrame/core/Scene').default
- /**
- * 父元素。
- */
- get parent(): Element
- /**
- * 事件管理器。
- */
- get event(): EventManager
- constructor(_type: string, triggerEvent: TFrameworkEventTrigger)
- /**
- * 获取第`index`个子元素。
- */
- getChildAtIndex<T extends Element = Element>(index: number): T
- /**
- * 通过`filter`获取子元素。
- */
- getChildByFilter<T extends Element = Element>(
- filter: (child: Element) => boolean
- ): T
- /**
- * 通过`filter`获取子元素列表。
- */
- getChildrenByFilter(filter: (child: Element) => boolean): Element[]
- /**
- * 通过元素的类获取子元素。
- */
- getChildByClass<T extends Element = Element>(
- clz: new (...args: any[]) => T
- ): T
- /**
- * 通过元素的名字`name`获取子元素。
- */
- getChildByName<T extends Element = Element>(name: string): T
- /**
- * 通过元素的名字`name`获取子元素们。
- */
- getChildrenByName(name: string): Element[]
- /**
- * 递归遍历元素的所有子孙节点。
- */
- dfs<T extends any>(
- callback: (element: Element, params?: T) => T,
- defaultParams?: T,
- excludeRoot?: boolean,
- stop?: (element: Element, params?: T) => boolean
- ): void
- /**
- * 手动添加一个`Component`。
- */
- addComponent<T extends Component<any>>(
- clz: new () => T,
- options?: T['__DATA_TYPE']
- ): T
- /**
- * 获取一个`Component`,可以使用类或者名字获取。
- */
- getComponent<T extends Component<any>>(clzName: string): T
- getComponent<T extends Component<any>>(clz: new () => T): T
- /**
- * 手动移除一个`Component`,注意保证其不在`xml`上。
- */
- removeComponent(clz: new () => Component<any>): void
- /**
- * 设置一个属性,对应于`xml`标签中的那些属性,值为字符串。
- * **一般建议使用`component`的`setData`方法**!!!
- */
- setAttribute(name: string, value: string): void
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- _associateValue(_v: any): void
- /**
- * 手动添加一个子节点,**注意需要保证当前节点是`xr-shadow`或其子节点**。
- */
- addChild(child: Element): void
- /**
- * 手动移除一个子节点,**注意需要保证当前节点是`xr-shadow`或其子节点**。
- * **只调用removeChild没有办法走进子节点的onRelease里**,需要手动调用子节点的release才行。
- */
- removeChild(child: Element): void
- /**
- * 仅限自己创建的节点使用,否则后果自负。
- */
- setId(id: string): void
- /**
- * 仅限自己创建的节点使用,否则后果自负。
- */
- release(): void
- /**
- * @internal
- */
- _appendChild(_child: Element, custom?: boolean): void
- /**
- * @internal
- */
- _removeChild(_child: Element, _index?: number, custom?: boolean): void
- /**
- * @internal
- */
- _insertBefore(_child: Element, _before?: Element, _index?: number): void
- /**
- * @internal
- */
- _replaceChild(
- _child: Element,
- _oldChild?: Element,
- _index?: number
- ): void
- /**
- * @internal
- */
- _spliceBefore(
- _before: number | Element,
- _deleteCount: number,
- _list: Element
- ): void
- /**
- * @internal
- */
- _spliceAppend(_list: Element): void
- /**
- * @internal
- */
- _spliceRemove(_before: Element, _deleteCount: number): void
- /**
- * @internal
- */
- _setId(_id: string): void
- /**
- * @internal
- */
- _setStyleScope(_styleScope: number): void
- /**
- * @internal
- */
- _setStyle(_styleText: string): void
- /**
- * @internal
- */
- _addClass(_elementClass: string, _styleScope?: number): void
- /**
- * @internal
- */
- _removeClass(_elementClass: string, _styleScope?: number): void
- /**
- * @internal
- */
- /**
- * @internal
- */
- _setAttribute(_name: string, _value: string): void
- _removeAttribute(_name: string): void
- _setText(_content: string): void
- }
- export const TABLE: {
- [type: string]: typeof Element
- }
- export function getElement(type: string): typeof Element
- /**
- * 注册一个自定义元素。
- * 注意注册的`type`在`xml`中使用时需要加上`xr-`前缀,比如注册`custom`类型的元素,使用时需要时`xr-custom`。
- */
- export function registerElement(type: string, clz: typeof Element): void
- }
- declare module 'XrFrame/core/DataValue' {
- /**
- * DataValue.ts
- *
- * * @Date : 2022/3/17下午2:22:19
- */
- import { Kanata } from 'XrFrame/ext'
- import Scene from 'XrFrame/core/Scene'
- /**
- * 详见{@link registerDataValue}。
- */
- export interface IDataValueHandler<TDataValue> {
- create(value: string, defaultValue: any, scene: Scene): TDataValue
- }
- export interface ITextureWrapper {
- texture: Kanata.Texture
- }
- export function isTextureWrapper(value: any): value is ITextureWrapper
- export function isDataValueHandlerExisted(type: string): boolean
- /**
- * 为组件在`xml`中写的属性值按类型注册解析器,由于`xml`传入的值全部都是字符串,所以需要解析,比如:
- * ```ts
- * registerDataValue('number', {create: (value: string, defaultValue: any, scene: Scene) => {
- * return value === undefined ? defaultValue : parseFloat(value));
- * }});
- * ```
- * 就是注册了`number`类型,后续在组件的`schema`中写的`number`类型数据,就会走这个解析器。
- * **注意最后一个参数`scene`可以用于获取资源等,比如`scene.assets.getAssetWithState(type, value, defaultValue)`。**
- * **如果是被资源加载器加载的资源,则会在资源加载器注册时自动注册数据类型,详见{@link AssetLoader}**。
- *
- * 已经注册的类型可见[组件数据解析](../../../component/xr-frame/core/data-values)。
- */
- export function registerDataValue<TDataValue>(
- type: string,
- handler: IDataValueHandler<TDataValue>
- ): void
- export function parseDataValue<TDataValue>(
- type: string,
- value: string,
- defaultValue: any,
- scene: Scene
- ): TDataValue
- }
- declare module 'XrFrame/core/EventManager' {
- /**
- * EventManager.ts
- *
- * * @Date : 2022/3/17下午3:54:03
- */
- import Observable from 'XrFrame/core/Observable'
- type Element = import('XrFrame/core/Element').default
- /**
- * 事件管理器的回调。
- */
- export type TEventCallback<TParams> = (
- params: TParams,
- sender: Element
- ) => void
- export type TFrameworkEventTrigger = (
- name: string,
- details: any,
- options: {
- bubbles?: boolean
- composed?: boolean
- capturePhase?: boolean
- }
- ) => void
- /**
- * 事件管理器。
- *
- * 每个`Element`都有自己的事件管理器,通过参数可以触发到`xml`。
- */
- export default class EventManager {
- isEventManager: boolean
- protected _observables: {
- [type: string]: Observable
- }
- protected _caches: {
- [type: string]: {
- value: any
- toXML: boolean
- bubbles: boolean
- }
- }
- protected _wxmlBind: {
- [type: string]: boolean
- }
- constructor(_el: Element, _triggerElementEvent: TFrameworkEventTrigger)
- /**
- * 添加一个事件监听器。
- */
- add<TEvent = any>(
- type: string,
- callback: TEventCallback<TEvent>,
- priority?: number
- ): this
- /**
- * 添加一个事件监听器,触发一次后自动移除。
- */
- addOnce<TEvent = any>(
- type: string,
- callback: TEventCallback<TEvent>,
- priority?: number
- ): this
- /**
- * 移除一个事件监听器。
- */
- remove<TEvent = any>(
- type: string,
- callback: TEventCallback<TEvent>
- ): this
- /**
- * 判断一个事件是否被注册。
- * 注册是指用户绑定过了至少一个事件处理器,无论是来自于wxml还是JS。
- */
- has(type: string): boolean
- /**
- * 获取一个事件监听者数量。
- * @internal
- */
- getCount(type: string): number
- /**
- * 清空某事件的所有监听器。
- */
- clear(type: string): this
- /**
- * 触发一个事件。
- *
- * @param type 要触发的事件类型。
- * @param event 事件的值。
- * @param immediately 是否要将事件立即分发,如果不则会先缓存,之后在每一帧更新前统一分发,避免不必要的分发。
- * @param toXML 是否要派发到`xml`绑定的事件中。
- * @param bubbles 是否要进行事件冒泡。
- */
- trigger<TEvent = any>(
- type: string,
- event?: TEvent,
- immediately?: boolean,
- toXML?: boolean,
- bubbles?: boolean
- ): this
- /**
- * 分发某个缓存的事件,一般不需要自行触发。
- */
- flush(type: string): this
- /**
- * 分发所有缓存的事件,一般不需要自行触发。
- */
- flushAll(): this
- }
- export {}
- }
- declare module 'XrFrame/genLspMeta' {
- import { Scene } from 'XrFrame/elements'
- export interface IXRFrameMeta {
- elements: {
- name: string[]
- meta: {
- [name: string]: IXRFrameElement
- }
- }
- components: {
- name: string[]
- meta: {
- [name: string]: IXRFrameComponent
- }
- }
- }
- export interface IXRFrameElement {
- defaultComps: string[]
- mappings: {
- name: string[]
- meta: {
- [name: string]: string[]
- }
- }
- events: string[]
- limitComps?: string[]
- }
- export interface IXRFrameComponent {
- keys: string[]
- meta: {
- [key: string]: IXRFrameData
- }
- events: string[]
- }
- export interface IXRFrameData {
- type: string
- defaultValue: any
- map?: IXRFrameMap
- enum?: IXRFrameEnum
- }
- export interface IXRFrameMap {
- keys: string[]
- meta: {
- [key: string]: {
- type: string
- defaultValue?: string | number
- enum?: IXRFrameEnum
- }
- }
- }
- export interface IXRFrameEnum {
- values: Array<{
- value: string | number
- desc?: string
- }>
- }
- export function genLspMeta(scene: Scene): IXRFrameMeta
- }
- declare module 'XrFrame/components' {
- export {
- default as Transform,
- ITransformData,
- TransformSchema
- } from 'XrFrame/components/Transform'
- export {
- default as AssetLoad,
- AssetLoadSchema
- } from 'XrFrame/components/AssetLoad'
- export {
- default as Assets,
- IAssetsData,
- AssetsSchema
- } from 'XrFrame/components/Assets'
- export {
- default as Camera,
- ICameraData,
- CameraSchema,
- TCameraBackground
- } from 'XrFrame/components/Camera'
- export {
- default as GLTF,
- IGLTFData,
- GLTFSchema
- } from 'XrFrame/components/GLTF'
- export {
- default as Light,
- ILightData,
- LightSchema
- } from 'XrFrame/components/Light'
- export {
- default as AssetMaterial,
- IAssetMaterialData,
- AssetMaterialSchema
- } from 'XrFrame/components/AssetMaterial'
- export {
- default as Mesh,
- IMeshData,
- MeshSchema
- } from 'XrFrame/components/Mesh'
- export {
- default as Text,
- ITextData,
- TextSchema
- } from 'XrFrame/components/text/Text'
- export { default as Particle } from 'XrFrame/components/particle/Particle'
- export {
- IParticleData,
- ParticleSchema
- } from 'XrFrame/components/particle/BasicParticle'
- export {
- default as AssetRenderTexture,
- IAssetRenderTextureData,
- AssetRenderTextureSchema
- } from 'XrFrame/components/AssetRenderTexture'
- export { default as Env, IEnvData, EnvSchema } from 'XrFrame/components/Env'
- export {
- default as Animator,
- IAnimatorData,
- AnimatorSchema,
- IAnimationPlayOptions,
- IAnimatorAutoPlay
- } from 'XrFrame/components/Animator'
- export {
- default as CameraOrbitControl,
- ICameraOrbitControlData,
- CameraOrbitControlSchema
- } from 'XrFrame/components/CameraOrbitControl'
- export {
- default as ARTracker,
- IARTrackerData,
- ARTrackSchema,
- TTrackMode,
- EARTrackerState,
- IARTrackerRawData
- } from 'XrFrame/components/ARTracker'
- export {
- default as Shape,
- IShapeData,
- EShapeType
- } from 'XrFrame/components/physics/Shape'
- export {
- default as SphereShape,
- ISphereShapeData,
- SphereShapeSchema
- } from 'XrFrame/components/physics/SphereShape'
- export {
- default as MeshShape,
- IMeshShapeData,
- MeshShapeSchema
- } from 'XrFrame/components/physics/MeshShape'
- export {
- default as CapsuleShape,
- ICapsuleShapeData,
- CapsuleShapeSchema,
- ECapsuleShapeDirection
- } from 'XrFrame/components/physics/CapsuleShape'
- export {
- default as CubeShape,
- ICubeShapeData,
- CubeShapeSchema
- } from 'XrFrame/components/physics/CubeShape'
- export {
- default as Rigidbody,
- IRigidbodyData,
- RigidbodySchema
- } from 'XrFrame/components/physics/Rigidbody'
- export {
- default as ShapeInteract,
- IShapeInteractData,
- ShapeInteractSchema
- } from 'XrFrame/components/physics/ShapeInteract'
- export {
- default as ShapeGizmos,
- IShapeGizmosData
- } from 'XrFrame/components/gizmo/ShapeGizmos'
- export {
- default as AssetPostProcess,
- IAssetPostProcessData
- } from 'XrFrame/components/AssetPostProcess'
- }
- declare module 'XrFrame/elements' {
- export {
- default as Scene,
- SceneDataMapping,
- SceneDefaultComponents
- } from 'XrFrame/core/Scene'
- export {
- default as XRNode,
- NodeDataMapping,
- NodeDefaultComponents
- } from 'XrFrame/elements/xr-node'
- export {
- default as XRShadow,
- ShadowDataMapping,
- ShadowDefaultComponents
- } from 'XrFrame/elements/xr-shadow'
- export {
- default as XRCamera,
- CameraDataMapping,
- CameraDefaultComponents
- } from 'XrFrame/elements/xr-camera'
- export {
- default as XRMesh,
- MeshDataMapping,
- MeshDefaultComponents
- } from 'XrFrame/elements/xr-mesh'
- export {
- default as XRLight,
- LightDataMapping,
- LightDefaultComponents
- } from 'XrFrame/elements/xr-light'
- export {
- default as XRGLTF,
- GLTFDataMapping,
- GLTFDefaultComponents
- } from 'XrFrame/elements/xr-gltf'
- export {
- default as XRMaterial,
- AssetMaterialDataMapping,
- AssetMaterialDefaultComponents
- } from 'XrFrame/elements/xr-asset-material'
- export {
- default as XRAssetRenderTexture,
- AssetRenderTextureDataMapping,
- AssetRenderTextureDefaultComponents
- } from 'XrFrame/elements/xr-asset-render-texture'
- export {
- default as XRAssetLoad,
- AssetLoadDataMapping
- } from 'XrFrame/elements/xr-asset-load'
- export {
- default as XRAssets,
- AssetsDefaultComponents
- } from 'XrFrame/elements/xr-assets'
- export {
- default as XREnv,
- EnvDataMapping,
- EnvDefaultComponents
- } from 'XrFrame/elements/xr-env'
- export {
- default as XRARTracker,
- ARTrackerDataMapping,
- ARTrackerDefaultComponents
- } from 'XrFrame/elements/xr-ar-tracker'
- export {
- default as XRText,
- TextDataMapping,
- TextDefaultComponents
- } from 'XrFrame/elements/xr-text'
- export {
- default as XRParticle,
- ParticleDataMapping,
- ParticleDefaultComponents
- } from 'XrFrame/elements/xr-particle'
- export {
- default as XRAssetPostProcess,
- AssetPostProcessDataMapping,
- AssetPostProcessDefaultComponents
- } from 'XrFrame/elements/xr-asset-post-process'
- }
- declare module 'XrFrame/systems' {
- export {
- default as AssetsSystem,
- IAssetsSystemData
- } from 'XrFrame/systems/AssetsSystem'
- export {
- default as NodeSystem,
- INodeSystemData
- } from 'XrFrame/systems/NodeSystem'
- export {
- default as TickSystem,
- ITickSystemData
- } from 'XrFrame/systems/TickSystem'
- export {
- default as AnimationSystem,
- IAnimationSystemData
- } from 'XrFrame/systems/AnimationSystem'
- export {
- default as VideoSystem,
- IVideoSystemData
- } from 'XrFrame/systems/VideoSystem'
- export {
- default as RenderSystem,
- IRenderSystemData,
- RenderSystemSchema
- } from 'XrFrame/systems/RenderSystem'
- export {
- default as PhysicsSystem,
- IPhysicsSystemData,
- IShapeDragEvent,
- IShapeTouchEvent
- } from 'XrFrame/systems/PhysicsSystem'
- export {
- default as ARSystem,
- IARSystemData,
- ARSystemSchema,
- IARRawData
- } from 'XrFrame/systems/ARSystem'
- export {
- default as ShareSystem,
- IShareSystemData,
- IShareCaptureOptions,
- IShareRecordOptions,
- EShareRecordState
- } from 'XrFrame/systems/ShareSystem'
- export {
- default as GizmoSystem,
- IGizmoSystemData
- } from 'XrFrame/systems/GizmoSystem'
- }
- declare module 'XrFrame/loader' {
- export {
- default as AssetLoader,
- ILoaderOptionsSchema,
- registerAssetLoader
- } from 'XrFrame/loader/AssetLoader'
- export {
- default as TextureLoader,
- ITextureLoaderOptions
- } from 'XrFrame/loader/TextureLoader'
- export {
- default as ImageLoader,
- IImageLoaderOptions
- } from 'XrFrame/loader/ImageLoader'
- export {
- default as CubeTextureLoader,
- ICubeTextureLoaderOptions
- } from 'XrFrame/loader/CubeTextureLoader'
- export {
- default as VideoTextureLoader,
- IVideoTextureLoaderOptions
- } from 'XrFrame/loader/VideoTextureLoader'
- export {
- default as EnvDataLoader,
- IEnvDataLoaderOptions
- } from 'XrFrame/loader/EnvDataLoader'
- export {
- default as GLTFLoader,
- IGLTFLoaderOptions
- } from 'XrFrame/loader/GlTFLoader'
- export {
- default as KeyframeLoader,
- IKeyframeLoaderOptions
- } from 'XrFrame/loader/KeyframeLoader'
- export {
- default as RawLoader,
- IRawLoaderOptions
- } from 'XrFrame/loader/RawLoader'
- export {
- default as AtlasLoader,
- IAtlasLoaderOptions
- } from 'XrFrame/loader/AtlasLoader'
- }
- declare module 'XrFrame/assets/Effect' {
- /**
- * Effect.ts
- *
- * * @Date : 2022/3/16下午4:44:48
- */
- import { ITextureWrapper } from 'XrFrame/core/DataValue'
- import { Kanata } from 'XrFrame/ext'
- import { IAssetWithState } from 'XrFrame/loader/types'
- type Scene = import('XrFrame/core/Scene').default
- /**
- * 支持定制的渲染状态。
- *
- * 大部分状态会定制的开发者应该看名字就懂,就不详细说明了。
- */
- export interface IRenderStates {
- /**
- * 渲染队列,大于等于`2500`为透明物体,否则为非透明物体。
- */
- renderQueue?: number
- blendOn?: boolean
- /**
- * 不要使用,使用`blendSrcRGB`。
- */
- blendSrc?: Kanata.EBlendFactor
- blendSrcRGB?: Kanata.EBlendFactor
- blendSrcAlpha?: Kanata.EBlendFactor
- /**
- * 不要使用,使用`blendDstRGB`。
- */
- blendDst?: Kanata.EBlendFactor
- blendDstRGB?: Kanata.EBlendFactor
- blendDstAlpha?: Kanata.EBlendFactor
- blendFunc?: Kanata.EBlendEquation
- cullOn?: boolean
- cullFace?: Kanata.ECullMode
- depthWrite?: boolean
- depthTestOn?: boolean
- depthTestComp?: Kanata.ECompareFunc
- /**
- * 在基础库版本`v2.31.1`以上支持。
- */
- colorWrite?: number
- stencilWriteMask?: number
- stencilTestOn?: boolean
- stencilRef?: number
- stencilReadMask?: number
- stencilComp?: Kanata.ECompareFunc
- stencilPass?: Kanata.EStencilOp
- stencilFail?: Kanata.EStencilOp
- stencilZFail?: Kanata.EStencilOp
- primitiveType?: Kanata.EPrimitiveType
- }
- /**
- * `Effect`资源的参数接口。
- */
- export interface IEffectAsset {
- /**
- * 名字,应当和`registerEffect`时的名字一致。
- */
- name: string
- /**
- * 属性,传给UniformBlock的一部分。
- */
- properties?: Array<{
- /**
- * 属性名字。
- */
- key: string
- /**
- * 属性类型。
- */
- type: Kanata.EUniformType
- /**
- * 如果属性是一个数组,比如`FLOAT4`数组,可以指定数组大小。
- */
- num?: number
- /**
- * 属性默认值,需要和类型匹配。
- */
- default: number[]
- /**
- * 属性对应的宏,当默认值被覆盖时,此宏开关会被开启,注意一定要有`WX_`前缀!
- */
- macro?: string
- }>
- /**
- * 纹理资源,传给UniformBlock的另一部分。
- */
- images?: Array<{
- /**
- * 属性名字。
- */
- key: string
- /**
- * 属性默认值,是`Texture`类型资源的`asset-id`。
- */
- default: string
- /**
- * 属性对应的宏,当默认值被覆盖时,此宏开关会被开启,注意一定要有`WX_`前缀!
- */
- macro?: string
- }>
- /**
- * 使用该`Effect`的`Material`的默认渲染队列。
- * 透明物体需要大于`2500`!
- */
- defaultRenderQueue: number
- /**
- * 渲染时的`passes`,渲染时指定的`lightMode`的每个`pass`都会被按顺序绘制。
- */
- passes: Array<{
- /**
- * 渲染的光照模式。
- */
- lightMode:
- | 'ForwardBase'
- | 'ForwardAdd'
- | 'ShadowCaster'
- | 'PostProcess'
- | 'Skybox'
- | string
- /**
- * 这个pass的渲染状态是否可以被`Material`覆盖。
- */
- useMaterialRenderStates: boolean
- /**
- * 这个pass的默认渲染状态。
- */
- renderStates?: IRenderStates
- /**
- * 这个pass的使用的`shader`在`shaders`中的索引,第一个是顶点着色器,第二个是片段着色器。
- */
- shaders: [number, number]
- }>
- /**
- * 所有的`shader`列表。
- */
- shaders: string[]
- }
- /**
- * 特效资源,定义了渲染所需的大部分参数,被{@link Material}所引用。
- */
- export default class Effect {
- protected _scene: Scene
- readonly description: IEffectAsset
- /**
- * 获取名称。
- */
- get name(): string
- /**
- * 获取场景实例。
- */
- get scene(): import('XrFrame/core/Scene').default
- /**
- * Backend对应的对象。
- * @internal
- */
- get kanataEffect(): import('XrFrame/kanata/lib/index').Effect
- /**
- * 有几个Pass。
- */
- get passCount(): number
- /**
- * 正在加载中的纹理。
- * @internal
- */
- get loadingTextures(): {
- [key: string]: IAssetWithState<
- import('XrFrame/kanata/lib/index').Texture | ITextureWrapper
- >
- }
- /**
- * 用于UniformBlock构建时传入
- * @internal
- */
- _shaderUniformBlockDesc?: Kanata.UniformDescriptor
- /**
- * 是否没有properties。
- * @internal
- */
- _isNoProperties: boolean
- /**
- * 是否没有images。
- * @internal
- */
- _isNoImages: boolean
- /**
- * 根据特效配置生成特效资源。
- * **注意,不建议自己创建,请使用`scene.createEffect`。**
- *
- * @param description 配置。
- */
- constructor(_scene: Scene, description: IEffectAsset)
- /**
- * 材质调用方法,拷贝默认UniformBlock。
- * @internal
- */
- /**
- * @internal
- */
- /**
- * 预编译
- */
- warmUp(): boolean
- }
- export {}
- }
- declare module 'XrFrame/assets/Geometry' {
- import { Kanata } from 'XrFrame/ext'
- import BoundBall from 'XrFrame/math/boundBall'
- import BoundBox from 'XrFrame/math/boundBox'
- import Vector3 from 'XrFrame/math/vector3'
- type Scene = import('XrFrame/core/Scene').default
- /**
- * `Geometry`中的Submesh定义。
- */
- export interface ISubMesh {
- /**
- * 子mesh的顶点偏移。
- */
- offset: number
- /**
- * 子mesh的顶点数量。
- */
- length: number
- /**
- * 子mesh的材质索引。
- */
- materialIndex: number
- }
- /**
- * 几何资源,用于定义渲染中的图元数据。
- */
- export default class Geometry {
- protected _scene: Scene
- /**
- * @internal
- */
- static readonly RAWLENGTH = 10
- /**
- * @internal
- * 从 96 切换到 76 个,换取多余的 uniform 上限
- */
- static readonly MAX_BONECOUNT = 76
- /**
- * @internal
- */
- /**
- * 获取IndexBuffer。
- */
- get indexBuffer(): import('XrFrame/kanata/lib/index').IndexBuffer
- /**
- * 获取VertexBuffer。
- */
- get vertexBuffer(): import('XrFrame/kanata/lib/index').VertexBuffer
- /**
- * 获取IndexData。
- * 这种类型的索引数据用于合批,只对于开启了`dynamicBatch`的Renderer有效。
- * 注意如果已经获取过`indexBuffer`,将无效。
- */
- get indexData(): import('XrFrame/kanata/lib/index').IndexData
- /**
- * 获取VertexData。
- * 这种类型的顶点数据用于合批,只对于开启了`dynamicBatch`的Renderer有效。
- * 注意如果已经获取过`vertexBuffer`,将无效。
- */
- get vertexData(): import('XrFrame/kanata/lib/index').VertexData
- /**
- * 该mesh是否有效,有些情况可能会造成这种现象,例如vertexLayout和buffer数量不匹配
- * 渲染时应该对该值做检查以防护
- * @internal
- */
- get valid(): boolean
- /**
- * 包围球,只读。
- */
- get boundBall(): BoundBall
- /**
- * 包围盒,只读。
- */
- get boundBox(): BoundBox
- /**
- * 获取所有的SubMesh,不要修改。
- * @internal
- */
- get subMeshes(): ISubMesh[]
- /**
- * 构造一个`Geometry`。
- */
- constructor(
- _scene: Scene,
- vertexLayout: Kanata.VertexLayout,
- vBuffer: ArrayBufferView,
- iBuffer: ArrayBufferView,
- indexType?: Kanata.EIndexType
- )
- /**
- * 更新VertexBuffer和IndexBuffer。
- * @internal
- */
- uploadBufferData(
- vBufferOffset: number,
- vBufferLength: number,
- iBufferOffset: number,
- iBufferLength: number
- ): void
- /**
- * 更新VertexBuffer。
- * 仅在获取了`vertexBuffer`后有效。
- */
- uploadVertexBuffer(offset: number, buffer: ArrayBufferView): void
- /**
- * 更新IndexBuffer。
- * 仅在获取了`indexBuffer`后有效。
- */
- uploadIndexBuffer(
- offset: number,
- buffer: Uint16Array | Uint32Array
- ): void
- /**
- * 获取当前mesh有多少subMesh
- */
- getSubMeshCount(): number
- /**
- * 获取指定序号的subMesh的索引起始点
- *
- * @returns {number} 索引起始点,返回-1代表SubMesh不存在
- */
- getIndiceStart(subMeshIndex: number): number
- /**
- * 获取指定序号的subMesh的索引长度
- *
- * @returns {number} 索引长度,返回-1代表SubMesh不存在
- */
- getIndiceLength(subMeshIndex: number): number
- /**
- * 获取指定序号的subMesh的材质序号
- *
- * @returns {number} 材质序号,返回-1代表subMesh不存在
- */
- getMaterialIndex(subMeshIndex: number): number
- /**
- * 获取VertexLayout。
- */
- getVertexLayout(): Kanata.VertexLayout
- /**
- * 修改subMesh。
- *
- * @param length 索引长度
- * @param offset 索引起始偏移
- */
- modifySubMesh(
- subMeshIndex: number,
- length: number,
- offset: number
- ): boolean
- /**
- * 增加subMesh。
- *
- * @param length 索引长度
- * @param offset 索引起始偏移
- */
- addSubMesh(length: number, offset: number, materialIndex?: number): void
- /**
- * 动态更新包围盒,默认会自动计算包围球。
- */
- setBoundBox(
- center: Vector3,
- size: Vector3,
- autoUpdateBall?: boolean
- ): void
- /**
- * 动态更新包围球。
- */
- setBoundBall(center: Vector3, radius: number): void
- /**
- * 获取第一个顶点Buffer原始数据,可能没有值。
- * @internal
- */
- /**
- * 获取索引Buffer原始数据。
- * @internal
- */
- }
- export {}
- }
- declare module 'XrFrame/assets/Material' {
- /**
- * Material.ts
- *
- * * @Date : 2022/3/24上午11:21:54
- */
- import { Kanata } from 'XrFrame/ext'
- import Effect, { IRenderStates } from 'XrFrame/assets/Effect'
- import Vector2 from 'XrFrame/math/vector2'
- import Vector3 from 'XrFrame/math/vector3'
- import Vector4 from 'XrFrame/math/vector4'
- import Matrix3 from 'XrFrame/math/matrix3'
- import Matrix4 from 'XrFrame/math/matrix4'
- import EnvData from 'XrFrame/assets/EnvData'
- type Scene = import('XrFrame/core/Scene').default
- /**
- * 材质资源,一般被代理到{@link XRMaterial}元素。
- */
- export default class Material {
- /**
- * @internal
- */
- get kanataMaterial(): import('XrFrame/kanata/lib/index').Material
- /**
- * @internal
- */
- get uniforms(): import('XrFrame/kanata/lib/index').UniformBlock
- set alphaMode(value: 'OPAQUE' | 'BLEND' | 'MASK')
- set alphaCutOff(value: number)
- /**
- * 透明物体需要大于`2500`!
- */
- get renderQueue(): number
- set renderQueue(value: number)
- constructor(_scene: Scene)
- /**
- * 通过效果初始化材质。
- */
- initByEffect(
- effect: Effect,
- defaultUniforms?: {
- [key: string]: ArrayLike<number> | number | Kanata.Texture
- }
- ): void
- /**
- * 获取一个Float
- */
- getFloat(key: string): number
- /**
- * 设置一个Float
- *
- * @returns 是否设置成功
- */
- setFloat(key: string, value: number): boolean
- /**
- * 设置一个Vector。
- *
- * @returns 是否设置成功。
- */
- setVector(key: string, value: Vector2 | Vector3 | Vector4): boolean
- /**
- * 获取一个Vector值的拷贝。
- */
- getVector(key: string): Vector2 | Vector3 | Vector4
- /**
- * 设置一个Matrix
- *
- * @returns 是否设置成功
- */
- setMatrix(key: string, value: Matrix3 | Matrix4): boolean
- /**
- * 获取一个Vector值的拷贝。
- */
- getMatrix(key: string): Matrix3 | Matrix4
- /**
- * 设置一张贴图。
- *
- * @returns 是否设置成功。
- */
- setTexture(key: string, value: Kanata.Texture): boolean
- /**
- * 设置一张贴图。
- *
- * @returns 是否设置成功。
- */
- setTextureAsset(key: string, assetId: string): boolean
- resetTexture(key: string): import('XrFrame/kanata/lib/index').Texture
- /**
- * 直接通过Backend纹理ID设置纹理,注意需要自己持有纹理引用。
- * @internal
- *
- * @returns 是否设置成功。
- */
- setFontTexture(key: string, id: number): boolean
- /**
- * 获取材质中已设置的贴图。
- */
- getTexture(key: string): Kanata.Texture
- /**
- * 设置渲染状态。
- * 只有标记了`useMaterialRenderStates`的Pass会受到影响
- */
- setRenderState<TKey extends keyof IRenderStates>(
- key: TKey,
- value: IRenderStates[TKey]
- ): boolean
- /**
- * 批量设置渲染状态。
- * 只有标记了`useMaterialRenderStates`的Pass会受到影响。
- */
- setRenderStates(states: IRenderStates): boolean
- /**
- * 清除渲染状态。
- * 清除材质的渲染状态,转而从effect中使用默认值。
- */
- clearRenderState<TKey extends keyof IRenderStates>(key: TKey): boolean
- /**
- * 批量清除渲染状态。
- * 清除材质的渲染状态,转而从effect中使用默认值。
- */
- clearRenderStates(states: { [key: string]: any }): boolean
- /**
- * 获取渲染状态。
- */
- getRenderState(key: string): number | boolean
- /**
- * 设置宏。
- */
- setMacro(key: string, value: boolean | number): void
- /**
- * 批量设置宏。
- */
- setMacros(marcos: { [key: string]: number | boolean }): void
- /**
- * 获取宏。
- */
- getMacro(key: string): boolean
- /**
- * 拷贝自身,生成一份新的材质数据。
- */
- clone(): Material
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- }
- export {}
- }
- declare module 'XrFrame/assets/VideoTexture' {
- import { Kanata } from 'XrFrame/ext'
- type Scene = import('XrFrame/core/Scene').default
- /**
- * 视频纹理{@link VideoTexture}的创建参数。
- */
- export interface IVideoTextureOptions {
- /**
- * 视频地址。
- */
- src: string
- /**
- * 视频未加载成功时,可选的首帧图片地址。
- */
- placeHolder?: Kanata.IImage
- /**
- * 是否要在加载完毕后自动播放。
- */
- autoPlay?: boolean
- /**
- * 是否要循环播放。
- */
- loop?: boolean
- /**
- * 是否禁止音频,默认禁止。
- */
- abortAudio?: boolean
- /**
- * 是否在小程序压后台时自动暂停,默认暂停。
- */
- autoPause?: boolean
- }
- export enum EVideoState {
- Idle = 0,
- WaitPlay = 1,
- Playing = 2,
- Paused = 3,
- Released = 4
- }
- /**
- * 视频纹理。
- */
- export default class VideoTexture {
- onEnd?: () => void
- get texture(): import('XrFrame/kanata/lib/index').Texture
- get width(): number
- get height(): number
- get autoPause(): boolean
- /**
- * 当前视频纹理播放状态。
- */
- get state(): EVideoState
- /**
- * @param onReady 创建成功时的回调。
- * @param onEnd 播放结束时的回调。
- */
- constructor(
- scene: Scene,
- options: IVideoTextureOptions,
- onReady: (vt: VideoTexture, error?: Error) => void,
- onEnd?: () => void
- )
- /**
- * @internal
- */
- /**
- * 播放视频。
- */
- play(): Promise<void>
- /**
- * 从某处开始播放。
- *
- * @param pos 事件,单位为s
- */
- seek(pos: number): Promise<any>
- /**
- * 暂停当前播放的视频。
- * 需要在基础库`v2.33.0`及以上支持。
- */
- pause(): Promise<void>
- /**
- * 唤醒已暂停的视频。
- * 需要在基础库`v2.33.0`及以上支持。
- */
- resume(): Promise<void>
- /**
- * 停止播放视频。
- */
- stop(): void
- /**
- * 释放视频。
- */
- release(): void
- }
- export {}
- }
- declare module 'XrFrame/assets/RenderTexture' {
- import { Kanata } from 'XrFrame/ext'
- type Scene = import('XrFrame/core/Scene').default
- export interface IRenderTarget {
- width: number
- height: number
- renderPass: Kanata.RenderPass
- }
- /**
- * `RenderTexture`资源参数接口。
- */
- export interface IRenderTextureOptions {
- width: number
- height: number
- isHDR?: boolean
- }
- /**
- * 渲染纹理组件,可作为{@link Camera.renderTarget}。
- */
- export default class RenderTexture {
- static IS(obj: any): obj is RenderTexture
- readonly isRenderTexture: boolean
- /**
- * 获取深度模板纹理。
- * @internal
- */
- get depthStencil(): import('XrFrame/kanata/lib/index').Texture
- /**
- * 获取第一个色彩纹理。
- * @internal
- */
- get texture(): import('XrFrame/kanata/lib/index').Texture
- /**
- * 获取深度纹理。
- * @internal
- */
- get depthTexture(): import('XrFrame/kanata/lib/index').Texture
- /**
- * 获取Backend实例。
- * @internal
- */
- get renderPass(): import('XrFrame/kanata/lib/index').RenderPass
- /**
- * 贴图高。
- */
- get height(): number
- /**
- * 贴图宽。
- */
- get width(): number
- get id(): number
- constructor(_scene: Scene, options: IRenderTextureOptions)
- }
- export {}
- }
- declare module 'XrFrame/assets/GLTFModel' {
- /**
- * GlTF.ts
- *
- * * @Date : 2022/4/1下午3:34:15
- */
- import NativeAnimation from 'XrFrame/animation/NativeAnimation'
- import Mesh from 'XrFrame/components/Mesh'
- import Element from 'XrFrame/core/Element'
- import { Kanata } from 'XrFrame/ext'
- import { GLTFRootLoaded } from 'XrFrame/loader/glTF/GLTFRootNode'
- import { GLTFTreeNode } from 'XrFrame/loader/glTF/scenes/GLTFNodesNode'
- import { IGLTFLoaderOptions } from 'XrFrame/loader/GlTFLoader'
- import Vector3 from 'XrFrame/math/vector3'
- import Quaternion from 'XrFrame/math/quaternion'
- type Scene = import('XrFrame/core/Scene').default
- /**
- * 收集glTF实例化过程中创建的对象,避免其GC。
- * @deprecated
- */
- export class GLTFInstanceResourceCollector {
- add(res: Kanata.IHandle): void
- release(): void
- }
- /**
- * 在{@link GLTFModel.instantiate}中传入的设置项。
- */
- export interface IGLTFModelOptions {
- /**
- * 是否投射阴影。
- */
- castShadow: boolean
- /**
- * 是否接受阴影。
- */
- receiveShadow: boolean
- /**
- * 是否**不**参与剔除。
- */
- neverCull: boolean
- }
- export type TQS = [pos: Vector3, quat: Quaternion, scale: Vector3]
- /**
- * 加载完毕的GLTF模型,可以在节点下创建{@link GLTF | GLTF组件}来将其实例化。
- */
- export default class GLTFModel {
- /**
- * 如果IGLTFLoaderOptions里开启了preserveRaw,则会将原始json保存下来。
- */
- readonly jsonRaw: object | undefined
- constructor(_scene: Scene, model: GLTFRootLoaded)
- /**
- * 使用GLB文件加载而成的buffer,来生成GLTF模型。
- */
- static createFromBuffer(
- scene: Scene,
- buffer: ArrayBuffer,
- options: IGLTFLoaderOptions
- ): Promise<GLTFModel>
- /**
- * 实例化一个GLTF模型,将其加入到指定节点下,并返回一系列得到的物件。
- * @internal
- *
- * @returns subRoots GLTF场景的根节点对应的元素,因为一个GLTF可能有多个场景,所以可能有多个根节点。
- * @returns treeNodeMap GLTF节点对应到元素的映射表。
- * @returns animations 实例化产生的动画片段,需要手动将其加入{@link Animator}组件。
- * @returns meshes 实例化产生的所有{@link Mesh}组件。
- */
- instantiate(
- parent: Element,
- options: IGLTFModelOptions
- ): [
- subRoots: Element[],
- treeNodeMap: Map<GLTFTreeNode, Element>,
- animations: NativeAnimation[],
- meshes: Array<[mesh: Mesh, transform: TQS]>
- ]
- }
- export {}
- }
- declare module 'XrFrame/assets/EnvData' {
- /**
- * EnvData.ts
- *
- * * @Date : 5/11/2022, 4:07:41 PM
- */
- import { Kanata } from 'XrFrame/ext'
- /**
- * `EnvData`的参数接口。
- */
- export interface IEnvDataOptions {
- /**
- * 天空盒。
- */
- skybox?: {
- /**
- * 是否只使用贴图的上半部分,一般在和`specular`共用贴图的时候为`true`。
- */
- half: boolean
- /**
- * 贴图。
- */
- map: Kanata.Texture
- }
- /**
- * 环境漫反射部分。
- */
- diffuse?: {
- /**
- * 球谐系数SH9。
- */
- coefficients: Float32Array
- }
- /**
- * 环境高光反射部分。
- */
- specular?: {
- /**
- * 贴图类型,目前只支持2D。
- */
- type: '2D'
- /**
- * 是否使用`rgbd`编码来。
- */
- rgbd: boolean
- /**
- * 是否使用mipmap。
- */
- mipmaps: boolean
- /**
- * 使用的mipmap级数。
- */
- mipmapCount?: number
- /**
- * 贴图。
- */
- map: Kanata.Texture
- }
- }
- /**
- * 环境数据资源,一般用[xr-frame-cli](https://github.com/wechat-miniprogram/xr-frame-cli)生成。
- */
- export default class EnvData {
- get useHalfSkyMap(): boolean
- get skyboxMap(): import('XrFrame/kanata/lib/index').Texture
- get hasDiffuse(): boolean
- get diffuseSH(): Float32Array
- get hasSpecular(): boolean
- get specularRGBD(): boolean
- get specularMipmaps(): boolean
- get specularMipmapCount(): number
- get specularMap(): import('XrFrame/kanata/lib/index').Texture
- constructor(options: IEnvDataOptions)
- destroy(): void
- }
- }
- declare module 'XrFrame/animation/Animation' {
- /**
- * Animation.ts
- *
- * * @Date : 6/17/2022, 3:17:12 PM
- */
- type Scene = import('XrFrame/core/Scene').default
- type Element = import('XrFrame/core/Element').default
- /**
- * 动画播放的方向,如果是`both`,则会在`loop`开启时的每次循环中自动反转。
- */
- export type TDirection = 'forwards' | 'backwards' | 'both'
- /**
- * 动画资源基类,被{@link Animator}使用,可以继承它来实现具体的动画。
- *
- * @template IData 动画初始化接受的数据。
- * @template IOptions 动画播放时接受的额外追加选项。
- */
- export default class Animation<IData = any, IOptions = any> {
- __DATA_TYPE: IData
- __OPTIONS_TYPE: IOptions
- /**
- * 动画所有的片段名字,必须在`onInit`中被初始化。
- */
- clipNames: string[]
- /**
- * 场景实例。
- */
- get scene(): import('XrFrame/core/Scene').default
- /**
- * @param _scene 场景实例。
- * @param data 初始化动画数据。
- */
- constructor(_scene: Scene, data: IData)
- /**
- * 动画初始化时执行的生命周期,只会执行一次。
- *
- * @param data 初始化动画数据。
- */
- onInit(data: IData): void
- /**
- * 动画开始播放时执行的生命周期。
- *
- * @param el 本次播放作用于的`element`,一个动画可能作用于多个`element`,可以在这里区分。
- * @param clipName 本次播放的片段名字。
- * @param options 本次播放时的附加选项。
- *
- * @returns 返回本次播放片段的参数,必须包括时长`duration`(s),可选循环次数`loop`、延迟`delay`和方向`direction`。
- */
- onPlay(
- el: Element,
- clipName: string,
- options: IOptions
- ): {
- duration: number
- loop?: number
- delay?: number
- direction?: TDirection
- }
- /**
- * 在动画更新时执行的回调。
- *
- * @param el 本次播放作用于的`element`。
- * @param progress 播放进度,范围为线性的`0~1`。
- * @param reverse 本次播放是否反向。
- */
- onUpdate(el: Element, progress: number, reverse: boolean): void
- /**
- * 在动画暂停时执行的回调。
- *
- * @param el 本次播放作用于的`element`。
- */
- onPause(el: Element): void
- /**
- * 在动画从暂停状态唤醒时执行的回调。
- *
- * @param el 本次播放作用于的`element`。
- */
- onResume(el: Element): void
- /**
- * 在动画停止时执行的回调。
- *
- * @param el 本次播放作用于的`element`。
- */
- onStop(el: Element): void
- }
- export {}
- }
- declare module 'XrFrame/animation/KeyframeAnimation' {
- import Animation, { TDirection } from 'XrFrame/animation/Animation'
- type Element = import('XrFrame/core/Element').default
- /**
- * `Keyframe`动画数据的动画部分。
- */
- export interface IKeyframeAnimationInfo {
- /**
- * 指定动画使用的Keyframe。
- */
- keyframe: string
- /**
- * 动画长度(s)。
- */
- duration: number
- /**
- * 动画插值方式,详见{@link noneParamsEaseFuncs}和{@link useParamsEaseFuncs}。
- */
- ease: string
- /**
- * 如果是可以接受参数的插值方式,指定参数。
- */
- easeParams?: number[]
- /**
- * 循环次数,`0`为不循环,`-1`为永远循环。
- */
- loop?: number
- /**
- * 播放延迟。
- */
- delay?: number
- /**
- * 播放方向。
- */
- direction?: TDirection
- }
- /**
- * `Keyframe`动画数据的动画部分。
- */
- export interface IKeyframeAnimationData {
- /**
- * 关键帧定义部分,可以参考[basic-animation](https://mmbizwxaminiprogram-1258344707.cos.ap-guangzhou.myqcloud.com/xr-frame/doc/basic-animation.json)。
- *
- * `name`为关键帧名字。
- * `key`为`0~100`的进度。
- * `prop`为属性序列,其规则为`[componentName].[prop1].[prop2].[prop3]...`,但是有一些特殊的缩写:
- * `position`、`scale`、`rotation`是`transform`组件下对应的属性,`material.u_xxx`则是设置材质的uniform。
- * `prop`的值,可以是数字或者数字数组。
- */
- keyframe: {
- [name: string]: {
- [key: string]: {
- [prop: string]: number | number[]
- }
- }
- }
- /**
- * 动画部分。
- */
- animation: {
- [name: string]: IKeyframeAnimationInfo
- }
- }
- export enum EKeyframeAnimationPropType {
- Default = 0,
- Math = 1,
- Uniform = 2,
- ComponentData = 3
- }
- /**
- * `Keyframe`动画的追加播放参数。
- */
- export interface IKeyframeAnimationOptions {
- /**
- * 改变插值方式。
- */
- ease?: string
- /**
- * 改变插值系数。
- */
- easeParams?: number[]
- }
- /**
- * 解析完的`Keyframe`部分实例,准备好数据以备正式播放。
- *
- * 开发者不需要关心,内部使用。
- */
- export class Keyframe {
- /**
- * @internal
- */
- get times(): number[]
- constructor(options: IKeyframeAnimationData['keyframe']['name'])
- start(el: Element): (p: number) => void
- }
- /**
- * `Keyframe`动画。
- */
- export default class KeyframeAnimation extends Animation<
- IKeyframeAnimationData,
- IKeyframeAnimationOptions
- > {
- onInit(data: IKeyframeAnimationData): void
- onPlay(
- el: Element,
- clipName: string,
- options: IKeyframeAnimationOptions
- ): IKeyframeAnimationInfo
- onUpdate(el: Element, progress: number, reverse: boolean): void
- onPause(el: Element): void
- onResume(el: Element): void
- onStop(el: Element): void
- }
- export {}
- }
- declare module 'XrFrame/assets/Atlas' {
- /**
- * Atlas.ts
- *
- * * @Date : 10/12/2022, 5:23:59 PM
- */
- import { Kanata } from 'XrFrame/ext'
- import Matrix3 from 'XrFrame/math/matrix3'
- import Vector4 from 'XrFrame/math/vector4'
- type Scene = import('XrFrame/core/Scene').default
- /**
- * `Atlas`的初始化参数类型。
- */
- export interface IAtlasOptions {
- /**
- * 图片。
- */
- image?: Kanata.IImage
- /**
- * 也可以直接传入一张纹理。
- */
- texture?: Kanata.Texture
- /**
- * 帧定义,若不指定`uv`则会自动按比例计算。
- */
- frames: {
- [key: string]: {
- /**
- * 帧的区块信息。
- */
- frame: {
- x: number
- y: number
- w: number
- h: number
- }
- /**
- * 会自动生成,开发者无需关心。
- *
- * @hidden
- */
- uvMatrix?: Matrix3
- /**
- * 会自动生成,开发者无需关心。
- *
- * @hidden
- */
- uvST?: Vector4
- }
- }
- /**
- * 原信息,主要定义图片尺寸。
- */
- meta: {
- size: {
- w: number
- h: number
- }
- }
- }
- /**
- * 图集资源创建参数。
- */
- export interface IAtlasCreationOptions {
- /**
- * 单元宽度。
- */
- cellWidth?: number
- /**
- * 单元高度。
- */
- cellHeight?: number
- /**
- * 单元间的间隙。
- */
- space?: number
- /**
- * 每行有多少帧(单元)。
- */
- framesPerLine: number
- /**
- * 需要从哪一帧开始。
- */
- frameStart?: number
- /**
- * 需要几帧。
- */
- frameCount?: number
- }
- /**
- * 图集资源。
- * @version 2.27.1
- *
- * 一般通过{@link AtlasLoader}加载自动生成。
- * 推荐使用[Shoebox](https://www.renderhjs.net/shoebox/)等工具生成。
- */
- export default class Atlas {
- isAtlas: boolean
- protected _AUTO_ID: number
- protected _image: Kanata.IImage
- protected _texture: Kanata.Texture
- protected _frames: IAtlasOptions['frames']
- protected _meta: IAtlasOptions['meta']
- protected _updatable: boolean
- protected _root: string
- protected _area: number
- protected _needReBuild: boolean
- /**
- * 根据宽高和行数、列数来创建一个空的图集。
- * 这个图集将被行列分成若干个格子帧,开发者可以根据实际状况去使用`updateFrame`更新这些格子。
- * 自动生成的帧的名字为`${row}${col}`,比如第一行第一列为`'11'`。
- *
- * @param onUpdate 初始化时的回调,可以用于一开始绘制图像
- */
- static CREATE_FROM_GRIDS(
- scene: Scene,
- options: {
- width: number
- height: number
- rows: number
- cols: number
- space?: number
- },
- onUpdate?: (
- texture: Kanata.Texture,
- region: {
- col: number
- row: number
- x: number
- y: number
- w: number
- h: number
- },
- frameName: string
- ) => void
- ): Atlas
- /**
- * 根据纹理和配置,来通过纹理创建一个不可修改的图集。通常用于精灵动画。
- * 这个图集将被行列分成若干个格子帧,每一帧的名字为`0`、`1`、`2`......
- */
- static CREATE_FROM_TEXTURE(
- scene: Scene,
- texture: Kanata.Texture,
- options: IAtlasCreationOptions
- ): Atlas
- /**
- * 获取元信息。
- */
- get meta(): {
- size: {
- w: number
- h: number
- }
- }
- /**
- * 获取帧集合。
- */
- get frames(): {
- [key: string]: {
- /**
- * 帧的区块信息。
- */
- frame: {
- x: number
- y: number
- w: number
- h: number
- }
- /**
- * 会自动生成,开发者无需关心。
- *
- * @hidden
- */
- uvMatrix?: Matrix3
- /**
- * 会自动生成,开发者无需关心。
- *
- * @hidden
- */
- uvST?: Vector4
- }
- }
- /**
- * 获取整体的纹理。
- */
- get texture(): import('XrFrame/kanata/lib/index').Texture
- /**
- * 构建一个图集。
- *
- * @param options 初始化参数。
- */
- constructor(_scene: Scene, options: IAtlasOptions)
- /**
- * 获取某一帧的数据。
- */
- getFrame(frameName: string): {
- x: number
- y: number
- w: number
- h: number
- }
- /**
- * 获取某一帧的uv变换矩阵。
- */
- getUVMatrix(frameName: string): Matrix3
- protected _buildUVMatrix(frame: {
- x: number
- y: number
- w: number
- h: number
- }): Matrix3
- /**
- * 获取某一帧的uvST。
- * [sx, sy, tx, ty]。
- */
- getUVST(frameName: string): Vector4
- protected _buildUVST(frame: {
- x: number
- y: number
- w: number
- h: number
- }): Vector4
- /**
- * 更新某一frame,通过`onUpdate`方法参数中的`texture`和`region`来更新上此帧所占据区域内的图像。
- */
- updateFrame(
- frameName: string,
- onUpdate: (
- texture: Kanata.Texture,
- region: {
- x: number
- y: number
- w: number
- h: number
- },
- frameName: string
- ) => void
- ): void
- }
- export {}
- }
- declare module 'XrFrame/assets/PostProcess' {
- /**
- * PostProcess.ts
- *
- * * @Date : 10/14/2022, 4:34:55 PM
- */
- type Scene = import('XrFrame/core/Scene').default
- /**
- * 后处理资源初始化参数。
- */
- export interface IPostProcessOptions {
- /**
- * 类型,目前支持的类型请见[内置后处理资源](https://developers.weixin.qq.com/miniprogram/dev/component/xr-frame/builtin/post-process)。
- */
- type: string
- /**
- * 是否开启HDR。
- */
- isHDR?: boolean
- /**
- * 对应类型的数据。
- */
- data?: {
- [key: string]: any
- }
- }
- /**
- * 后处理资源。
- *
- * 一般由{@link AssetPostProcess}加载。
- */
- export default class PostProcess {
- /**
- * 类型。
- */
- get type(): string
- /**
- * 是否开启了HDR。
- */
- get isHDR(): boolean
- /**
- * 数据,可以修改。
- */
- get data(): {
- [key: string]: any
- }
- constructor(_scene: Scene, options: IPostProcessOptions)
- }
- export {}
- }
- declare module 'XrFrame/assets/factories' {
- /**
- * factories.ts
- *
- * * @Date : 2022/3/23下午4:04:18
- */
- import Scene from 'XrFrame/core/Scene'
- import Effect from 'XrFrame/assets/Effect'
- import Geometry from 'XrFrame/assets/Geometry'
- import Material from 'XrFrame/assets/Material'
- export const TABLE: {
- [type: string]: {
- [id: string]: (scene: Scene) => any
- }
- }
- /**
- * @internal
- */
- export function getAssetFactory<T = any>(
- type: string,
- id: string
- ): (scene: Scene) => T
- /**
- * 注册`Geometry`资源。
- */
- export const registerGeometry: (
- id: string,
- factory: (scene: Scene) => Geometry
- ) => void
- /**
- * 注册`Effect`资源。
- */
- export const registerEffect: (
- id: string,
- factory: (scene: Scene) => Effect
- ) => void
- /**
- * 注册`Texture`资源。
- */
- export const registerTexture: (
- id: string,
- factory: (scene: Scene) => import('XrFrame/kanata/lib/index').Texture
- ) => void
- /**
- * 注册`TextureCube`资源。
- */
- export const registerTextureCube: (
- id: string,
- factory: (scene: Scene) => import('XrFrame/kanata/lib/index').Texture
- ) => void
- /**
- * 注册`VertexDataDescriptor`资源。
- */
- export const registerVertexDataDesc: (
- id: string,
- factory: (
- scene: Scene
- ) => import('XrFrame/kanata/lib/index').VertexDataDescriptor
- ) => void
- /**
- * 注册`UniformDescriptor`资源。
- */
- export const registerUniformDesc: (
- id: string,
- factory: (
- scene: Scene
- ) => import('XrFrame/kanata/lib/index').UniformDescriptor
- ) => void
- /**
- * 注册`VertexLayout`资源。
- */
- export const registerVertexLayout: (
- id: string,
- factory: (
- scene: Scene
- ) => import('XrFrame/kanata/lib/index').VertexLayout
- ) => void
- /**
- * 注册`Material`资源。
- */
- export const registerMaterial: (
- id: string,
- factory: (scene: Scene) => Material
- ) => void
- }
- declare module 'XrFrame/assets/easeFunctions' {
- /**
- * easeFunctions.ts
- *
- * * @Date : 6/21/2022, 11:24:27 AM
- */
- type TEaseFunction = (progress: number) => number
- /**
- * 可以自定义参数的插值函数。
- */
- export const useParamsEaseFuncs: {
- /**
- * 二次贝塞尔曲线。
- *
- * @param params p1x, p1y, p2x, p2y。
- * @returns 最终的插值函数。
- */
- 'cubic-bezier': (
- times: number[],
- params: number[]
- ) => (x: number) => number
- /**
- * 步进插值曲线。
- *
- * @param params 一个参数,总步数。
- * @returns 最终的插值函数。
- */
- steps: (times: number[], params: number[]) => (x: number) => number
- }
- /**
- * 不需要自定义参数的一些内置插值曲线。
- */
- export const noneParamsEaseFuncs: {
- linear: (x: any) => any
- 'ease-in': (x: number) => number
- 'ease-out': (x: number) => number
- 'ease-in-out': (x: number) => number
- 'ease-in-quad': (x: any) => number
- 'ease-out-quad': (x: any) => number
- 'ease-in-out-quad': (x: any) => number
- 'ease-in-cubic': (x: any) => number
- 'ease-out-cubic': (x: any) => number
- 'ease-in-out-cubic': (x: any) => number
- 'ease-in-quart': (x: any) => number
- 'ease-out-quart': (x: any) => number
- 'ease-in-out-quart': (x: any) => number
- 'ease-in-quint': (x: any) => number
- 'ease-out-quint': (x: any) => number
- 'ease-in-out-quint': (x: any) => number
- 'ease-in-sine': (x: any) => number
- 'ease-out-sine': (x: any) => number
- 'ease-in-out-sine': (x: any) => number
- 'ease-in-expo': (x: any) => number
- 'ease-out-expo': (x: any) => number
- 'ease-in-out-expo': (x: any) => number
- 'ease-in-circ': (x: any) => number
- 'ease-out-circ': (x: any) => number
- 'ease-in-out-circ': (x: any) => number
- 'ease-in-back': (x: any) => number
- 'ease-out-back': (x: any) => number
- 'ease-in-out-back': (x: any) => number
- 'ease-in-elastic': (x: any) => number
- 'ease-out-elastic': (x: any) => number
- 'ease-in-out-elastic': (x: any) => number
- 'ease-in-bounce': (x: any) => number
- 'ease-out-bounce': TEaseFunction
- 'ease-in-out-bounce': (x: any) => number
- }
- export {}
- }
- declare module 'XrFrame/physics/exports' {
- export { default as RaycastHit } from 'XrFrame/physics/RaycastHit'
- export { ICollideEvent, IOverlapEvent } from 'XrFrame/physics/Collision'
- export { IContactPoint } from 'XrFrame/physics/ContactPoint'
- export { RaycastDesc } from 'XrFrame/physics/raycast'
- }
- declare module 'XrFrame/math/vector2' {
- export default class Vector2 {
- /**
- * x值
- *
- * @type {number}
- * @memberof Vector2
- */
- get x(): number
- set x(val: number)
- /**
- * y值
- *
- * @type {number}
- * @memberof Vector2
- */
- get y(): number
- set y(val: number)
- /**
- * 零向量,不要对该对象进行修改
- *
- * @readonly
- * @static
- * @type {V3ReadOnly}
- * @memberof Vector3
- */
- static readonly ZERO: Vector2
- /**
- * 一向量,不要对该对象进行修改
- *
- * @readonly
- * @static
- * @type {V3ReadOnly}
- * @memberof Vector3
- */
- static readonly ONE: Vector2
- _raw: Float32Array
- /**
- * 使用一个数组创建
- * 此操作会拷贝一份数组
- *
- * @static
- * @param {number[]} array 数据源,长度必须为2,否则会抛出异常
- * @returns {Vector2} 创建出来的向量
- * @memberof Vector2
- */
- static createFromArray(array: number[]): Vector2
- /**
- * 使用某个已有的typedArray创建
- * 此操作不会拷贝数据,而是在原来的内存区域上操作
- *
- * @static
- * @param {Float32Array} array 数据源
- * @param {number} [offset=0] 数据源中的偏移
- * @returns {Vector2} 创建出来的向量
- * @memberof Vector2
- */
- static createFromTypedArray(
- array: Float32Array,
- offset?: number
- ): Vector2
- /**
- * 返回向量数据
- *
- * @returns {number[]} 矩阵数据,以JSArray返回
- * @memberof Vector2
- */
- toArray(): number[]
- /**
- * 判断与目标向量的值是否相等
- *
- * @param {V2ReadOnly} v 目标向量
- * @returns {boolean} 是否相等,这里误差小于10^-6视为相等
- * @memberof Vector2
- */
- equal(v: Vector2): boolean
- /**
- * 拷贝目标向量的值到该向量
- *
- * @param {V2ReadOnly} val 目标向量
- * @returns {Vector2} 自身
- * @memberof Vector2
- */
- set(val: Vector2): Vector2
- /**
- * 设置向量的值
- *
- * @param {number} x x值
- * @param {number} y y值
- * @returns {Vector2} 自身
- * @memberof Vector2
- */
- setValue(x: number, y: number): Vector2
- /**
- * 向量加法
- *
- * @param {V2ReadOnly} v 目标向量
- * @param {Vector2} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector2} 计算结果
- * @memberof Vector2
- */
- add(v: Vector2, dst?: Vector2): Vector2
- /**
- * 向量减法
- *
- * @param {V2ReadOnly} v 目标向量
- * @param {Vector2} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector2} 计算结果
- * @memberof Vector2
- */
- sub(v: Vector2, dst?: Vector2): Vector2
- /**
- * 向量归一化,如该向量为零向量,则结果依然为零向量
- *
- * @param {Vector2} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector2} 计算结果
- * @memberof Vector2
- */
- normalize(dst?: Vector2): Vector2
- /**
- * 向量缩放
- *
- * @param {number} f 缩放比
- * @param {Vector2} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector2} 计算结果
- * @memberof Vector2
- */
- scale(f: number, dst?: Vector2): Vector2
- /**
- * 在该向量与目标向量之间计算插值
- *
- * @param {V2ReadOnly} v 目标向量
- * @param {number} f 插值系数
- * @param {Vector2} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector2} 计算结果
- * @memberof Vector2
- */
- lerp(v: Vector2, f: number, dst?: Vector2): Vector2
- /**
- * 取反
- * @returns
- */
- negate(): this
- /**
- * 向量点乘
- *
- * @param {V2ReadOnly} v 目标向量
- * @returns {number} 计算结果
- * @memberof Vector2
- */
- dot(v: Vector2): number
- /**
- * 向量的模
- *
- * @returns {number} 计算结果
- * @memberof Vector2
- */
- length(): number
- /**
- * 拷贝该向量
- *
- * @returns {Vector2} 拷贝出来的对象
- * @memberof Vector2
- */
- clone(): Vector2
- /**
- * 是否为零向量
- *
- * @returns {boolean}
- * @memberof Vector2
- */
- isZero(): boolean
- /**
- * 获取向量旋转角,以角度表示
- *
- * @returns {number} 旋转角,以角度表示
- * @memberof Vector2
- */
- getAngle(): number
- setArray(value: ArrayLike<number>, offset?: number): Vector2
- }
- }
- declare module 'XrFrame/math/vector3' {
- import QuatReadOnly from 'XrFrame/math/quaternion'
- import M4ReadOnly from 'XrFrame/math/matrix4'
- export default class Vector3 {
- /**
- * x值
- *
- * @type {number}
- * @memberof Vector3
- */
- get x(): number
- set x(val: number)
- /**
- * y值
- *
- * @type {number}
- * @memberof Vector3
- */
- get y(): number
- set y(val: number)
- /**
- * z值
- *
- * @type {number}
- * @memberof Vector3
- */
- get z(): number
- set z(val: number)
- /**
- * 零向量,不要对该对象进行修改
- *
- * @readonly
- * @static
- * @type {Vector3}
- * @memberof Vector3
- */
- static readonly ZERO: Vector3
- /**
- * 一向量,不要对该对象进行修改
- *
- * @readonly
- * @static
- * @type {Vector3}
- * @memberof Vector3
- */
- static readonly ONE: Vector3
- /**
- * 上方向,不要对该对象进行修改
- *
- * @static
- * @type {Vector3}
- * @memberof Vector3
- */
- static readonly Up: Vector3
- /**
- * 前方向,基于左手坐标系,不要对该对象进行修改
- *
- * @static
- * @type {Vector3}
- * @memberof Vector3
- */
- static readonly ForwardLH: Vector3
- _raw: Float32Array
- /**
- * 使用一个数组创建
- * 此操作会拷贝一份数组
- *
- * @static
- * @param {number[]} array 数据源,长度必须为3,否则会抛出异常
- * @returns {Vector3} 创建出来的向量
- * @memberof Vector3
- */
- static createFromArray(array: number[]): Vector3
- /**
- * 使用某个已有的typedArray创建
- * 此操作不会拷贝数据,而是在原来的内存区域上操作
- *
- * @static
- * @param {Float32Array} array 数据源
- * @param {number} [offset=0] 数据源中的偏移
- * @returns {Vector3}
- * @memberof Vector3
- */
- static createFromTypedArray(
- array: Float32Array,
- offset?: number
- ): Vector3
- /**
- * 使用四元数进行向量旋转
- *
- * @static
- * @param {Vector3} source 源向量
- * @param {QuatReadOnly} rotation 用于旋转的四元数
- * @param {Vector3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector3} 计算结果
- * @memberof Vector3
- */
- static transformQuat(
- source: Vector3,
- rotation: QuatReadOnly,
- dst?: Vector3
- ): Vector3
- static transformCoordinate(
- coordinate: Vector3,
- transform: M4ReadOnly,
- dst?: Vector3
- ): Vector3
- /**
- * 返回向量数据
- *
- * @returns {number[]} 矩阵数据,以JSArray返回
- * @memberof Vector3
- */
- toArray(): [number, number, number]
- /**
- * 判断与目标向量的值是否相等
- *
- * @param {Vector3} v 目标向量
- * @returns {boolean} 是否相等,这里误差小于10^-6视为相等
- * @memberof Vector3
- */
- equal(v: Vector3): boolean
- /**
- * 拷贝目标向量的值到该向量
- *
- * @param {Vector3} val 目标向量
- * @returns {Vector3} 自身
- * @memberof Vector3
- */
- set(v: Vector3): Vector3
- /**
- * 设置向量的值
- *
- * @param {number} x x
- * @param {number} y y
- * @param {number} z z
- * @returns {Vector3} 自身
- * @memberof Vector3
- */
- setValue(x: number, y: number, z: number): Vector3
- setFromArray(xyz: number[]): Vector3
- /**
- * 向量加法
- *
- * @param {Vector3} v 目标向量
- * @param {Vector3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector3} 计算结果
- * @memberof Vector3
- */
- add(v: Vector3, dst?: Vector3): Vector3
- /**
- * 向量减法
- *
- * @param {Vector3} v 目标向量
- * @param {Vector3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector3} 计算结果
- * @memberof Vector3
- */
- sub(v: Vector3, dst?: Vector3): Vector3
- /**
- * 向量叉乘
- *
- * @param {Vector3} v 目标向量
- * @param {Vector3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector3} 计算结果
- * @memberof Vector3
- */
- cross(v: Vector3, dst?: Vector3): Vector3
- /**
- * 向量归一化
- *
- * @param {Vector3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector3} 计算结果
- * @memberof Vector3
- */
- normalize(dst?: Vector3): Vector3
- /**
- * 向量缩放
- *
- * @param {number} f 缩放比
- * @param {Vector3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector3} 计算结果
- * @memberof Vector3
- */
- scale(f: number, dst?: Vector3): Vector3
- /**
- * 向量缩放
- *
- * @param {number} x x缩放比
- * @param {number} y y缩放比
- * @param {number} z z缩放比
- * @param {Vector3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector3} 计算结果
- * @memberof Vector3
- */
- scaleXYZ(x: number, y: number, z: number, dst?: Vector3): Vector3
- /**
- * 在该向量与目标向量之间计算插值
- *
- * @param {Vector3} v 目标向量
- * @param {number} f 插值系数
- * @param {Vector3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector3} 计算结果
- * @memberof Vector3
- */
- lerp(v: Vector3, f: number, dst?: Vector3): Vector3
- /**
- * 取反
- * @returns
- */
- negate(): this
- abs(): this
- /**
- * 向量点乘
- *
- * @param {Vector3} v 目标向量
- * @returns {number} 计算结果
- * @memberof Vector3
- */
- dot(v: Vector3): number
- /**
- * 向量的模
- *
- * @returns {number} 计算结果
- * @memberof Vector3
- */
- length(): number
- /**
- * 拷贝该向量
- *
- * @returns {Vector3} 拷贝出来的对象
- * @memberof Vector3
- */
- clone(): Vector3
- /**
- * 是否为零向量
- *
- * @returns {boolean}
- * @memberof Vector3
- */
- isZero(): boolean
- /**
- * 获取到目标点的距离
- *
- * @param {Vector3} p 目标点
- * @returns {number} 计算结果
- * @memberof Vector3
- */
- distanceTo(p: Vector3): number
- /**
- * 获取到目标点的角度
- *
- * @param {Vector3} location 目标点
- * @returns {number} 计算结果
- * @memberof Vector3
- */
- angleTo(location: Vector3, dst?: Vector3): Vector3
- setFromMatrixColumn(m: M4ReadOnly, index: number): Vector3
- fromArray(array: Float32Array, offset: number): Vector3
- setFromMatrixScale(m: M4ReadOnly): Vector3
- /**
- * create by janzen
- * Sets this vector to the position elements of the transformation matrix
- */
- setFromMatrixPosition(worldMatrix: M4ReadOnly): Vector3
- /**
- * create by janzen
- * Multiplies this vector (with an implicit 1 in the 4th dimension) and m, and divides by perspective.
- */
- applyMatrix4(m: M4ReadOnly): Vector3
- /**
- * create by roamye
- * Multiplies this vector (with an implicit 1 in the 4th dimension) and m, and divides by perspective.
- */
- applyMatrix4Raw(m: Float32Array): this
- applyQuaternion(q: QuatReadOnly): this
- /**
- * create by janzen
- * Transforms the direction of this vector by a matrix (the upper left 3 x 3 subset of a m) and then normalizes the result.
- */
- transformDirection(m: M4ReadOnly): Vector3
- /**
- * create by roamye
- * Transforms the direction of this vector by a matrix (the upper left 3 x 3 subset of a m) and then normalizes the result.
- */
- transformDirectionRaw(raw: Float32Array): Vector3
- /**
- * created by shanexyzhou
- * 从物理引擎内的RawVec3f生成Vector3
- */
- static fromPhysics(v: any): Vector3
- fromPhysics(v: any): Vector3
- static Phys3D?: typeof phys3D
- static clearPhysicsPool(): void
- /**
- * created by shanexyzhou
- * 生成物理引擎内的RawVec3f
- */
- toPhysics(): any
- setArray(value: ArrayLike<number>, offset?: number): Vector3
- print(): void
- }
- export class Vector3ReadOnly extends Vector3 {
- get x(): number
- set x(v: number)
- get y(): number
- set y(v: number)
- get z(): number
- set z(v: number)
- constructor(array?: Float32Array, offset?: number)
- set(): this
- setValue(): this
- }
- }
- declare module 'XrFrame/math/vector4' {
- export default class Vector4 {
- /**
- * x值
- *
- * @type {number}
- * @memberof Vector4
- */
- get x(): number
- set x(val: number)
- /**
- * y值
- *
- * @type {number}
- * @memberof Vector4
- */
- get y(): number
- set y(val: number)
- /**
- * z值
- *
- * @type {number}
- * @memberof Vector4
- */
- get z(): number
- set z(val: number)
- /**
- * w值
- *
- * @type {number}
- * @memberof Vector4
- */
- get w(): number
- set w(val: number)
- /**
- * 零向量,不要对该对象进行修改
- *
- * @static
- * @readonly
- * @type {Vector4}
- * @memberof Vector4
- */
- static readonly ZERO: Vector4
- /**
- * 一向量,不要对该对象进行修改
- *
- * @readonly
- * @static
- * @type {V3ReadOnly}
- * @memberof Vector3
- */
- static readonly ONE: Vector4
- _raw: Float32Array
- /**
- * 使用一个数组创建
- * 此操作会拷贝一份数组
- *
- * @static
- * @param {number[]} array 数据源,长度必须为4,否则会抛出异常
- * @returns {Vector4} 创建出来的向量
- * @memberof Vector4
- */
- static createFromArray(array: number[]): Vector4
- /**
- * 使用某个已有的typedArray创建
- * 此操作不会拷贝数据,而是在原来的内存区域上操作
- *
- * @static
- * @param {Float32Array} array 数据源
- * @param {number} [offset=0] 数据源中的偏移
- * @returns {Vector4}
- * @memberof Vector4
- */
- static createFromTypedArray(
- array: Float32Array,
- offset?: number
- ): Vector4
- /**
- * 返回向量数据
- *
- * @returns {number[]} 矩阵数据,以JSArray返回
- * @memberof Vector4
- */
- toArray(): number[]
- /**
- * 判断与目标向量的值是否相等
- *
- * @param {Vector4} v 目标向量
- * @returns {boolean} 是否相等,这里误差小于10^-6视为相等
- * @memberof Vector4
- */
- equal(v: Vector4): boolean
- /**
- * 拷贝目标向量的值到该向量
- *
- * @param {Vector4} val 目标向量
- * @returns {Vector4} 自身
- * @memberof Vector4
- */
- set(v: Vector4): Vector4
- /**
- * 设置向量的值
- *
- * @param {number} x x值
- * @param {number} y y值
- * @param {number} z z值
- * @param {number} w w值
- * @returns {Vector4} 自身
- * @memberof Vector4
- */
- setValue(x: number, y: number, z: number, w: number): Vector4
- /**
- * 向量加法
- *
- * @param {Vector4} v 目标向量
- * @param {Vector4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector4} 计算结果
- * @memberof Vector4
- */
- add(v: Vector4, dst?: Vector4): Vector4
- /**
- * 向量减法
- *
- * @param {Vector4} v 目标向量
- * @param {Vector4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector4} 计算结果
- * @memberof Vector4
- */
- sub(v: Vector4, dst?: Vector4): Vector4
- /**
- * 向量缩放
- *
- * @param {number} f 缩放比
- * @param {Vector4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector4} 计算结果
- * @memberof Vector4
- */
- scale(f: number, dst?: Vector4): Vector4
- /**
- * 在该向量与目标向量之间计算插值
- *
- * @param {Vector4} v 目标向量
- * @param {number} f 插值系数
- * @param {Vector4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector4} 计算结果
- * @memberof Vector4
- */
- lerp(v: Vector4, f: number, dst?: Vector4): Vector4
- /**
- * 取反
- * @returns
- */
- negate(): this
- /**
- * 向量点乘
- *
- * @param {Vector4} v 目标向量
- * @returns {number} 计算结果
- * @memberof Vector4
- */
- dot(v: Vector4): number
- /**
- * 是否为零向量
- *
- * @returns {boolean}
- * @memberof Vector4
- */
- isZero(): boolean
- /**
- * 拷贝该向量
- *
- * @returns {Vector4} 拷贝出来的对象
- * @memberof Vector4
- */
- clone(): Vector4
- setArray(value: ArrayLike<number>, offset?: number): Vector4
- }
- }
- declare module 'XrFrame/math/quaternion' {
- import Vector3 from 'XrFrame/math/vector3'
- import V3ReadOnly from 'XrFrame/math/vector3'
- import QuatReadOnly from 'XrFrame/math/quaternion'
- import M4ReadOnly from 'XrFrame/math/matrix4'
- /**
- * @public
- */
- export default class Quaternion {
- set x(val: number)
- /**
- * y值
- *
- * @type {number}
- * @memberof Quaternion
- */
- get y(): number
- set y(val: number)
- /**
- * z值
- *
- * @type {number}
- * @memberof Quaternion
- */
- get z(): number
- set z(val: number)
- /**
- * w值
- *
- * @type {number}
- * @memberof Quaternion
- */
- get w(): number
- set w(val: number)
- /**
- * 默认四元数,不要对该对象进行修改
- *
- * @readonly
- * @static
- * @type {QuatReadOnly}
- * @memberof Quaternion
- */
- static readonly DEFAULT: QuatReadOnly
- _raw: Float32Array
- /**
- * 从旋转矩阵创建
- *
- * @static
- * @param {Matrix4} mat
- * @param {Quaternion} [dst]
- * @returns {Quaternion}
- * @memberof Quaternion
- */
- static createFromMatrix4(mat: M4ReadOnly, dst?: Quaternion): Quaternion
- /**
- * 从轴向旋转创建
- *
- * @static
- * @param {V3ReadOnly} axis 旋转轴
- * @param {number} rad 旋转幅度
- * @param {Quaternion} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Quaternion} 计算结果
- * @memberof Quaternion
- */
- static createFromAxisAngle(
- axis: V3ReadOnly,
- rad: number,
- dst?: Quaternion
- ): Quaternion
- /**
- * 由视角方向创建四元数
- *
- * @static
- * @param {V3ReadOnly} forward 前方向
- * @param {V3ReadOnly} up 上方向
- * @param {Quaternion} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Quaternion} 计算结果
- * @memberof Quaternion
- */
- static lookRotation(
- forward: V3ReadOnly,
- up: V3ReadOnly,
- dst?: Quaternion
- ): Quaternion
- /**
- * 使用数值创建
- *
- * @static
- * @param {number} x x
- * @param {number} y y
- * @param {number} z z
- * @param {number} w w
- * @returns {Quaternion} 创建出来的四元数
- * @memberof Quaternion
- */
- static createFromNumber(
- x: number,
- y: number,
- z: number,
- w: number
- ): Quaternion
- /**
- * 使用一个数组创建
- * 此操作会拷贝一份数组
- *
- * @static
- * @param {number[]} array 数据源,长度必须为4,否则会抛出异常
- * @returns {Quaternion}
- * @memberof Quaternion
- */
- static createFromArray(array: number[]): Quaternion
- /**
- * 使用某个已有的typedArray创建
- * 此操作不会拷贝数据,而是在原来的内存区域上操作
- *
- * @static
- * @param {Float32Array} array 数据源
- * @param {number} [offset=0] 数据源中的偏移
- * @returns {Quaternion}
- * @memberof Quaternion
- */
- static createFromTypedArray(
- array: Float32Array,
- offset?: number
- ): Quaternion
- /**
- * 通过俩个向量创建四元数
- * @param vFrom
- * @param vTo
- * @returns
- */
- static createFromUnitVectors(vFrom: Vector3, vTo: Vector3): QuatReadOnly
- /**
- * 拷贝目标四元数的值到自身
- *
- * @param {Quaternion} quat 目标四元数
- * @returns {Quaternion} 自身
- * @memberof Quaternion
- */
- set(quat: Quaternion): Quaternion
- /**
- * 设置四元数的值
- *
- * @param {number} x
- * @param {number} y
- * @param {number} z
- * @param {number} w
- * @returns {Quaternion} 自身
- * @memberof Quaternion
- */
- setValue(x: number, y: number, z: number, w: number): Quaternion
- /**
- * 球面插值
- *
- * @param {Quaternion} right 目标四元数
- * @param {number} t 插值系数,越接近 1 则结果越接近目标
- * @param {Quaternion} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Quaternion} 计算结果
- * @memberof Quaternion
- */
- slerp(right: QuatReadOnly, t: number, dst?: Quaternion): Quaternion
- /**
- * 四元数反转
- *
- * @param {Quaternion} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Quaternion} 计算结果
- * @memberof Quaternion
- */
- invert(dst?: Quaternion): Quaternion
- /**
- * 四元数相加
- *
- * @param {Quaternion} quat 目标四元数
- * @param {Quaternion} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Quaternion} 计算结果
- * @memberof Quaternion
- */
- add(quat: QuatReadOnly, dst?: Quaternion): Quaternion
- /**
- * 四元数相减
- *
- * @param {Quaternion} quat 目标四元数
- * @param {Quaternion} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Quaternion} 计算结果
- * @memberof Quaternion
- */
- sub(quat: QuatReadOnly, dst?: Quaternion): Quaternion
- /**
- * 四元数相乘
- *
- * @param {Quaternion} quat 目标四元数
- * @param {Quaternion} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Quaternion} 计算结果
- * @memberof Quaternion
- */
- multiply(quat: QuatReadOnly, dst?: Quaternion): Quaternion
- premultiply(q: QuatReadOnly): QuatReadOnly
- /**
- * 点乘
- * @param q
- */
- dot(q: QuatReadOnly): number
- length(): number
- normalize(): this
- setFromUnitVectors(vFrom: any, vTo: any): this
- setFromYawRollPitch(yaw: number, roll: number, pitch: number): void
- setFromEulerAngles(euler: Vector3): void
- /**
- * 相对角度
- * @param q
- */
- angleTo(q: QuatReadOnly): number
- /**
- * 转向对应的角度
- * @param q
- * @param step
- */
- rotateTowards(q: any, step: any): QuatReadOnly
- /**
- * 拷贝四元数
- *
- * @returns {Quaternion} 拷贝后的对象
- * @memberof Quaternion
- */
- clone(): Quaternion
- /**
- * 四元数是否为默认四元数(表示零旋转)
- *
- * @returns {boolean}
- * @memberof Quaternion
- */
- isDefault(): boolean
- /**
- * 将该四元数转换成欧拉角,x代表Pitch,y代表Yaw,z代表Roll
- * 旋转的顺序为YXZ
- *
- * @param {Vector3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector3} 计算结果
- * @memberof Quaternion
- */
- toEulerAngles(dst?: Vector3): Vector3
- /**
- * 判断与目标四元数的值是否相等
- *
- * @param {QuatReadOnly} quat 目标四元数
- * @returns {boolean}
- * @memberof Quaternion
- */
- equal(quat: QuatReadOnly): boolean
- /**
- * created by shanexyzhou
- * 从物理引擎内的RawQuaternion生成Quaternion
- */
- static fromPhysics(v: phys3D.RawQuaternion): Quaternion
- fromPhysics(v: phys3D.RawQuaternion): Quaternion
- static Phys3D?: typeof phys3D
- static clearPhysicsPool(): void
- /**
- * created by shanexyzhou
- * 生成物理引擎内的RawQuaternion
- */
- toPhysics(): phys3D.RawQuaternion
- setArray(value: ArrayLike<number>, offset?: number): Quaternion
- transformVector3(vec: Vector3): Vector3
- /**
- * 对[1,1,1]向量进行转换。
- */
- toAxisUnit(): Vector3
- }
- }
- declare module 'XrFrame/math/matrix3' {
- import Vector2 from 'XrFrame/math/vector2'
- import V2ReadOnly from 'XrFrame/math/vector2'
- export default class Matrix3 {
- get raw(): Float32Array
- _raw: Float32Array
- /**
- * 使用一个数组创建
- * 此操作会拷贝一份数组
- *
- * @static
- * @param {number[]} array 数据源,长度必须为9,否则会抛出异常
- * @returns {Matrix3} 创建出来的矩阵
- * @memberof Matrix3
- */
- static createFromArray(array: number[]): Matrix3
- /**
- * 使用某个已有的typedArray创建
- * 此操作不会拷贝数据,而是在原来的内存区域上操作
- *
- * @static
- * @param {Float32Array} array 数据源
- * @param {number} [offset=0] 数据源中的偏移
- * @returns {Matrix3} 创建出来的矩阵
- * @memberof Matrix3
- */
- static createFromTypedArray(
- array: Float32Array,
- offset?: number
- ): Matrix3
- /**
- * 返回矩阵数据
- *
- * @returns {number[]} 矩阵数据,以JSArray返回
- * @memberof Matrix3
- */
- toArray(): number[]
- /**
- * 将该矩阵进行位移变换
- *
- * @param {number} tx x轴位移
- * @param {number} ty y轴位移
- * @param {Matrix3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix3} 计算结果
- * @memberof Matrix3
- */
- translate(tx: number, ty: number, dst?: Matrix3): Matrix3
- /**
- * 将该矩阵进行缩放变换
- *
- * @param {number} sx x轴缩放
- * @param {number} sy y轴缩放
- * @param {Matrix3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix3} 计算结果
- * @memberof Matrix3
- */
- scale(sx: number, sy: number, dst?: Matrix3): Matrix3
- /**
- * 将该矩阵进行旋转变换
- *
- * @param {number} radians 旋转幅度,用弧度表示
- * @param {Matrix3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix3} 计算结果
- * @memberof Matrix3
- */
- rotate(radians: number, dst?: Matrix3): Matrix3
- /**
- * 求该矩阵的逆
- *
- * @param {Matrix3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix3} 计算结果
- * @memberof Matrix3
- */
- inverse(dst?: Matrix3): Matrix3
- /**
- * 将该矩阵与另一个矩阵相乘
- *
- * @param {Matrix3} m 右乘矩阵
- * @param {Matrix3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix3} 计算结果
- * @memberof Matrix3
- */
- multiply(m: Matrix3, dst?: Matrix3): Matrix3
- /**
- * 矩阵变换作用于点
- *
- * @param {Vector2} v 点
- * @param {Vector2} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector2} 计算结果
- * @memberof Matrix3
- */
- transformPoint(v: V2ReadOnly, dst?: Vector2): Vector2
- setArray(value: ArrayLike<number>, offset?: number): Matrix3
- }
- }
- declare module 'XrFrame/math/matrix4' {
- import Vector3 from 'XrFrame/math/vector3'
- import Vector4 from 'XrFrame/math/vector4'
- import V3ReadOnly from 'XrFrame/math/vector3'
- import V4ReadOnly from 'XrFrame/math/vector4'
- import QuatReadOnly from 'XrFrame/math/quaternion'
- import M3ReadOnly from 'XrFrame/math/matrix3'
- /**
- * @public
- */
- export default class Matrix4 {
- _raw: Float32Array
- /**
- * 构造相机矩阵
- *
- * @static
- * @param {Vector3} position 相机位置
- * @param {Vector3} target 相机目标位置
- * @param {Vector3} up 上方向
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- static lookAt(
- position: V3ReadOnly,
- target: V3ReadOnly,
- up: V3ReadOnly,
- dst?: Matrix4
- ): Matrix4
- /**
- * 构造透视投影矩阵
- *
- * @static
- * @param {number} fieldOfViewRadians 视野大小,用弧度表示
- * @param {number} aspect 宽高比
- * @param {number} near 近平面
- * @param {number} far 远平面
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- static perspective(
- fieldOfViewRadians: number,
- aspect: number,
- near: number,
- far: number,
- dst?: Matrix4
- ): Matrix4
- /**
- * 构造正交投影矩阵
- *
- * @static
- * @param {number} left 左平面
- * @param {number} right 右平面
- * @param {number} bottom 上平面
- * @param {number} top 下平面
- * @param {number} near 近平面
- * @param {number} far 远平面
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- static orthographic(
- left: number,
- right: number,
- bottom: number,
- top: number,
- near: number,
- far: number,
- dst?: Matrix4
- ): Matrix4
- /**
- * 将四元数转换为旋转矩阵
- *
- * @static
- * @param {Quaternion} quat 四元数
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- static fromQuaternion(quat: QuatReadOnly, dst?: Matrix4): Matrix4
- /**
- * 使用一个数组创建
- * 此操作会拷贝一份数组
- *
- * @static
- * @param {number[]} array 数据源,长度必须为16,否则会抛出异常
- * @returns {Matrix4} 创建出来的矩阵
- * @memberof Matrix4
- */
- static createFromArray(array: number[]): Matrix4
- /**
- * 使用某个已有的typedArray创建
- * 此操作不会拷贝数据,而是在原来的内存区域上操作
- *
- * @static
- * @param {Float32Array} array 数据源
- * @param {number} [offset=0] 数据源中的偏移
- * @returns {Matrix4} 创建出来的矩阵
- * @memberof Matrix4
- */
- static createFromTypedArray(
- array: Float32Array,
- offset?: number
- ): Matrix4
- /**
- * 创建绕X轴旋转的矩阵
- *
- * @static
- * @param {number} rad 旋转幅度,用弧度表示
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- static createRotationX(rad: number, dst?: Matrix4): Matrix4
- /**
- * 创建绕Y轴旋转的矩阵
- *
- * @static
- * @param {number} rad 旋转幅度,用弧度表示
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- static createRotationY(rad: number, dst?: Matrix4): Matrix4
- /**
- * 创建绕Z轴旋转的矩阵
- *
- * @static
- * @param {number} rad 旋转轴
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- static createRotationZ(rad: number, dst?: Matrix4): Matrix4
- /**
- * 创建绕指定轴旋转的矩阵
- *
- * @static
- * @param {Vector3} axis 旋转轴
- * @param {number} angleInRadians 旋转幅度,用弧度表示
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- static createRotationAxis(
- axis: V3ReadOnly,
- angleInRadians: number,
- dst?: Matrix4
- ): Matrix4
- /**
- * 将位移旋转缩放合成一个RST矩阵,旋转用矩阵表示
- *
- * @static
- * @param {V3ReadOnly} translation 位移向量
- * @param {M4ReadOnly} rotation 旋转矩阵
- * @param {V3ReadOnly} scale 缩放向量
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- static composeTRS(
- translation: V3ReadOnly,
- rotation: Matrix4,
- scale: V3ReadOnly,
- dst?: Matrix4
- ): Matrix4
- /**
- * 将位移旋转缩放合成一个RST矩阵,旋转用四元数表示
- *
- * @static
- * @param {V3ReadOnly} translation 位移向量
- * @param {QuatReadOnly} rotation 旋转四元数
- * @param {V3ReadOnly} scale 缩放向量
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- static composeTQS(
- translation: V3ReadOnly,
- rotation: QuatReadOnly,
- scale: V3ReadOnly,
- dst?: Matrix4
- ): Matrix4
- /**
- * 从二维RST矩阵扩展到三维RST矩阵
- *
- * @static
- * @param {Matrix3} m3 二维RST矩阵
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- static composeFromRST3(m3: M3ReadOnly, dst?: Matrix4): Matrix4
- /**
- * 返回矩阵数据
- *
- * @returns {number[]} 矩阵数据,以JSArray返回
- * @memberof Matrix4
- */
- toArray(): number[]
- /**
- * 将该矩阵进行位移变换
- *
- * @param {number} tx x轴位移
- * @param {number} ty y轴位移
- * @param {number} tz z轴位移
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- translate(tx: number, ty: number, tz: number, dst?: Matrix4): Matrix4
- /**
- * 将该矩阵进行缩放变换
- *
- * @param {number} sx x轴缩放
- * @param {number} sy y轴缩放
- * @param {number} sz z轴缩放
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- scale(sx: number, sy: number, sz: number, dst?: Matrix4): Matrix4
- /**
- * 将该矩阵绕x轴旋转
- *
- * @param {number} rx 旋转幅度,用弧度表示
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- xRotate(rx: number, dst?: Matrix4): Matrix4
- /**
- * 将该矩阵绕y轴旋转
- *
- * @param {number} ry 旋转幅度,用弧度表示
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- yRotate(ry: number, dst?: Matrix4): Matrix4
- /**
- * 将该矩阵绕z轴旋转
- *
- * @param {number} rz 旋转幅度,用弧度表示
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- zRotate(rz: number, dst?: Matrix4): Matrix4
- /**
- * 将该矩阵绕指定轴旋转
- *
- * @param {Vector3} axis 轴向量
- * @param {number} angleInRadians 旋转幅度,用弧度表示
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- axisRotate(
- axis: V3ReadOnly,
- angleInRadians: number,
- dst?: Matrix4
- ): Matrix4
- /**
- * 将该矩阵使用指定四元数旋转
- *
- * @param {Quaternion} quaternion 四元数
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- rotateByQuaternion(quaternion: QuatReadOnly, dst?: Matrix4): Matrix4
- /**
- * 求该矩阵的逆
- *
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- inverse(dst?: Matrix4): Matrix4
- /**
- * 求该矩阵的转置
- *
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- transpose(dst?: Matrix4): Matrix4
- /**
- * 将该矩阵与另一个矩阵相乘
- *
- * @param {Matrix4} m 右乘矩阵
- * @param {Matrix4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Matrix4} 计算结果
- * @memberof Matrix4
- */
- multiply(m: Matrix4, dst?: Matrix4): Matrix4
- /**
- * 矩阵变换作用于向量
- *
- * @param {Vector4} v 向量
- * @param {Vector4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector4} 计算结果
- * @memberof Matrix4
- */
- transformVector(v: V4ReadOnly, dst?: Vector4): Vector4
- /**
- * 矩阵变换作用于方向
- *
- * @param {Vector3} dir 方向
- * @param {Vector3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector3} 计算结果
- * @memberof Matrix4
- */
- transformDirection(dir: V3ReadOnly, dst?: Vector3): Vector3
- /**
- * 矩阵变换作用于点
- *
- * @param {Vector3} p 点
- * @param {Vector3} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector3} 计算结果
- * @memberof Matrix4
- */
- transformPoint(p: V3ReadOnly, dst?: Vector3): Vector3
- /**
- * 拷贝目标矩阵的值到该矩阵
- *
- * @param {M4ReadOnly} val 目标
- * @returns {Matrix4} 自身
- * @memberof Matrix4
- */
- set(val: Matrix4): Matrix4
- /**
- * 拷贝该矩阵
- *
- * @returns {Matrix4} 拷贝出来的对象
- * @memberof Matrix4
- */
- clone(): Matrix4
- /**
- * 分解RTS矩阵为位移、旋转、缩放向量,返回是否成功
- *
- * @param {Vector3} dstTranslation 目标位移向量
- * @param {Matrix4} dstRotationMatrix 目标旋转矩阵
- * @param {Vector3} dstScale 目标缩放分量
- * @returns {boolean} 分解是否成功,如不成功,可能是缩放分量为0
- * @memberof Matrix4
- */
- decomposeTransRotMatScale(
- dstTranslation: Vector3,
- dstRotationMatrix: Matrix4,
- dstScale: Vector3
- ): boolean
- /**
- * 设置该矩阵某行某列的值
- *
- * @param {number} value 值
- * @param {number} column 列数
- * @param {number} row 行数
- * @returns {Matrix4} 自身
- * @memberof Matrix4
- */
- setValue(value: number, column: number, row: number): Matrix4
- /**
- * 获取矩阵某行某列的值
- *
- *
- * @param {number} column 列数
- * @param {number} row 行数
- * @returns {number} 自身
- * @memberof Matrix4
- */
- getValue(column: number, row: number): number
- /**
- * 设置矩阵某列
- *
- * @param {V4ReadOnly} vec 列向量
- * @param {number} column 列数
- * @returns {Matrix4} 自身
- * @memberof Matrix4
- */
- setColumn(vec: V4ReadOnly, column: number): Matrix4
- /**
- * 获取矩阵某列
- *
- * @param {number} column 列数
- * @param {Vector4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector4} 该列数据
- * @memberof Matrix4
- */
- getColumn(column: number, dst?: Vector4): Vector4
- /**
- * 设置矩阵某行
- *
- * @param {V4ReadOnly} vec 行向量
- * @param {number} row 行数
- * @returns {Matrix4} 自身
- * @memberof Matrix4
- */
- setRow(vec: V4ReadOnly, row: number): Matrix4
- /**
- * 获取矩阵某行
- *
- * @param {number} row 行数
- * @param {Vector4} [dst] 计算结果输出到的目标对象,如不传则新建一个
- * @returns {Vector4} 该行数据
- * @memberof Matrix4
- */
- getRow(row: number, dst?: Vector4): Vector4
- setArray(value: ArrayLike<number>, offset?: number): Matrix4
- print(): void
- }
- }
- declare module 'XrFrame/math/color' {
- import Vector3 from 'XrFrame/math/vector3'
- export enum BlendType {
- Alpha = 0,
- RGB = 1,
- RGBA = 2,
- None = 3
- }
- export const GetColorFromHex: (str: any) => number
- /**
- * @public
- */
- export default class Color {
- get r(): number
- set r(val: number)
- get g(): number
- set g(val: number)
- get b(): number
- set b(val: number)
- get a(): number
- set a(val: number)
- static get WHITE(): Color
- static get BLACK(): Color
- static get TRANSPARENT(): Color
- static BlendType: typeof BlendType
- static blendColorHex(
- colorHexA: number,
- colorHexB: number,
- type?: BlendType
- ): number
- static multiplyColorHex(
- colorHexA: number,
- colorHexB: number,
- type?: BlendType
- ): number
- static getValue32FromRGBA(
- r: number,
- g: number,
- b: number,
- a: number
- ): number
- static getValue32FromHSVA(): void
- static percentRoundFn(num: number): number
- static diffc(v: number, c: number, diff: number): number
- static rgb2hsv(r: number, g: number, b: number, dst?: Vector3): Vector3
- static hsvV2rgb(h: number, s: number, v: number, dst?: Vector3): Vector3
- static randomMix(
- colorHexA: number,
- colorHexB: number,
- randomSeed?: number
- ): number
- static fromHex(hex: number): Color
- static fromHexString(hexString: string): Color
- static fromFloatArray(arr: number[]): Color
- equals(target: Color): boolean
- set(val: Color): void
- setRGBA(r: number, g: number, b: number, a: number): void
- setValue32(v32: number): void
- toNormalizedArray(): [number, number, number, number]
- toRGBAString(): string
- mix(color: Color, dst?: Color): Color
- }
- }
- declare module 'XrFrame/math/OBB' {
- import Vector3 from 'XrFrame/math/vector3'
- export default class OBB {
- constructor()
- setValues(
- cenX: number,
- cenY: number,
- cenZ: number,
- forward: Vector3,
- w: number,
- h: number,
- d: number
- ): void
- get center(): Vector3
- set center(pos: Vector3)
- get width(): number
- set width(w: number)
- get height(): number
- set height(h: number)
- get depth(): number
- set depth(d: number)
- setForward(forward: Vector3): void
- get AxisX(): Vector3
- get AxisY(): Vector3
- get AxisZ(): Vector3
- }
- }
- declare module 'XrFrame/math/boundBall' {
- import Vector3 from 'XrFrame/math/vector3'
- import V3ReadOnly from 'XrFrame/math/vector3'
- export default class BoundBall {
- static readonly OFFSETS: Readonly<{
- center: number
- radius: number
- }>
- /**
- * 包围球中心
- *
- * @type {V3ReadOnly}
- * @memberof BoundBall
- */
- get center(): V3ReadOnly
- set center(val: V3ReadOnly)
- /**
- * 包围球半径
- *
- * @type {number}
- * @memberof BoundBall
- */
- get radius(): number
- set radius(val: number)
- _raw: Float32Array
- _offset: number
- protected _center?: Vector3
- constructor(raw?: Float32Array, offset?: number)
- /**
- * 使用中心和半径创建包围球
- *
- * @static
- * @param {V3ReadOnly} center
- * @param {number} radius
- * @returns {BoundBall}
- * @memberof BoundBall
- */
- static createFromCenterAndRadius(
- center: V3ReadOnly,
- radius: number
- ): BoundBall
- /**
- * 设置值
- *
- * @param {V3ReadOnly} center
- * @param {number} radius
- * @returns {BoundBall}
- * @memberof BoundBall
- */
- setValue(center: V3ReadOnly, radius: number): BoundBall
- /**
- * 使用一系列点初始化
- *
- * @param {V3ReadOnly[]} points
- * @returns {BoundBall} 自身
- * @memberof BoundBall
- */
- initByPoints(points: V3ReadOnly[]): BoundBall
- initByPointRadius(center: V3ReadOnly, radius: number): void
- }
- }
- declare module 'XrFrame/math/boundBox' {
- import Vector3 from 'XrFrame/math/vector3'
- import V3ReadOnly from 'XrFrame/math/vector3'
- export default class BoundBox {
- static readonly OFFSETS: Readonly<{
- center: number
- size: number
- }>
- /**
- * 包围盒中心
- *
- * @type {Vector3}
- * @memberof BoundBox
- */
- get center(): V3ReadOnly
- set center(val: V3ReadOnly)
- /**
- * 包围盒尺寸
- *
- * @memberof BoundBox
- */
- get size(): V3ReadOnly
- set size(val: V3ReadOnly)
- _raw: Float32Array
- _offset: number
- protected _center?: Vector3
- protected _size?: Vector3
- constructor(raw?: Float32Array, offset?: number)
- /**
- * 使用中心和尺寸创建包围球
- *
- * @static
- * @param {V3ReadOnly} center 中心
- * @param {V3ReadOnly} size 尺寸
- * @returns {BoundBall}
- * @memberof BoundBall
- */
- static createFromCenterAndSize(
- center: V3ReadOnly,
- size: V3ReadOnly
- ): BoundBox
- /**
- * 设置值
- *
- * @param {V3ReadOnly} center
- * @param {V3ReadOnly} size
- * @returns {BoundBox}
- * @memberof BoundBox
- */
- setValue(center: V3ReadOnly, size: V3ReadOnly): BoundBox
- initByPoints(points: Vector3[], length?: number): void
- startInitByPoints(): void
- addPoint(corner: Vector3): void
- endInitByPoints(): void
- }
- }
- declare module 'XrFrame/math/Spherical' {
- /**
- * Spherical.ts
- *
- * * @Date : 2022/1/14下午4:49:50
- */
- import Vector3 from 'XrFrame/math/vector3'
- /**
- * 球面坐标系。
- */
- export default class Spherical {
- static EPS: number
- isSpherical: boolean
- /**
- * 球面半径。
- */
- radius: number
- /**
- * 点在球面上的横向旋转角度。
- */
- phi: number
- /**
- * 点在球面上的纵向旋转角度。
- */
- theta: number
- /**
- * 球面球心。
- */
- center: Vector3
- constructor(radius?: number, phi?: number, theta?: number)
- set(radius: number, phi: number, theta: number): this
- clone(): Spherical
- copy(other: Spherical): this
- /**
- * restrict phi to be between EPS and PI-EPS。
- */
- makeSafe(): this
- /**
- * 从笛卡尔坐标系的Vector3转换。
- */
- setFromVector3(vector: Vector3): this
- /**
- * 从笛卡尔坐标系的x、y、z转换。
- */
- setFromCartesianCoords(x: number, y: number, z: number): this
- /**
- * 转换到笛卡尔坐标系的Vector3。
- */
- toVector3(vector?: Vector3): Vector3
- }
- }
- declare module 'XrFrame/kanata/lib/kanata' {
- import * as IKanata from 'XrFrame/kanata/lib/frontend'
- import { IEngineSettings } from 'XrFrame/kanata/lib/backend/interface'
- export * from 'XrFrame/kanata/lib/backend/interface'
- export {
- ITextureOptions,
- IRenderPassDescriptor
- } from 'XrFrame/kanata/lib/index'
- export type AnimatorComponent = IKanata.AnimatorComponent
- export type CameraComponent = IKanata.CameraComponent
- export type LightCameraComponent = IKanata.LightCameraComponent
- export type CullingComponent = IKanata.CullingComponent
- export type MeshRendererComponent = IKanata.MeshRendererComponent
- export type SkinnedSkeletonComponent = IKanata.SkinnedSkeletonComponent
- export type DynamicBonesComponent = IKanata.DynamicBonesComponent
- export type Entity2D = IKanata.Entity2D
- export type Entity3D = IKanata.Entity3D
- export type AnimationClipModel = IKanata.AnimationClipModel
- export type AnimationClipBinding = IKanata.AnimationClipBinding
- export type AnimatorControllerModel = IKanata.AnimatorControllerModel
- export type AnimatorControllerStateModel =
- IKanata.AnimatorControllerStateModel
- export type DataBuffer = IKanata.DataBuffer
- export type DataModel = IKanata.DataModel
- export type Effect = IKanata.Effect
- export type Material = IKanata.Material
- export type SkeletonBoneInverseModel = IKanata.SkeletonBoneInverseModel
- export type UniformBlock = IKanata.UniformBlock
- export type UniformDescriptor = IKanata.UniformDescriptor
- export type IndexBuffer = IKanata.IndexBuffer
- export type IndexData = IKanata.IndexData
- export type VertexBuffer = IKanata.VertexBuffer
- export type VertexData = IKanata.VertexData
- export type VertexLayout = IKanata.VertexLayout
- export type VertexDataDescriptor = IKanata.VertexDataDescriptor
- export type View = IKanata.View
- export type ScalableList = IKanata.ScalableList
- export type RenderPass = IKanata.RenderPass
- export type Texture = IKanata.Texture
- export type RenderEnv = IKanata.RenderEnv
- export interface IKanataInstance {
- Image: typeof IKanata.Image
- Downloader: typeof IKanata.Downloader
- IS_VALID: typeof IKanata.IS_VALID
- GET_MAIN_CANVAS: typeof IKanata.GET_MAIN_CANVAS
- Phys3D: typeof IKanata.Phys3D
- AnimatorComponent: typeof IKanata.AnimatorComponent
- CameraComponent: typeof IKanata.CameraComponent
- LightCameraComponent: typeof IKanata.LightCameraComponent
- CullingComponent: typeof IKanata.CullingComponent
- MeshRendererComponent: typeof IKanata.MeshRendererComponent
- SkinnedSkeletonComponent: typeof IKanata.SkinnedSkeletonComponent
- DynamicBonesComponent: typeof IKanata.DynamicBonesComponent
- Entity2D: typeof IKanata.Entity2D
- Entity3D: typeof IKanata.Entity3D
- AnimationClipModel: typeof IKanata.AnimationClipModel
- AnimationClipBinding: typeof IKanata.AnimationClipBinding
- AnimatorControllerModel: typeof IKanata.AnimatorControllerModel
- AnimatorControllerStateModel: typeof IKanata.AnimatorControllerStateModel
- DataBuffer: typeof IKanata.DataBuffer
- DataModel: typeof IKanata.DataModel
- Effect: typeof IKanata.Effect
- Material: typeof IKanata.Material
- SkeletonBoneInverseModel: typeof IKanata.SkeletonBoneInverseModel
- UniformBlock: typeof IKanata.UniformBlock
- UniformDescriptor: typeof IKanata.UniformDescriptor
- IndexBuffer: typeof IKanata.IndexBuffer
- IndexData: typeof IKanata.IndexData
- VertexBuffer: typeof IKanata.VertexBuffer
- VertexData: typeof IKanata.VertexData
- VertexLayout: typeof IKanata.VertexLayout
- VertexDataDescriptor: typeof IKanata.VertexDataDescriptor
- View: typeof IKanata.View
- ScalableList: typeof IKanata.ScalableList
- crossContext: typeof IKanata.crossContext
- RenderPass: typeof IKanata.RenderPass
- Texture: typeof IKanata.Texture
- RenderEnv: typeof IKanata.RenderEnv
- renderEnv: typeof IKanata.renderEnv
- createWeakRef: typeof IKanata.createWeakRef
- createWeakRefSentry: typeof IKanata.createWeakRefSentry
- createNativeUUMap: typeof IKanata.createNativeUUMap
- createNativeSUMap: typeof IKanata.createNativeSUMap
- createNativeULUMap: typeof IKanata.createNativeULUMap
- loadTTFFont: typeof IKanata.loadTTFFont
- getGlyphInfo: typeof IKanata.getGlyphInfo
- refreshNodesWorldTransform: typeof IKanata.refreshNodesWorldTransform
- setGlobalPhysicSystem: typeof IKanata.setGlobalPhysicSystem
- bindRigidBodyToNode: typeof IKanata.bindRigidBodyToNode
- bindCCTToNode: typeof IKanata.bindCCTToNode
- unbindRigidBody: typeof IKanata.unbindRigidBody
- unbindCCT: typeof IKanata.unbindCCT
- decodeBase64: typeof IKanata.decodeBase64
- initDraco: typeof IKanata.initDraco
- decodeDraco: typeof IKanata.decodeDraco
- setNodeName: typeof IKanata.setNodeName
- setRenderComponentName: typeof IKanata.setRenderComponentName
- debugPrint: typeof IKanata.debugPrint
- eventBridge: typeof IKanata.eventBridge
- destroy: typeof IKanata.destroy
- update: typeof IKanata.update
- }
- export function CREATE_INSTANCE(
- MAIN_CANVAS: HTMLCanvasElement,
- ENGINE_SETTINGS: IEngineSettings,
- ENGINE_MODE: 'Game' | 'Editor',
- IS_SUB_CONTEXT: boolean,
- HOST: string,
- FIX_INSTANCE: boolean
- ): IKanataInstance
- export function RELEASE_INSTANCE(MAIN_CANVAS: HTMLCanvasElement): void
- }
- declare module 'XrFrame/core/Scene' {
- /**
- * Scene.ts
- *
- * * @Date : 2022/3/16下午3:32:57
- */
- import Transform from 'XrFrame/components/Transform'
- import { Kanata } from 'XrFrame/ext'
- import AssetsSystem from 'XrFrame/systems/AssetsSystem'
- import RenderSystem from 'XrFrame/systems/RenderSystem'
- import Element, { IEntityComponents } from 'XrFrame/core/Element'
- import Material from 'XrFrame/assets/Material'
- import RenderTexture, {
- IRenderTextureOptions
- } from 'XrFrame/assets/RenderTexture'
- import Effect, { IEffectAsset } from 'XrFrame/assets/Effect'
- import Geometry from 'XrFrame/assets/Geometry'
- import AnimationSystem from 'XrFrame/systems/AnimationSystem'
- import PhysicsSystem from 'XrFrame/systems/PhysicsSystem'
- import ARSystem from 'XrFrame/systems/ARSystem'
- import { XRShadow } from 'XrFrame/elements'
- import { GizmoSystem, ShareSystem, VideoSystem } from 'XrFrame/systems'
- import VideoTexture, {
- IVideoTextureOptions
- } from 'XrFrame/assets/VideoTexture'
- import PostProcess, {
- IPostProcessOptions
- } from 'XrFrame/assets/PostProcess'
- /**
- * 场景的默认组件,均为系统。
- */
- export const SceneDefaultComponents: IEntityComponents
- /**
- * 场景的默认映射。
- */
- export const SceneDataMapping: {
- [key: string]: string[]
- }
- export interface TDict<T> {
- [key: string]: T
- }
- /**
- * 场景,系统核心之一。
- *
- * `Scene`是元素的一种,对应于`xr-scene`标签。
- * 作为整个`xr-frame`组件的根节点,它提供了整个组件运作的一些基本能力,挂在了各大系统,驱动生命周期循环。
- */
- export default class Scene extends Element {
- readonly defaultComponents: IEntityComponents
- readonly isScene: boolean
- /**
- * 场景是否已经就绪。
- */
- get ready(): boolean
- /**
- * 自身。
- */
- get scene(): this
- /**
- * 一个可以用于快速挂载自己创建的`Element`的`shadow`节点。
- */
- get rootShadow(): XRShadow
- /**
- * 资源系统。
- */
- get assets(): AssetsSystem
- /**
- * 渲染系统。
- */
- get render(): RenderSystem
- /**
- * 动画系统。
- */
- get animation(): AnimationSystem
- /**
- * 视频系统。
- */
- get video(): VideoSystem
- /**
- * 物理系统。
- */
- get physics(): PhysicsSystem
- /**
- * AR系统。
- */
- get ar(): ARSystem
- /**
- * Gizmo系统。
- */
- get gizmo(): GizmoSystem
- /**
- * 分享系统。
- */
- get share(): ShareSystem
- /**
- * 渲染分辨率宽,一般物理点击事件之类的都是参考这个。
- */
- get width(): number
- /**
- * 渲染分辨率高,一般物理点击事件之类的都是参考这个。
- */
- get height(): number
- /**
- * 显示分辨率宽。
- */
- get frameWidth(): number
- /**
- * 显示分辨率高。
- */
- get frameHeight(): number
- /**
- * 当前时间戳(ms)。
- */
- get timestamp(): number
- /**
- * @internal
- */
- get renderPass(): Kanata.RenderPass
- /**
- * @internal
- */
- get rootNode(): import('XrFrame/kanata/lib/index').Entity3D
- /**
- * @internal
- */
- get backendVersion(): number[]
- /**
- * @internal
- */
- versionBefore(major: number, minor: number): boolean
- /**
- * @internal
- */
- get backendCommit(): string
- /**
- * @internal
- */
- get backendUsePuppetSokol(): boolean
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * 创建一个`Element`,但注意**其只能作为`xr-shadow`的子孙节点**,否则可能会出错!
- *
- * @param attributes 初始化的属性,同于`xml`中对应的标签属性。
- */
- createElement<T extends Element>(
- clz: new (...args: any) => T,
- attributes?: {
- [name: string]: string
- }
- ): T
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * 通过在`wxml`的元素上设置的`id`索引一个元素,`id`是唯一的。
- */
- getElementById(id: string): Element
- /**
- * 通过在`wxml`的元素上设置的`node-id`索引一个`Transform`组件,`node-id`是唯一的。
- */
- getNodeById(nodeId: string): Transform
- /**
- * @internal
- */
- /**
- * 手动创建一个`Image`资源。
- *
- * @param autoRelease 此图片在第一次时候后是否释放原始数据,默认释放。
- */
- createImage(autoRelease?: boolean): Kanata.IImage
- /**
- * 手动创建一个`Texture`资源。
- */
- createTexture(options: Kanata.ITextureOptions): Kanata.Texture
- /**
- * 手动创建一个`Effect`资源。
- */
- createEffect(description: IEffectAsset): Effect
- /**
- * 手动创建一个`UniformBlockDescriptor`资源。
- */
- createUniformBlockDesc(
- options: Kanata.IUniformDescriptorOptions
- ): Kanata.UniformDescriptor
- /**
- * 手动创建一个`UniformBlock`资源。
- */
- createUniformBlock(
- descriptor: Kanata.UniformDescriptor
- ): Kanata.UniformBlock
- /**
- * 手动创建一个`Material`资源。
- */
- createMaterial(
- effect: Effect,
- defaultUniforms?: {
- [key: string]: number | ArrayLike<number> | Kanata.Texture
- }
- ): Material
- /**
- * 手动创建一个`VertexLayout`资源。
- */
- createVertexLayout(
- options: Kanata.IVertexLayoutOptions
- ): Kanata.VertexLayout
- /**
- * 手动创建一个`Geometry`资源。
- */
- createGeometry(
- vertexLayout: Kanata.VertexLayout,
- vBuffer: ArrayBufferView,
- iBuffer: ArrayBufferView,
- indexType?: Kanata.EIndexType
- ): Geometry
- /**
- * 手动创建一个`RenderTexture`资源。
- */
- createRenderTexture(options?: IRenderTextureOptions): RenderTexture
- /**
- * 手动创建一个`VideoTexture`资源。
- */
- createVideoTexture(
- options?: IVideoTextureOptions
- ): Promise<VideoTexture>
- /**
- * 手动创建一个`PostProcess`资源。
- */
- createPostProcess(options: IPostProcessOptions): PostProcess
- }
- }
- declare module 'XrFrame/core/Observable' {
- export default class Observable<TParams = any, TSender = any> {
- isObservable: boolean
- /**
- * 拥有的监听者数量。
- */
- get count(): number
- /**
- * 添加一个回调到队列中。
- */
- add(
- callback: (params: TParams, sender?: TSender) => void | boolean,
- priority?: number,
- isOnce?: boolean
- ): this
- /**
- * 添加一个回调到队列中,并再被触发执行一次后自动移除。
- */
- addOnce(
- callback: (params: TParams, sender?: TSender) => void | boolean,
- priority?: number
- ): this
- /**
- * 清空队列。
- */
- clear(): this
- /**
- * 从队列中移除一个回调。
- */
- remove(
- callback: (params: TParams, sender?: TSender) => void | boolean
- ): this
- /**
- * 通过一个参数触发一次广播,调用所有回调。
- */
- notify(params: TParams, sender?: TSender): this
- }
- }
- declare module 'XrFrame/components/Transform' {
- /**
- * Transform.ts
- *
- * * @Date : 2022/3/16下午3:48:05
- */
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- import Matrix4 from 'XrFrame/math/matrix4'
- import Quaternion from 'XrFrame/math/quaternion'
- import Vector3 from 'XrFrame/math/vector3'
- /**
- * {@link Transform}组件数据接口。
- */
- export interface ITransformData {
- /**
- * 设置一个唯一的节点Id,区别于`xml`上的那个`id`。
- * `xml`中的数据类型为`string`。
- */
- nodeId: string
- /**
- * 节点的位移。
- * `xml`中的数据类型为`number-array`,默认为`0 0 0`。
- */
- position: number[]
- /**
- * 节点的旋转,注意此处为**角度**。
- * `xml`中的数据类型为`number-array`,默认为`0 0 0`。
- */
- rotation: number[]
- /**
- * 节点的位缩放。
- * `xml`中的数据类型为`number-array`,默认为`1 1 1`。
- */
- scale: number[]
- /**
- * 节点的可见性,可以控制该节点以及所有子节点是否可见。
- * `xml`中的数据类型为`boolean`,默认为`true`。
- */
- visible?: boolean
- /**
- * 节点的层级,作为控制节点以及子节点是否可见的一部分,配合{@link Camera.cullMask}使用。
- * 判定规则为自顶层节点向下,只有全部通过了判定才能显示。
- * `xml`中的数据类型为`number`,默认为`0`。
- */
- layer?: number
- }
- /**
- * {@link Transform}的`schema`,详见{@link ITransformData}。
- */
- export const TransformSchema: IComponentSchema
- /**
- * 3D变换组件,作为场景中3D节点的根基,一般被代理到{@link XRNode}元素。
- */
- export default class Transform extends Component<ITransformData> {
- /**
- * 详见{@link TransformSchema}。
- */
- readonly schema: IComponentSchema
- readonly priority: number
- get node(): import('XrFrame/kanata/lib/index').Entity3D
- /**
- * 获取世界矩阵,**注意不可修改**。
- */
- get worldMatrix(): Matrix4
- /**
- * 获取世界绝对位移,**注意不可修改**。
- */
- get worldPosition(): Vector3
- /**
- * 获取世界绝对旋转,**注意不可修改**。
- */
- get worldQuaternion(): Quaternion
- /**
- * 获取世界绝对缩放,**注意不可修改**。
- */
- get worldScale(): Vector3
- /**
- * 获取世界前向向量,**注意不可修改**。
- */
- get worldForward(): Vector3
- /**
- * 获取世界上向向量,**注意不可修改**。
- */
- get worldUp(): Vector3
- /**
- * 获取世界右向向量,**注意不可修改**。
- */
- get worldRight(): Vector3
- get position(): Vector3
- /**
- * 注意如果这里直接修改,使用**弧度**。
- */
- get rotation(): Vector3
- get quaternion(): Quaternion
- get scale(): Vector3
- get visible(): boolean
- set visible(value: boolean)
- get layer(): number
- set layer(value: number)
- /**
- * @internal
- */
- /**
- * 直接设置本地矩阵。
- */
- setLocalMatrix(mat: Matrix4): void
- onAdd(parent: Element, data: ITransformData): void
- onUpdate(data: ITransformData, preData: ITransformData): void
- onRemove(parent: Element, data: ITransformData): void
- onRelease(data: ITransformData): void
- }
- }
- declare module 'XrFrame/components/AssetLoad' {
- /**
- * AssetLoad.ts
- *
- * * @Date : 2022/3/31下午4:56:14
- */
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- import { IAssetLoadData } from 'XrFrame/loader/types'
- /**
- * {@link AssetLoad}的`schema`,详见{@link IAssetLoadData}。
- */
- export const AssetLoadSchema: IComponentSchema
- /**
- * 用于加载资源的组件,一般被代理到{@link XRAssetLoad}元素。
- */
- export default class AssetLoad extends Component<IAssetLoadData> {
- /**
- * 详见{@link AssetLoadSchema}。
- */
- readonly schema: IComponentSchema
- /**
- * @internal
- */
- get loadParams(): IAssetLoadData<any>
- onAdd(parent: Element, data: IAssetLoadData): void
- onUpdate(data: IAssetLoadData, preData: IAssetLoadData): void
- onRemove(parent: Element, data: IAssetLoadData<any>): void
- }
- }
- declare module 'XrFrame/components/Assets' {
- /**
- * Assets.ts
- *
- * * @Date : 2022/3/24下午3:18:14
- */
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import { IAssetLoadData } from 'XrFrame/loader/types'
- export interface IAssetsData {}
- export const AssetsSchema: IComponentSchema
- /**
- * 资源加载组组件,会统计作为其子节点的{@link AssetLoad}组件的加载状态,派发事件。
- * 一般被代理到{@link XRAssets}元素。
- *
- * 事件`progress`会在资源加载进度更新时触发,值为`{progress: number, asset: IAssetLoadData}`。
- * 事件`loaded`会在所有资源加载完成是触发,值为`{assets: {[key: string]: IAssetLoadData}, errors: {[key: string]: Error}}`。
- * 详见{@link IAssetLoadData}。
- */
- export default class Assets extends Component<IAssetsData> {
- static EVENTS: string[]
- readonly schema: IComponentSchema
- }
- }
- declare module 'XrFrame/components/Camera' {
- /**
- * Camera.ts
- *
- * * @Date : 2022/3/17下午5:25:34
- */
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- import { Kanata } from 'XrFrame/ext'
- import Vector3 from 'XrFrame/math/vector3'
- import Matrix4 from 'XrFrame/math/matrix4'
- import RenderTexture, { IRenderTarget } from 'XrFrame/assets/RenderTexture'
- import Transform from 'XrFrame/components/Transform'
- import Light from 'XrFrame/components/Light'
- import PostProcess from 'XrFrame/assets/PostProcess'
- /**
- * 相机背景渲染模式。
- *
- * `default`模式只执行默认清屏。
- * `skybox`模式配合{@link Env}组件使用。
- * `ar`模式配合{@link ARSystem}使用。
- */
- export type TCameraBackground = 'default' | 'skybox' | 'ar'
- /**
- * {@link Camera}组件数据接口。
- */
- export interface ICameraData {
- /**
- * 相机对准的目标节点,如果不设置则为自由模式。
- * `xml`中的数据类型为节点对应的`nodeId`。
- */
- target?: Transform
- /**
- * 相机的渲染目标,如果不设置则渲染到屏幕。
- * `xml`中的数据类型为`render-texture`资源。
- */
- renderTarget?: RenderTexture
- /**
- * 深度,决定在多相机时的渲染顺序。
- * `xml`中的数据类型为`number`。
- */
- depth: number
- /**
- * 掩码,一般和{@link Transform.layer}一起使用,决定那些节点要被渲染。
- * `xml`中的数据类型为`number`。
- */
- cullMask: number
- /**
- * 是否为透视相机。
- * `xml`中的数据类型为`boolean`,默认为`true`。
- */
- isPerspective: boolean
- /**
- * 视场角。
- * `xml`中的数据类型为`number`,默认为`60`。
- */
- fov: number
- /**
- * 近平面。
- * `xml`中的数据类型为`number`,默认为`0.1`。
- */
- near: number
- /**
- * 远平面。
- * `xml`中的数据类型为`number`,默认为`100`。
- */
- far: number
- /**
- * 非透视模式,即正交模式时,可视范围大小。
- * `xml`中的数据类型为`number`,默认为`4`。
- */
- orthSize: number
- /**
- * 背景清屏模式。
- * `xml`中的数据类型为`string`,默认为`default`。
- */
- background: TCameraBackground
- /**
- * 是否为AR相机,配合{@link ARSystem}使用。
- * `xml`中的数据类型为`boolean`,默认为`false`。
- * **非常需要注意当设置为`true`时不能同时设置`target`数据!**
- */
- isARCamera: boolean
- /**
- * 清屏是否要清深度。
- * `xml`中的数据类型为`boolean`,默认为`true`。
- */
- isClearDepth: boolean
- /**
- * 清屏是否要清模板值。
- * `xml`中的数据类型为`boolean`,默认为`true`。
- */
- isClearStencil: boolean
- /**
- * 清屏是否要清颜色。
- * `xml`中的数据类型为`boolean`,默认为`true`。
- */
- isClearColor: boolean
- /**
- * 清屏深度。
- * `xml`中的数据类型为`number`,默认为`1`。
- */
- clearDepth: number
- /**
- * 清屏模板值。
- * `xml`中的数据类型为`number`,默认为`0`。
- */
- clearStencil: number
- /**
- * 清屏颜色。
- * `xml`中的数据类型为`color`,默认为`0 0 0 1`。
- */
- clearColor: number[]
- /**
- * 后处理,一个后处理资源id的数组。
- * `xml`中的数据类型为`array`,默认为空。
- */
- postProcess: string[]
- /**
- * 允许的渲染标记,配合{@link RenderSystem}的`changeFeatures`一起使用。
- * `xml`中的数据类型为`array`,默认为空。
- */
- allowFeatures: string[]
- }
- /**
- * {@link Camera}的`schema`,详见{@link ICameraData}。
- */
- export const CameraSchema: IComponentSchema
- /**
- * 相机组件,一般被代理到{@link XRCamera}元素。
- */
- export default class Camera extends Component<ICameraData> {
- /**
- * 详见{@link CameraSchema}。
- */
- readonly schema: IComponentSchema
- readonly priority: number
- /**
- * 相机深度。
- */
- get depth(): number
- /**
- * @internal
- */
- get renderTarget(): IRenderTarget
- /**
- * @internal
- */
- get view(): import('XrFrame/kanata/lib/index').View
- /**
- * @internal
- */
- get id(): number
- /**
- * @internal。
- */
- get bgStates(): {
- [key: string]: any
- }
- /**
- * @internal。
- */
- get bgStatesClear(): boolean
- get background(): TCameraBackground
- get target(): Transform
- get near(): number
- get far(): number
- get cullMask(): number
- get postProcess(): PostProcess[]
- get hdr(): boolean
- get allowFeatures(): string[]
- /**
- * 当前渲染特性集合。
- */
- get features(): {
- [key: string]: string | number | boolean
- }
- /**
- * @internal
- */
- cull(cullResult: Kanata.ScalableList, lightMode: string): void
- /**
- * @internal
- */
- clear(): void
- /**
- * @internal
- */
- draw(renderList: Kanata.ScalableList, lightMode: string): void
- /**
- * @internal
- */
- drawLight(
- light: Light,
- renderList: Kanata.ScalableList,
- lightMode: string
- ): void
- /**
- * 将世界坐标系位置转换到齐次裁剪空间。
- */
- convertWorldPositionToClip(worldPos: Vector3, dst?: Vector3): Vector3
- /**
- * 将齐次裁剪空间转换到世界坐标系位置。
- */
- convertClipPositionToWorld(clipPos: Vector3, dst?: Vector3): Vector3
- /**
- * 修改viewMatrix的设置类型。
- *
- * @param manual 是否要设置为手动模式。
- * @param mat4 手动模式下,要设置的值。
- */
- changeViewMatrix(manual: boolean, mat4?: Matrix4 | Float32Array): void
- /**
- * 修改projectMatrix的设置类型。
- *
- * @param manual 是否要设置为手动模式。
- * @param mat4 手动模式下,要设置的值。
- */
- changeProjectMatrix(
- manual: boolean,
- mat4?: Matrix4 | Float32Array
- ): void
- /**
- * 修改相机背景的渲染状态。
- *
- * @param states 同{@link Material.setRenderStates}
- */
- setBackgroundRenderStates(states: { [key: string]: any }): void
- /**
- * 清空相机背景渲染状态。
- */
- clearBackgroundRenderStates(): void
- onAdd(parent: Element, data: ICameraData): void
- onUpdate(data: ICameraData, preData: ICameraData): void
- onTick(deltaTime: number, data: ICameraData): void
- onRemove(parent: Element, data: ICameraData): void
- onRelease(data: ICameraData): void
- protected _processData(data: ICameraData, preData: ICameraData): void
- }
- }
- declare module 'XrFrame/components/GLTF' {
- import GLTFModel, { TQS } from 'XrFrame/assets/GLTFModel'
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- import BoundBox from 'XrFrame/math/boundBox'
- import Mesh from 'XrFrame/components/Mesh'
- /**
- * @see {@link GLTF}
- */
- export interface IGLTFData {
- /**
- * 已加载完毕的GLTF模型。
- */
- model: GLTFModel
- /**
- * 是否投射阴影,默认false。
- */
- castShadow?: boolean
- /**
- * 是否接受阴影,默认false。
- */
- receiveShadow?: boolean
- /**
- * 是否不参与剔除,默认false(即参与剔除)。
- */
- neverCull?: boolean
- /**
- * 修改GLTF的默认renderStates。
- */
- states?: Array<[string, string]>
- }
- export const GLTFSchema: IComponentSchema
- interface ElementGLTFInfo {
- el: Element
- hasMesh: boolean
- meshName?: string
- meshes?: Mesh[]
- }
- /**
- * 将一个{@link GLTFModel | GLTF模型}实例化并渲染出来。
- * {@link XRGLTF | xr-gltf}标签会自动生成该组件。
- *
- * > 会在当前元素下新建一系列子元素,作为GLTF模型的每个场景的根节点。
- * > 会在当前元素上新建{@link Animator}组件,并向其添加实例化生成的动画片段。
- *
- * @see {@link IGLTFData}
- */
- export default class GLTFComponent extends Component<IGLTFData> {
- static EVENTS: string[]
- readonly schema: IComponentSchema
- readonly priority: number
- _subRoots: Element[]
- _nodeMap: Map<string, ElementGLTFInfo>
- onUpdate(data: IGLTFData, preData: IGLTFData): void
- onRemove(parent: Element, data: IGLTFData): void
- onRelease(data: IGLTFData): void
- /**
- * 根据GLTF模型中节点的`name`字段来获取内部元素。
- */
- getInternalNodeByName(name: string): Element | undefined
- /**
- * @internal
- */
- /**
- * 获取GLTF模型实例化过程中生成的所有{@link Mesh}组件。
- */
- get meshes(): Mesh[]
- /**
- * 计算GLTF模型整体的包围盒,返回**模型空间**内的计算结果。
- * 每次调用都会重新计算。
- */
- calcTotalBoundBox(): BoundBox
- /**
- * 根据GLTF模型中**引用**了Mesh的**Node节点**的`name`字段,来获取对应Mesh下的所有Primitive。
- * 一个GLTF模型中的Primitive节点对应返回中的一个`xr-frame Mesh组件`实例。
- * **如果没有该名字的节点,或者节点未引用Mesh,会返回空数组。*
- * @param name Node节点的`name`(而非Mesh节点)
- */
- getPrimitivesByNodeName(name: string): Mesh[]
- /**
- * 根据GLTF模型中Mesh节点的`name`字段,来获取引用了该Mesh的**所有**Node节点下的所有Primitive。
- * 在xr-frame实现中,每个引用了该Mesh的GLTFNode节点拥有**独立**的一份Primitives副本,**每个**Node节点下的**每个**Primitive对应一个`xr-frame Mesh组件`。
- * **如果没有引用了该Mesh的Node节点,会返回空数组。*
- * @param name Mesh节点的`name`
- * @returns 一个数组,数组中的一个元素对应一个引用了该Mesh的GLTFNode节点,元素中nodeName为GLTFNode节点的`name`字段。
- */
- getPrimitivesByMeshName(name: string): Array<{
- nodeName: string
- primitives: Mesh[]
- }>
- }
- export {}
- }
- declare module 'XrFrame/components/Light' {
- /**
- * Light.ts
- *
- * * @Date : 2022/3/16下午4:45:56
- */
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- import { Kanata } from 'XrFrame/ext'
- /**
- * 光照类型枚举。
- */
- export enum ELightType {
- /**
- * 环境光,默认只有一个生效。
- */
- Ambient = 'ambient',
- /**
- * 平行光,默认第一个会成为主平行光。
- */
- Directional = 'directional',
- /**
- * 点光。
- */
- Point = 'point',
- /**
- * 聚光。
- */
- Spot = 'spot'
- }
- /**
- * {@link Light}组件数据接口。
- */
- export interface ILightData {
- /**
- * 类型。
- * `xml`中的数据类型`string`,默认为`directional`。
- */
- type: ELightType
- /**
- * 颜色。
- * `xml`中的数据类型`color`,默认为`[1, 1, 1, 1]`。
- */
- color: number[]
- /**
- * 强度。
- * `xml`中的数据类型`number`,默认为`1`。
- */
- intensity: number
- /**
- * 范围,仅在点光和聚光有效。
- * `xml`中的数据类型`number`,默认为`1`。
- */
- range: number
- /**
- * 仅在聚光有效。
- * `xml`中的数据类型`number`,默认为`1`。
- */
- innerConeAngle: number
- /**
- * 仅在聚光有效。
- * `xml`中的数据类型`number`,默认为`1`。
- */
- outerConeAngle: number
- /**
- * 是否要产生阴影,仅对平行光有效。
- * `xml`中的数据类型`boolean`,默认为`false`。
- */
- castShadow?: boolean
- /**
- * 产生阴影的最大距离,仅对平行光有效。
- * `xml`中的数据类型`number`,默认为`10`。
- */
- shadowDistance?: number
- /**
- * 阴影采样时的容许偏移,仅对平行光有效。
- * `xml`中的数据类型`number`,默认为`0.002`。
- */
- shadowBias?: number
- }
- /**
- * {@link Light}的`schema`,详见{@link ILightData}。
- */
- export const LightSchema: IComponentSchema
- /**
- * 灯光组件,一般被代理到{@link XRLight}元素。
- *
- * 注意整个场景只能存在一个`ambient`光源,第一个`directional`光源将会成为主光源,也只有这个光源能够产生阴影。
- * 目前最多支持四个追加光源。
- */
- export default class Light extends Component<ILightData> {
- /**
- * 详见{@link LightSchema}。
- */
- readonly schema: IComponentSchema
- readonly priority: number
- get type(): ELightType
- get color(): number[]
- get intensity(): number
- get range(): number
- get innerConeAngle(): number
- get outerConeAngle(): number
- get castShadow(): boolean
- get shadowDistance(): number
- get shadowBias(): number
- /**
- * @internal
- */
- get lightCamera(): import('XrFrame/kanata/lib/index').LightCameraComponent
- /**
- * @internal
- */
- onAdd(parent: Element, data: ILightData): void
- onUpdate(data: ILightData, preData: ILightData): void
- onTick(deltaTime: number, data: ILightData): void
- onRemove(parent: Element, data: ILightData): void
- onRelease(data: ILightData): void
- /**
- * @internal
- */
- }
- }
- declare module 'XrFrame/components/AssetMaterial' {
- import Effect from 'XrFrame/assets/Effect'
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- import EnvData from 'XrFrame/assets/EnvData'
- /**
- * `AssetMaterial`数据接口。
- */
- export interface IAssetMaterialData {
- /**
- * 被引用时的资源Id。
- * `xml`中的数据类型为`string`。
- */
- assetId: string
- /**
- * 基于的效果。
- * `xml`中的数据类型为`effect`资源,默认为`simple`。
- */
- effect: Effect
- /**
- * 初始要写入的`uniforms`,类型根据`effect`中的定义决定。
- * `xml`中的数据类型为`map`。
- */
- uniforms: Array<[string, string]>
- /**
- * 初始要写入的渲染状态`states`。
- * `xml`中的数据类型为`map`。
- * 目前支持`renderQueue`、`cullOn`、`depthTestOn`、`depthTestWrite`、`alphaMode`、`alphaCutOff`。
- * `alphaMode`和`alphaCutOff`遵循glTF标准。
- */
- states: Array<[string, string]>
- /**
- * 要覆盖的渲染顺序。
- * `xml`中的数据类型为`number`,无默认值。
- * 大于等于`2500`视为透明物体。
- */
- renderQueue: number
- /**
- * 用于覆盖全局的、材质维度的环境数据。
- */
- envData?: EnvData
- }
- /**
- * {@link AssetMaterial}的`schema`,详见{@link IAssetMaterialData}。
- */
- export const AssetMaterialSchema: IComponentSchema
- /**
- * 材质资源创建组件,为了在`xml`中创建{@link Material}资源,一般被代理到{@link XRAssetMaterial}元素。
- */
- export default class AssetMaterial extends Component<IAssetMaterialData> {
- /**
- * 详见{@link AssetMaterialSchema}。
- */
- readonly schema: IComponentSchema
- onAdd(parent: Element, data: IAssetMaterialData): void
- onUpdate(data: IAssetMaterialData, preData: IAssetMaterialData): void
- onRemove(parent: Element, data: IAssetMaterialData): void
- }
- }
- declare module 'XrFrame/components/Mesh' {
- /**
- * Model.ts
- *
- * * @Date : 2022/3/16下午4:48:09
- */
- import Geometry from 'XrFrame/assets/Geometry'
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- import { Kanata } from 'XrFrame/ext'
- import Material from 'XrFrame/assets/Material'
- import Transform from 'XrFrame/components/Transform'
- import EnvData from 'XrFrame/assets/EnvData'
- /**
- * `Mesh`数据接口。
- */
- export interface IMeshData {
- /**
- * 是否强制不被剔除。
- * `xml`中的数据类型为`boolean`,默认为`false`。
- */
- neverCull?: boolean
- /**
- * 在主光源产生阴影开启阴影时,是否要产生阴影。
- * `xml`中的数据类型为`boolean`,默认为`false`。
- */
- castShadow?: boolean
- /**
- * 在主光源产生阴影开启阴影时,是否要接受阴影。
- * `xml`中的数据类型为`boolean`,默认为`false`。
- */
- receiveShadow?: boolean
- /**
- * 渲染使用的几何数据。
- * `xml`中的数据类型为`geometry`资源。
- */
- geometry: Geometry
- /**
- * 渲染使用的材质数据。
- * `xml`中的数据类型为`material`资源。
- */
- material?: Material
- /**
- * 覆盖`material`中的默认`uniforms`,如果覆盖了,则会先创建一个材质副本。
- * `xml`中同{@link IAssetMaterialData.uniforms}。
- */
- uniforms?: Array<[string, string]>
- /**
- * 覆盖`material`中的默认`states`,如果覆盖了,则会先创建一个材质副本。
- * `xml`中同{@link IAssetMaterialData.states}。
- */
- states?: Array<[string, string]>
- /**
- * 用于覆盖`material`中的,全局的、材质维度的环境数据。
- * * `xml`中同{@link IAssetMaterialData.envData}。
- */
- envData?: EnvData
- }
- /**
- * {@link Mesh}的`schema`,详见{@link IMeshData}。
- */
- export const MeshSchema: IComponentSchema
- /**
- * Mesh组件,整合{@link Geometry}和{@link Material}进行渲染,一般被代理到{@link XRMesh}元素。
- */
- export default class Mesh extends Component<IMeshData> {
- /**
- * 详见{@link MeshSchema}。
- */
- readonly schema: IComponentSchema
- readonly priority: number
- protected _cull: Kanata.CullingComponent
- protected _mesh: Kanata.MeshRendererComponent
- protected _sourceMaterial: Material
- protected _geometry: Geometry
- protected _material: Material
- protected _trs: Transform
- /**
- * 几何数据。
- */
- get geometry(): Geometry
- /**
- * 材质。
- */
- get material(): Material
- set material(value: Material)
- /**
- * MorphTargets的权重,最多32个,可以获取后直接修改。
- */
- get morphWeights(): Float32Array
- /**
- * @internal
- */
- get id(): number
- /**
- * @internal
- */
- onAdd(parent: Element, data: IMeshData): void
- onTick(deltaTime: number, data: IMeshData): void
- onUpdate(data: IMeshData, preData: IMeshData): void
- onRemove(parent: Element, data: IMeshData): void
- onRelease(data: IMeshData): void
- /**
- * @internal
- */
- protected _getMarcos(geometry: Geometry): {}
- /**
- * @internal
- */
- protected _getUniformDesc(): Kanata.UniformDescriptor
- /**
- * @internal
- */
- protected _getMeshType(): Kanata.EMeshRenderType
- }
- }
- declare module 'XrFrame/components/text/Text' {
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- import { Kanata } from 'XrFrame/ext'
- import Material from 'XrFrame/assets/Material'
- import Transform from 'XrFrame/components/Transform'
- import {
- IRenderData,
- EHorzAlignment,
- EVertAlignment
- } from 'XrFrame/components/text/types'
- import { IGlyph } from 'XrFrame/glyph'
- import { Typesetting } from 'XrFrame/components/text/typesetting'
- import { FillRenderData } from 'XrFrame/components/text/fillRenderData'
- /**
- * `Text`数据接口。
- */
- export interface ITextData {
- /**
- * 文本内容
- * `xml`中的数据类型为`string`
- */
- value?: string
- /**
- * 文本大小
- * `xml`中的数据类型为`number`
- */
- size?: number
- /**
- * 文本颜色
- * `xml`中的数据类型为`number-array`,默认为`0 0 0 1`。
- */
- color?: number[]
- /**
- * 文本轴点
- * `xml`中的数据类型为`number-array`,默认为`0 1`。
- */
- anchor?: number[]
- /**
- * 文本框宽度
- * `xml`中的数据类型为`number`
- */
- width?: number
- /**
- * 文本框高度
- * `xml`中的数据类型为`number`
- */
- height?: number
- /**
- * 文本框行高,为比例
- * `xml`中的数据类型为`number`
- */
- lineHeight?: number
- /**
- * 文本内边距
- * `xml`中的数据类型为`number-array`,默认为`0 0 0`。
- */
- padding?: number[]
- /**
- * 文本水平定位
- * `xml`中的数据类型为`string`,默认为`left`。
- */
- horzAlign?: string
- /**
- * 文本垂直定位
- * `xml`中的数据类型为`string`,默认为`top`。
- */
- vertAlign?: string
- /**
- * 是否不参与剔除,默认false(即参与剔除)。
- */
- neverCull?: boolean
- /**
- * 覆盖`material`中的默认`uniforms`,如果覆盖了,则会先创建一个材质副本。
- * `xml`中同{@link IMaterialData.uniforms}。
- */
- uniforms?: Array<[string, string]>
- /**
- * 覆盖`material`中的默认`states`,如果覆盖了,则会先创建一个材质副本。
- * `xml`中同{@link IMaterialData.states}。
- */
- states?: Array<[string, string]>
- }
- export const TextSchema: IComponentSchema
- export const textAttributes: Array<{
- name: string
- format: number
- offset: number
- usage: number
- }>
- export const textStride = 32
- export const textVertexSize = 8
- export default class Text extends Component<ITextData> {
- readonly schema: IComponentSchema
- readonly priority: number
- protected _cull: Kanata.CullingComponent
- protected _mesh: Kanata.MeshRendererComponent
- protected _sourceMaterial: Material
- protected _material: Material
- protected _trs: Transform
- protected _value: string
- protected _size: number
- protected _color: number[]
- protected _anchor: number[]
- protected _width: number | undefined
- protected _height: number | undefined
- protected _lineHeight: number
- protected _padding: number[]
- protected _horzAlign: EHorzAlignment
- protected _vertAlign: EVertAlignment
- protected _glyphs: IGlyph[]
- protected _renderDatas: IRenderData[]
- static QueryGlyphs: (
- scene: import('XrFrame/core/Scene').default,
- characters: string,
- italic: boolean,
- bold: boolean,
- fontSize: number,
- fontFamily: string
- ) => IGlyph[]
- static Typesetting: typeof Typesetting
- static FillRenderData: typeof FillRenderData
- get id(): number
- onAdd(parent: Element, data: ITextData): void
- onTick(deltaTime: number, data: ITextData): void
- onUpdate(data: ITextData, preData: ITextData): void
- onRemove(parent: Element, data: ITextData): void
- onRelease(data: ITextData): void
- protected _getUniformDesc(): Kanata.UniformDescriptor
- protected _getMeshType(): Kanata.EMeshRenderType
- protected _getVertexLayout(): Kanata.VertexLayout
- }
- }
- declare module 'XrFrame/components/particle/Particle' {
- import Element from 'XrFrame/core/Element'
- import Material from 'XrFrame/assets/Material'
- import BasicParticle, {
- IParticleData
- } from 'XrFrame/components/particle/BasicParticle'
- import ParticleInstance from 'XrFrame/components/particle/ParticleInstance'
- import { BasicShapeEmitter } from 'XrFrame/components/emitter/BasicShapeEmitter'
- export default class Particle extends BasicParticle {
- static EVENTS: string[]
- readonly priority: number
- subEmitters: any
- get material(): Material
- set material(value: Material)
- get id(): number
- get data(): IParticleData
- set data(value: IParticleData)
- get particleEmitter(): BasicShapeEmitter
- /**
- * 粒子系统开始播放。
- *
- * @param delay 设定粒子延时几秒后再播放。
- */
- start(delay?: number): void
- /**
- * 停止粒子系统与其子发射器的播放。
- */
- stop(): void
- /**
- * @internal
- */
- onAdd(parent: Element, data: IParticleData): void
- /**
- * 设置粒子系统的内置粒子effect。
- */
- protected createMaterial(): Material
- /**
- * 初始化粒子系统的状态。
- */
- initParticle(data: IParticleData): void
- /**
- * 重置粒子系统的状态。
- */
- resetParticle(): void
- /**
- * @internal
- */
- protected _prepareSubEmitterArray(): void
- /**
- * 停止所有粒子子系统的发射状态。
- */
- protected stopSubEmitters(): void
- /**
- * 粒子子发射系统从依附的粒子系统中剥离。
- */
- protected removeFromRoot(): void
- /**
- * @internal
- */
- onTick(deltaTime: number, data: IParticleData): void
- /**
- * @internal
- */
- onUpdate(data: IParticleData, preData: IParticleData): void
- /**
- * @internal
- */
- onRemove(parent: Element, data: IParticleData): void
- /**
- * @internal
- */
- onRelease(data: IParticleData): void
- /**
- * @internal
- */
- protected _updateRenderData(
- deltaTime: number,
- isPreWarm?: boolean
- ): void
- /**
- * 创建一个粒子实例。
- */
- protected createParticle(): ParticleInstance
- /**
- * 启动处于END状态的粒子子发射器。
- * @param {ParticleInstance} instance 粒子实例
- */
- protected particleSubEmitter(instance: ParticleInstance): void
- /**
- * 回收当前粒子实例,并放入储备粒子队列。
- * @param {ParticleInstance} particle 粒子实例
- */
- protected recycleParticle(particle: ParticleInstance): void
- /**
- * 更新每一个粒子的状态。
- * @param {number} instancesSum 新生成的粒子数
- */
- protected update(instancesSum: number): void
- /**
- * 初始化粒子实例。
- * @param {ParticleInstance} instance 需要初始化的粒子实例
- */
- protected initInstanceProperty(instance: ParticleInstance): void
- /**
- * 更新运动过程中粒子实例的各项属性以及子发射器状态。
- * @param {Array} instances 粒子实例数组
- */
- protected updateInstanceProperty(instances: any): void
- /**
- * 更新粒子实例的各项属性。
- * @param {ParticleInstance} instance 待更新的粒子实例
- */
- protected processInstance(instance: ParticleInstance): void
- }
- }
- declare module 'XrFrame/components/particle/BasicParticle' {
- import Material from 'XrFrame/assets/Material'
- import Component from 'XrFrame/core/Component'
- import { IComponentSchema } from 'XrFrame/core/Component'
- import {
- BoxShapeEmitter,
- PointShapeEmitter,
- SphereShapeEmitter
- } from 'XrFrame/components/emitter'
- import { Kanata } from 'XrFrame/ext'
- import Transform from 'XrFrame/components/Transform'
- import { BasicShapeEmitter } from 'XrFrame/components/emitter/BasicShapeEmitter'
- import Vector3 from 'XrFrame/math/vector3'
- import Particle from 'XrFrame/components/particle/Particle'
- import { Scene } from 'XrFrame/elements'
- import { SubEmitter } from 'XrFrame/components/emitter/SubEmitter'
- import ParticleInstance from 'XrFrame/components/particle/ParticleInstance'
- import Atlas from 'XrFrame/assets/Atlas'
- import Vector4 from 'XrFrame/math/vector4'
- import Geometry from 'XrFrame/assets/Geometry'
- /**
- * {@link Particle}组件数据接口。
- */
- export interface IParticleData {
- neverCull?: boolean
- /**
- * 渲染模式。
- */
- renderMode?: string
- uniforms?: Array<[string, string]>
- states?: Array<[string, string]>
- /**
- * 纹理信息。
- */
- texture?: Kanata.Texture
- /**
- * 最大粒子数目。
- */
- capacity?: number
- /**
- * 每秒粒子发射数。
- */
- emitRate?: number
- /**
- * 初始角度。
- */
- angle?: number[]
- /**
- * 粒子系统启动延时秒数。
- */
- delay?: number
- /**
- * y轴方向上的每秒位移。
- */
- gravity?: number
- /**
- * 初始大小。
- */
- size?: number[]
- /**
- * 粒子在x轴方向上的大小尺度。
- */
- scaleX?: number[]
- /**
- * 粒子在y轴方向上的大小尺度。
- */
- scaleY?: number[]
- /**
- * 速度。
- */
- speed?: number[]
- /**
- * 生命周期时长。
- */
- lifeTime?: number[]
- /**
- * 粒子初始颜色左区间。
- */
- startColor?: number[]
- /**
- * 粒子初始颜色右区间。
- */
- startColor2?: number[]
- /**
- * 粒子结束时颜色。
- */
- endColor?: number[]
- /**
- * 角速度。
- */
- angularSpeed?: number[]
- /**
- * 发射器类型。
- */
- emitterType?: string
- /**
- * 发射器属性配置。
- */
- emitterProps?: Array<[string, string]>
- /**
- * 粒子系统生命周期时长。
- */
- stopDuration?: number
- /**
- * 粒子预渲染周期数。
- */
- prewarmCycles?: number
- /**
- * 速度阻尼系数。
- */
- speedDampen?: number
- /**
- * 动画图集信息。
- */
- atlas?: Atlas
- /**
- * 图集切换速度。
- */
- atlasSpeed?: number
- /**
- * 是否随机播放图集。
- */
- atlasRandom?: boolean
- /**
- * 是否循环播放图集。
- */
- atlasLoop?: boolean
- /**
- * 指定图集帧名。
- */
- atlasFrames?: string[]
- /**
- * 网格信息。
- */
- mesh?: Geometry
- sizeChange?: Array<[string, string]>
- colorChange?: Array<[string, string]>
- speedChange?: Array<[string, string]>
- burstCount?: number
- burstTime?: number
- burstCycle?: number
- burstInterval?: number
- }
- /**
- * {@link Particle}的`schema`定义。
- * @see 解析后的接口详见 {@link IParticleData}
- */
- export const ParticleSchema: IComponentSchema
- /**
- * BillBoard渲染模式。
- */
- export const enum BillBoardMode {
- BILLBOARDMODE_DEFAULT = 0,
- BILLBOARDMODE_Y = 1,
- BILLBOARDMODE_STRETCHED = 2
- }
- export default class BasicParticle extends Component<IParticleData> {
- /**
- * 详见{@link ParticleSchema}。
- */
- readonly schema: IComponentSchema
- protected static count: number
- protected _systemId: number
- protected _data: IParticleData
- protected particleScene: Scene
- protected particleEl: any
- protected _instances: ParticleInstance[]
- protected _stockInstances: ParticleInstance[]
- protected _capacity: number
- protected _delay: number
- protected _updateSpeed: number
- protected _stopDuration: number
- protected _emitRate: number
- protected _gravity: number
- protected _preWarmCycles: number
- protected _preWarmStepOffset: number
- protected _particleEmitterType: string
- protected _particleEmitter: BasicShapeEmitter
- protected _particleEmitterProperties: any
- protected particleStride: number
- protected particleVertexSize: number
- protected byteStride: number
- protected ParticleAttributes: any
- protected _burstCount: number
- protected _burstTime: number
- protected _burstCycle: number
- protected _burstInterval: number
- protected _burstCountTime: number
- protected _burstCountCycle: number
- protected _burstCountInterval: number
- protected _minLifeTime: number
- protected _maxLifeTime: number
- protected _minScaleX: number
- protected _maxScaleX: number
- protected _minScaleY: number
- protected _maxScaleY: number
- protected _minSize: number
- protected _maxSize: number
- protected _minSpeed: number
- protected _maxSpeed: number
- protected _particleLengthScale: number
- protected _startColor: number[]
- protected _startColor2: number[]
- protected _endColor: number[]
- protected _sizeGradients: any
- protected _alphaGradients: any
- protected _colorRemapGradients: any
- protected _speedScaleGradients: any
- protected _limitSpeedGradients: any
- protected _speedDampenFactor: number
- protected _dragGradients: any
- protected _useSpriteSheet: boolean
- protected _startSpriteCellIndex: number
- protected _endSpriteCellIndex: number
- protected _useRandomSpriteCellIndex: boolean
- protected _useSpriteCellLoop: boolean
- protected _spriteChangeSpeed: number
- protected _spriteFrameInfo: Vector4[]
- protected _spriteNameToCellIndex: Map<string, number>
- protected _textureData: Kanata.Texture
- protected _atlasObj: Atlas
- protected _atlasTexture: Kanata.Texture
- protected _cull: Kanata.CullingComponent
- protected _mesh: Kanata.MeshRendererComponent
- protected _sourceMaterial: Material
- protected _material: Material
- protected _trs: Transform
- protected _vertexBuffer: Kanata.VertexBuffer
- protected _indexBuffer: Kanata.IndexBuffer
- protected _renderMesh: Geometry
- protected _vertexCount: number
- protected _vertexData: Float32Array
- protected _eachIndexSize: number
- protected _indexSize: number
- protected _vertexSize: number
- protected _useBillboard: boolean
- protected _useRenderMesh: boolean
- protected _billboardMode: number
- protected _useRampGradients: boolean
- protected _rampGradients: any
- protected _rampGradientsTexture: Kanata.Texture
- protected _colorGradients: any
- protected _vertexLayoutDirty: boolean
- protected _startAngle: number
- protected _startAngle2: number
- protected _minAngularSpeed: number
- protected _maxAngularSpeed: number
- protected _subEmitters: any[]
- protected _emitterPosition: Vector3
- get material(): Material
- /**
- * @internal
- */
- get useBillboard(): boolean
- set useBillboard(value: boolean)
- get useRampGradients(): boolean
- set useRampGradients(value: boolean)
- get billboardMode(): number
- set billboardMode(value: number)
- get useSpriteSheet(): boolean
- set useSpriteSheet(value: boolean)
- get useRandomSpriteCellIndex(): boolean
- get useSpriteCellLoop(): boolean
- get spriteChangeSpeed(): number
- get emitterPosition(): Vector3
- set emitterPosition(value: Vector3)
- /**
- * @internal
- */
- protected _parseAttribute(): void
- /**
- * 获取一个拷贝的粒子系统。
- */
- clone(): Particle
- /**
- * 获取一个粒子子发射器。
- */
- createSubEmitter(data: IParticleData): SubEmitter
- /**
- * 创建一个点发射器。
- * @param {Vector3} direction1 粒子运动方向左区间
- * @param {Vector3} direction2 粒子运动方向右区间
- * @return {PointShapeEmitter} 点发射器
- */
- createPointEmitter(
- direction1: Vector3,
- direction2: Vector3
- ): PointShapeEmitter
- /**
- * 创建一个箱形发射器。
- * @param {Vector3} direction1 粒子运动方向左区间
- * @param {Vector3} direction2 粒子运动方向右区间
- * @param {Vector3} minEmitBox 粒子生成位置最小允许坐标
- * @param {Vector3} maxEmitBox 粒子生成位置最大允许坐标
- * @return {BoxShapeEmitter} 箱形发射器
- */
- createBoxEmitter(
- direction1: Vector3,
- direction2: Vector3,
- minEmitBox: Vector3,
- maxEmitBox: Vector3
- ): BoxShapeEmitter
- /**
- * 创建一个球形发射器。
- * @param {number} radius 球形半径
- * @param {number} radiusRange 球形区域内的覆盖范围[0-1]
- * @param {number} arc 粒子在球形内生成的角度区间[0-360]
- * @param {number} randomizeDirection 粒子运动方向偏离程度[0-1]
- * @return {SphereShapeEmitter} 球形发射器
- */
- createSphereEmitter(
- radius: number,
- radiusRange: number,
- arc: number,
- randomizeDirection: number
- ): SphereShapeEmitter
- protected _parseProperties(data: IParticleData): void
- protected _chooseEmitterProcess(): void
- protected _createVertexBuffers(): void
- protected _createIndexBuffer(): void
- protected _appendParticleVertices(
- offset: any,
- instance?: ParticleInstance
- ): void
- protected _appendParticleVertex(
- index: any,
- instance: ParticleInstance,
- offsetX: any,
- offsetY: any,
- offsetZ: any,
- u: any,
- v: any
- ): void
- protected _rebuildMesh(neverCull: boolean): void
- protected _getUniformDesc(): Kanata.UniformDescriptor
- protected _getMeshType(): Kanata.EMeshRenderType
- protected _getVertexLayout(
- attributes: any,
- stride: any
- ): Kanata.VertexLayout
- protected _setMeshData(
- material: Material,
- uniforms?: Array<[string, string]>,
- states?: Array<[string, string]>
- ): void
- /**
- * 添加粒子运动过程中的颜色变化规则。
- * @param {number} gradient 指定所处粒子生命周期的阶段
- * @param {Vector4} color1 指定粒子颜色的左区间
- * @param {Vector4} color2 指定粒子颜色的右区间
- */
- addColorGradient(
- gradient: number,
- color1: Vector4,
- color2?: Vector4
- ): void
- /**
- * 添加粒子运动过程中的速度变化规则。
- * @param {number} gradient 指定所处粒子生命周期的阶段
- * @param {Vector4} speed 指定粒子速度的左区间
- * @param {Vector4} speed2 指定粒子速度的右区间
- */
- addSpeedScaleGradient(
- gradient: number,
- speed: number,
- speed2?: number
- ): void
- /**
- * 添加粒子运动过程中的速度限制规则。
- * @param {number} gradient 指定所处粒子生命周期的阶段
- * @param {number} limitSpeed 指定粒子限制速度的左区间
- * @param {number} limitSpeed2 指定粒子限制速度的右区间
- */
- addLimitSpeedGradient(
- gradient: number,
- limitSpeed: number,
- limitSpeed2?: number
- ): void
- /**
- * 添加粒子运动过程中的阻力规则。
- * @param {number} gradient 指定所处粒子生命周期的阶段
- * @param {number} speed 指定粒子受到的阻力大小的左区间[0-1]
- * @param {number} speed2 指定粒子受到的阻力大小的右区间[0-1]
- */
- addDragGradient(gradient: number, drag: number, drag2?: number): void
- /**
- * 添加粒子运动过程中的透明度变化规则。
- * @param {number} gradient 指定所处粒子生命周期的阶段
- * @param {number} alpha 指定粒子颜色透明度的左区间[0-1]
- * @param {number} alpha2 指定粒子颜色透明度的右区间[0-1]
- */
- addAlphaGradient(gradient: number, alpha: number, alpha2?: number): void
- /**
- * 添加粒子运动过程中的尺寸变化规则。
- * @param {number} gradient 指定所处粒子生命周期的阶段
- * @param {number} size 指定粒子尺寸的左区间
- * @param {number} size2 指定粒子尺寸的右区间
- */
- addSizeGradient(gradient: number, size: number, size2?: number): void
- /**
- * 添加粒子运动过程中的透明度变化范围。
- * @param {number} gradient 指定所处粒子生命周期的阶段
- * @param {number} min 指定粒子透明度值的左区间
- * @param {number} max 指定粒子透明度值的右区间
- */
- addColorRemapGradient(gradient: number, min: number, max?: number): void
- /**
- * 将存储不同时间段相关属性系数的数组按时间点从小到大进行排序。
- * @param {Array} factorGradients 存储不同时间段相关属性系数的数组
- * @param {number} gradient 一般代表粒子所处生命周期的阶段
- * @param {number} factor 左区间值
- * @param {number} factor2 右区间值
- */
- protected addFactorGradient(
- factorGradients: any,
- gradient: any,
- factor: any,
- factor2: any
- ): void
- /**
- * 添加粒子运动过程中的根据透明度影响的颜色变化规则,将通过颜色变化图纹理进行采样。
- * @param {number} gradient 指定粒子颜色变化图的具体位置,对应具体值应为(1-alpha)
- * @param {number} color 指定该位置的颜色
- */
- addRampGradient(gradient: any, color: any): void
- /**
- * 根据颜色变化数组,生成对应的颜色变化纹理
- */
- protected createRampGradientTexture(): void
- /**
- * @internal
- */
- protected lerpNumberArrayToVector(
- vector: any,
- numberArray1: any,
- numberArray2: any,
- step: any,
- length?: number
- ): void
- }
- }
- declare module 'XrFrame/components/AssetRenderTexture' {
- /**
- * AssetRenderTexture.ts
- *
- * * @Date : 8/29/2022, 11:27:00 AM
- */
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- /**
- * `AssetRenderTexture`资源数据接口。
- */
- export interface IAssetRenderTextureData {
- assetId?: string
- width: number
- height: number
- isHDR?: boolean
- }
- /**
- * {@link AssetRenderTexture}的`schema`,详见{@link IAssetRenderTextureData}。
- */
- export const AssetRenderTextureSchema: IComponentSchema
- /**
- * 渲染纹理创建组件,用于在`xml`中创建{@link RenderTexture}资源,一般被代理到{@link XRAssetRenderTexture}元素。
- */
- export default class AssetRenderTexture extends Component<IAssetRenderTextureData> {
- /**
- * 详见{@link AssetRenderTextureSchema}。
- */
- readonly schema: IComponentSchema
- readonly isAssetRenderTexture: boolean
- onAdd(parent: Element, data: IAssetRenderTextureData): void
- /**
- * 移除AssetRenderTexture。
- */
- onRemove(parent: Element, data: IAssetRenderTextureData): void
- }
- }
- declare module 'XrFrame/components/Env' {
- /**
- * Env.ts
- *
- * * @Date : 5/11/2022, 5:21:48 PM
- */
- import { Kanata } from 'XrFrame/ext'
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import EnvData from 'XrFrame/assets/EnvData'
- import Element from 'XrFrame/core/Element'
- import { ITextureWrapper } from 'XrFrame/core/DataValue'
- /**
- * {@link Env}组件数据接口。
- */
- export interface IEnvData {
- /**
- * 要使用的环境数据资源。
- * `xml`中的数据类型为`env-data`资源。
- */
- envData?: EnvData
- /**
- * 可以用于覆盖`envData`中的`skybox`。
- * `xml`中的数据类型为`texture`资源。
- */
- skyMap?: Kanata.Texture | ITextureWrapper
- /**
- * 是否用2D模式渲染天空盒,此时必须为`skyMap`必须**不**为`CubeTexture`。
- */
- isSky2D?: boolean
- /**
- * 环境旋转角度。
- * `xml`中的数据类型为`number`,默认为`0`。
- */
- rotation: number
- /**
- * 漫反射部分曝光。
- * `xml`中的数据类型为`number`,默认为`1`。
- */
- diffuseExp: number
- /**
- * 镜面反射部分曝光。
- * `xml`中的数据类型为`number`,默认为`1`。
- */
- specularExp: number
- }
- /**
- * {@link Env}的`schema`,详见{@link IEnvData}。
- */
- export const EnvSchema: IComponentSchema
- /**
- * 一般被代理到{@link XRARTracker}元素。
- */
- export default class Env extends Component<IEnvData> {
- /**
- * 详见{@link EnvSchema}。
- */
- readonly schema: IComponentSchema
- get useHalfSkyMap(): boolean
- get skyMap(): import('XrFrame/kanata/lib/index').Texture
- get isSky2D(): boolean
- get isSkyRT(): boolean
- get rotation(): number
- get hasDiffuse(): boolean
- get diffuseSH(): Float32Array
- get diffuseExp(): number
- get hasSpecular(): boolean
- get specularRGBD(): boolean
- get specularMipmaps(): boolean
- get specularMipmapCount(): number
- get specularMap(): import('XrFrame/kanata/lib/index').Texture
- get specularExp(): number
- onAdd(parent: Element, data: IEnvData): void
- onUpdate(data: IEnvData, preData: IEnvData): void
- onRemove(parent: Element, data: IEnvData): void
- }
- }
- declare module 'XrFrame/components/Animator' {
- /**
- * Animator.ts
- *
- * * @Date : 6/17/2022, 2:52:44 PM
- */
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Animation from 'XrFrame/animation/Animation'
- import Element from 'XrFrame/core/Element'
- type Scene = import('XrFrame/core/Scene').default
- /**
- * 使用`Animator`播放动画时可以传入的默认选项。
- */
- export interface IAnimationPlayOptions {
- /**
- * 播放速度,默认为`1`。
- */
- speed?: number
- /**
- * 循环次数,默认为`0`。
- */
- loop?: number
- /**
- * 播放延迟,默认为`0`。
- */
- delay?: number
- /**
- * 播放方向,默认为`forwards`。
- */
- direction?: 'forwards' | 'backwards' | 'both'
- }
- export enum EAnimationPlayState {
- Playing = 0,
- Paused = 1,
- Stopt = 2
- }
- /**
- * 自动播放配置。
- */
- export interface IAnimatorAutoPlay {
- /**
- * 片段名称。
- */
- clip?: string
- /**
- * 速度。
- */
- speed?: string
- /**
- * 循环次数。
- */
- loop?: string
- /**
- * 延迟。
- */
- delay?: string
- /**
- * 方向。
- */
- direction?: 'forwards' | 'backwards' | 'both'
- /**
- * 其他追加配置。
- */
- [key: string]: string | undefined
- }
- /**
- * {@link Animator}组件数据接口。
- */
- export interface IAnimatorData {
- /**
- * 默认的`Keyframe`动画资源。
- * `xml`中为资源id。
- */
- keyframe: Animation
- /**
- * 默认的片段名字映射,由于一个动画可以有多个片段,所以能通过映射由`Animator`中播放的名字 -> 动画资源中片段的名字。
- * `xml`中为`dict`数据。
- */
- clipMap?: {
- [key: string]: string
- }
- /**
- * 默认自动播放的参数,详见{@Link IAnimatorAutoPlay}。
- * `xml`中为`dict`数据。
- */
- autoPlay?: IAnimatorAutoPlay
- }
- /**
- * {@link Animator}的`schema`定义。
- * @see 解析后的接口详见 {@link IAnimatorData}
- */
- export const AnimatorSchema: {
- keyframe: {
- type: string
- }
- clipMap: {
- type: string
- }
- autoPlay: {
- type: string
- }
- }
- export default class Animator extends Component<IAnimatorData> {
- static EVENTS: string[]
- /**
- * 详见{@link AnimatorSchema}。
- */
- readonly schema: IComponentSchema
- readonly priority: number
- onAdd(parent: Element, data: IAnimatorData): void
- onUpdate(data: IAnimatorData, preData: IAnimatorData): void
- onRemove(parent: Element, data: IAnimatorData): void
- onRelease(data: IAnimatorData): void
- /**
- * 手动添加一个动画。
- *
- * @param clipMap 可选的动画片段名字映射。
- */
- addAnimation<T extends Animation>(
- anim: T,
- clipMap?: {
- [name: string]: string
- }
- ): T
- /**
- * 直接通过类`clz`和初始化数据`data`创建一个动画并添加到自身内。
- */
- createAnimation<T extends Animation>(
- clz: new (scene: Scene, data: T['__DATA_TYPE']) => T,
- data: T['__DATA_TYPE'],
- clipMap?: {
- [name: string]: string
- }
- ): T
- /**
- * 移除一个动画
- */
- removeAnimation(anim: Animation): void
- /**
- * @internal
- */
- /**
- * 播放一个动画片段,**可以同时播放多个片段**。
- *
- * @param name 动画片段名称。
- * @param options 播放选项。
- */
- play(
- name: string,
- options?: IAnimationPlayOptions & {
- [key: string]: any
- }
- ): void
- /**
- * 播放动画片段到某一进度并停下。
- *
- * @param name 片段名称。
- * @param progress 停到的某个进度,0~1。
- */
- pauseToFrame(name: string, progress: number): void
- /**
- * 暂停播放。
- *
- * @param name 需要暂停的片段,如果不填则暂停所有正在播放的片段。
- */
- pause(name?: string): void
- /**
- * 唤醒暂停的动画。
- *
- * @param name 需要唤醒的片段,如果不填则唤醒所有暂停的片段。
- */
- resume(name?: string): void
- /**
- * 停止播放。
- *
- * @param name 需要停止的片段,如果不填则停止所有正在播放的片段。
- */
- stop(name?: string): void
- }
- export {}
- }
- declare module 'XrFrame/components/CameraOrbitControl' {
- /**
- * CameraOrbitControl.ts
- *
- * * @Date : 5/19/2022, 1:22:59 PM
- */
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- import Vector3 from 'XrFrame/math/vector3'
- /**
- * {@link CameraOrbitControl}组件数据接口。
- */
- export interface ICameraOrbitControlData {
- /**
- * 是否锁定横向旋转。
- */
- isLockX: boolean
- /**
- * 是否锁定纵向旋转。
- */
- isLockY: boolean
- /**
- * 是否锁定缩放。
- */
- isLockZoom: boolean
- /**
- * 是否锁定旋转。
- */
- isLockRotate: boolean
- /**
- * 是否锁定移动。
- */
- isLockMove: boolean
- /**
- * 允许的最大缩放值。
- */
- zoomMax: number
- /**
- * 允许的最小缩放值。
- */
- zoomMin: number
- /**
- * 平移速度。
- */
- panSpeed: number
- /**
- * 旋转速度。
- */
- rotateSpeed: number
- /**
- * 缩放速度。
- */
- zoomSpeed: number
- /**
- * 开启阻尼缓动。
- */
- enableDamping: boolean
- /**
- * 阻尼系数。
- */
- dampingFactor: number
- }
- /**
- * {@link CameraOrbitControl}的`schema`,详见{@link ICameraOrbitControlData}。
- */
- export const CameraOrbitControlSchema: IComponentSchema
- export default class CameraOrbitControl extends Component<ICameraOrbitControlData> {
- /**
- * 详见{@link CameraOrbitControlSchema}。
- */
- readonly schema: IComponentSchema
- /**
- * 是否锁定横向旋转。
- */
- isLockX: boolean
- /**
- * 是否锁定纵向旋转。
- */
- isLockY: boolean
- /**
- * 是否锁定缩放。
- */
- isLockZoom: boolean
- /**
- * 是否锁定旋转。
- */
- isLockRotate: boolean
- /**
- * 是否锁定移动。
- */
- isLockMove: boolean
- /**
- * 是否已经开启。
- */
- isEnabled: boolean
- /**
- * 允许的最大缩放值。
- */
- zoomMax: number
- /**
- * 允许的最小缩放值。
- */
- zoomMin: number
- /**
- * 允许的最大平移边界。
- */
- panMax: Vector3
- /**
- * 允许的最小平移边界。
- */
- panMin: Vector3
- /**
- * 平移速度。
- */
- panSpeed: number
- /**
- * 旋转速度。
- */
- rotateSpeed: number
- /**
- * 缩放速度。
- */
- zoomSpeed: number
- /**
- * 开启阻尼缓动。
- */
- enableDamping: boolean
- /**
- * 阻尼系数。
- */
- dampingFactor: number
- /**
- * 当前是否正在缓动。
- */
- get damping(): boolean
- /**
- * 获取当前目标。
- */
- get target(): Vector3
- /**
- * 添加到世界,继承请先`super.onAdd()`。
- */
- onAdd(parent: Element, data: ICameraOrbitControlData): void
- /**
- * 每一帧更新,继承请先`super.onUpdate()`。
- */
- onUpdate(data: ICameraOrbitControlData): void
- onTick(deltaTime: number, data: ICameraOrbitControlData): void
- /**
- * 销毁,继承请先`super.onUpdate()`。
- */
- onRemove(): void
- /**
- * 启动控制器。
- */
- enable(): void
- /**
- * 关闭控制器。
- */
- disable(): void
- }
- }
- declare module 'XrFrame/components/ARTracker' {
- /**
- * ARTracker.ts
- *
- * * @Date : 6/24/2022, 11:35:30 AM
- */
- import { Kanata } from 'XrFrame/ext'
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- import Vector3 from 'XrFrame/math/vector3'
- /**
- * {@link ARSystem}和{@link ARTracker}的跟踪模式。
- * 其中`threeDof`需要基础库`2.30.4`以上支持。
- */
- export type TTrackMode =
- | 'Plane'
- | 'Marker'
- | 'OSD'
- | 'Face'
- | 'Hand'
- | 'Body'
- | 'threeDof'
- /**
- * {@link ARTracker}的识别状态。
- * @version v2.29.1
- */
- export enum EARTrackerState {
- Init = 0,
- Detecting = 1,
- Detected = 2,
- Error = 3
- }
- /**
- * `Face`/`Body`/`Hand`模式下,{@link ARTracker}存储的原始数据类型。
- */
- export interface IARTrackerRawData {
- /**
- * 原点,屏幕空间。
- */
- origin: {
- x: number
- y: number
- }
- /**
- * 尺寸,屏幕空间。
- */
- size: {
- width: number
- height: number
- }
- /**
- * 置信度。
- */
- score: number
- /**
- * 在`Hand`模式下,手势分类,正常`0~18`,无效为`-1`。
- */
- gesture?: number
- /**
- * 在`Face`模式下,人脸旋转角度。
- */
- angle?: {
- pitch: number
- roll: number
- yaw: number
- z_score: number
- }
- /**
- * 关键点置信度。
- */
- confidence: number[]
- /**
- * 关键点,屏幕空间。
- */
- points: Array<{
- x: number
- y: number
- }>
- /**
- * 支持3D时,3D关键点,世界空间。
- */
- points3d: Array<{
- x: number
- y: number
- z: number
- }>
- }
- /**
- * {@link ARTracker}组件数据接口。
- */
- export interface IARTrackerData {
- /**
- * 跟踪模式,必须在{@link ARSystem}已开启的模式列表中。
- * `xml`中数据为`string`类型。
- */
- mode: TTrackMode
- /**
- * 要追踪的图片资源,优先使用。
- * `xml`中数据为`image`类型。
- */
- image?: Kanata.IImage
- /**
- * 要追踪的图片地址,如果`image`没有定义,则使用这个。
- * `xml`中数据为`string`类型。
- */
- src?: string
- /**
- * 在`Face`模式下,给定一个**特征点索引**列表,详见官网对应文档。
- * 系统会自动同步位置和缩放到`ARTracker`下对应的顺序的子节点。
- * `-1`代表不同步位置,只同步缩放。
- */
- autoSync?: number[]
- }
- /**
- * {@link ARTracker}的`schema`,详见{@link IARTrackerData}。
- */
- export const ARTrackSchema: {
- mode: {
- type: string
- }
- image: {
- type: string
- }
- src: {
- type: string
- }
- autoSync: {
- type: string
- }
- }
- /**
- * AR追踪组件,配合{@link ARSystem}和{@link Camera}的`isARCamera`属性一起使用。
- * 一般被代理到{@link XRARTracker}元素。
- *
- * 其提供了追踪的能力,节点将会自动同步识别到的追踪目标的位置和旋转,
- */
- export default class ARTracker extends Component<IARTrackerData> {
- static EVENTS: string[]
- /**
- * 详见{@link ARTrackSchema}。
- */
- readonly schema: IComponentSchema
- /**
- * 跟踪模式。
- */
- get mode(): TTrackMode
- /**
- * 当前识别状态。
- *
- * @version v2.29.1
- */
- get state(): EARTrackerState
- /**
- * 如果为错误状态,错误信息。
- *
- * @version v2.29.1
- */
- get errorMessage(): string
- /**
- * 是否已经检测到了目标。
- */
- get arActive(): boolean
- /**
- * `Body`/`Hand`模式下,获取当前的置信度。
- * 一般为`0~1`。
- */
- get score(): number
- /**
- * 在`Hand`模式下,手势分类,正常`0~18`,无效为`-1`。
- */
- get gesture(): number
- /**
- * @internal
- */
- get filePath(): string
- /**
- * @internal
- */
- get trackId(): number
- onAdd(parent: Element, data: IARTrackerData): void
- onUpdate(data: IARTrackerData, preData: IARTrackerData): void
- onRemove(parent: Element, data: IARTrackerData): void
- /**
- * 在`Face`/`Body`/`Hand`模式下,获取某个特征点的位置。
- *
- * @param point 特征点索引,需要在`0~105`,否则返回`undefined`。
- * @param relativeToTracker 仅在`ar-system`的`pose3d`属性为`false`时生效。是否相对于`ARTracker`本身,默认为`true`,否则返回世界空间坐标。
- * @returns 只有在`arActive`时才有值,否则返回`undefined`。
- */
- getPosition(
- point: number,
- output?: Vector3,
- relativeToTracker?: boolean
- ): Vector3
- /**
- * @internal
- */
- /**
- * @internal
- */
- }
- }
- declare module 'XrFrame/components/physics/Shape' {
- import Component from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- import Vector3 from 'XrFrame/math/vector3'
- import { Kanata } from 'XrFrame/ext'
- import type Rigidbody from 'XrFrame/components/physics/Rigidbody'
- import type GLTFComponent from 'XrFrame/components/GLTF'
- import Quaternion from 'XrFrame/math/quaternion'
- import { Delegate } from 'XrFrame/physics/event'
- import { ICollideEvent, IOverlapEvent } from 'XrFrame/physics/Collision'
- import { TQS } from 'XrFrame/assets/GLTFModel'
- export const shapeMap: Map<phys3D.Collider, Shape<any>>
- export enum EShapeType {
- /**
- * @internal
- */
- None = 0,
- /**
- * @see {@link CubeShape}
- */
- Cube = 1,
- /**
- * @internal
- */
- CharacterController = 2,
- /**
- * @see {@link CapsuleShape}
- */
- Capsule = 3,
- /**
- * @see {@link MeshShape}
- */
- Mesh = 4,
- /**
- * @see {@link SphereShape}
- */
- Sphere = 5
- }
- export interface IShapeData {
- /**
- * 轮廓中心相对元素{@link Transform}中心的偏移量。
- * @default [0, 0, 0]
- */
- center?: [number, number, number]
- /**
- * 轮廓是否自动贴合{@link Mesh | Mesh组件}或{@link GLTF | GLTF组件}的大小。
- * 如果当前元素下不存在Mesh组件和GLTF组件则不生效。
- *
- * > {@link MeshShape}永远会开启这项。
- *
- * @default false
- */
- autoFit?: boolean
- /**
- * 是否禁用shape。
- *
- * @default false
- */
- disabled?: boolean
- }
- export const ShapeSchema: {
- center: {
- type: string
- }
- autoFit: {
- type: string
- }
- disabled: {
- type: string
- }
- }
- export enum ShapeImplType {
- None = 0,
- Basic = 1,
- GLTFAbstract = 2
- }
- /**
- * 轮廓组件的基类。
- * 为元素添加*该组件的子类*可以创建一个可用于交互的轮廓。
- *
- * > 💡 只要创建了轮廓,在点击该物体时就可以触发事件:
- * > + touch-shape: 点击物体事件,回调参数为{@link IShapeTouchEvent};
- * > + drag-shape: 拖拽物体事件,回调参数为{@link IShapeDragEvent};
- * > + untouch-shape: 松开物体事件,回调参数为{@link IShapeTouchEvent};
- * >
- * > 绑定事件的方法可参考以下代码:
- * >
- * > ``` <xr-node sphere-shape bind:touch-shape="handleTouchShape"></xr-node> ```
- *
- * > 💡 如果想要将轮廓可视化来确认轮廓大小,可以在同一个元素下添加{@link ShapeGizmos}组件,或在标签上添加`shape-gizmo`属性(对MeshShape不起作用)。
- *
- * @abstract
- */
- export default abstract class Shape<
- T extends IShapeData = any
- > extends Component<IShapeData> {
- static EVENTS: string[]
- readonly priority: number
- implType: ShapeImplType
- protected _type: EShapeType
- protected _onCollisionEnterDelegate?: Delegate<ICollideEvent>
- protected _onCollisionExitDelegate?: Delegate<ICollideEvent>
- protected _onCollisionStayDelegate?: Delegate<ICollideEvent>
- protected _onTriggerEnterDelegate?: Delegate<IOverlapEvent>
- protected _onTriggerExitDelegate?: Delegate<IOverlapEvent>
- protected _onTriggerStayDelegate?: Delegate<IOverlapEvent>
- get type(): EShapeType
- onAdd(parent: Element, data: T): void
- onUpdate(data: T, preData: T): void
- onTick(dateTime: number, data: T): void
- protected abstract getImplClass(
- implType: ShapeImplType
- ): new () => ShapeImpl | null
- onRemove(parent: Element, data: IShapeData): void
- onRelease(data: IShapeData): void
- shadowRoot?: GLTFAbstractShape<T>
- setAsShadow(root: GLTFAbstractShape<T>, transform: TQS): void
- getGLTFRootShape(): Shape<T> | undefined
- getBasicImpl(): BasicShape<T> | undefined
- getShadowShapes(): Array<Shape<T>>
- initDelegates(el: Element): void
- resetListeners(): void
- }
- export interface ShapeImpl {
- el: Element
- onElementAdd?(parent: Element): void
- update(data: IShapeData, preData: IShapeData): void
- onElementRemove(parent: Element): void
- onTick(dateTime: number, data: IShapeData): any
- create?(el: Element, shape: Shape<any>, data: IShapeData): any
- cleanUp(): any
- enable(): any
- disable(): any
- }
- export abstract class BasicShape<T extends IShapeData>
- implements ShapeImpl
- {
- el: Element
- shapeComp: Shape<T>
- nativeComp: phys3D.Collider
- rigidbodyComp?: Rigidbody
- _isShadow: boolean
- _root: GLTFAbstractShape<T>
- _positionInGLTF: Vector3
- _quatInGLTF: Quaternion
- protected afterCreateNativeComp(): void
- protected destroyNativeComp(): void
- onElementAdd(parent: Element): void
- protected abstract autoFit(data: T): void
- protected abstract applyData(data: T): void
- update(data: T, preData: T): void
- onElementRemove(parent: Element): void
- onRelease(data: T): void
- onTick(dateTime: number, data: IShapeData): void
- cleanUp(): void
- /**
- * @internal
- */
- get entity(): Kanata.Entity3D
- enable(): void
- disable(): void
- }
- export abstract class GLTFAbstractShape<T extends IShapeData>
- implements ShapeImpl
- {
- el: Element
- shapeComp: Shape<T>
- protected gltf: GLTFComponent
- shadowShapes: Array<Shape<T>>
- update(data: T, preData: T): void
- onElementRemove(parent: Element): void
- onTick(dateTime: number, data: T): void
- create(el: Element, shape: Shape<T>, data: T): void
- protected abstract getShapeClass(): new () => Shape<T>
- cleanUp(): void
- protected abstract createShadowShape(el: Element, data: T): Shape<T>
- enable(): void
- disable(): void
- }
- }
- declare module 'XrFrame/components/physics/SphereShape' {
- import Shape, {
- BasicShape,
- EShapeType,
- IShapeData,
- ShapeImpl,
- ShapeImplType
- } from 'XrFrame/components/physics/Shape'
- import Vector3 from 'XrFrame/math/vector3'
- import Element from 'XrFrame/core/Element'
- import { IComponentSchema } from 'XrFrame/core/Component'
- /**
- * @see {@link SphereShapes}
- */
- export interface ISphereShapeData extends IShapeData {
- /**
- * 球形轮廓的半径。
- * @default 1
- */
- radius?: number
- }
- export const SphereShapeSchema: IComponentSchema
- /**
- * 为当前元素创建一个可交互的球状轮廓。
- * 可通过在标签上添加`sphere-shape`属性来为元素添加该组件。
- *
- * @see {@link ISphereShapeData}
- */
- export default class SphereShape extends Shape<ISphereShapeData> {
- static EVENTS: string[]
- readonly schema: IComponentSchema
- protected _type: EShapeType
- protected getImplClass(implType: ShapeImplType): new () => ShapeImpl
- }
- export class BasicSphereShape extends BasicShape<ISphereShapeData> {
- nativeComp: phys3D.SphereCollider
- /**
- * 轮廓相对于元素中心点的偏移量。
- */
- get center(): Vector3
- set center(v: Vector3)
- /**
- * 球形轮廓的半径。
- */
- get radius(): number
- set radius(v: number)
- create(el: Element, shape: SphereShape, data: ISphereShapeData): void
- protected autoFit(data: ISphereShapeData): void
- protected applyData(data: ISphereShapeData): void
- }
- }
- declare module 'XrFrame/components/physics/MeshShape' {
- import Shape, {
- IShapeData,
- EShapeType,
- ShapeImplType,
- ShapeImpl,
- BasicShape
- } from 'XrFrame/components/physics/Shape'
- import Element from 'XrFrame/core/Element'
- import { IComponentSchema } from 'XrFrame/core/Component'
- /**
- * @see {@link MeshShape}
- */
- export interface IMeshShapeData extends IShapeData {
- /**
- * 是否使用凸多边形来包围Mesh。
- * *如果元素有`shape-interact`属性,则会强制开启。*
- * @default false
- */
- convex?: boolean
- }
- export const MeshShapeSchema: IComponentSchema
- /**
- * 利用当前元素下的{@link Mesh | Mesh组件}或{@link GLTF | GLTF组件},创建一个完全贴合的轮廓。如果当前元素下不存在Mesh组件或GLTF组件,则不生效。
- * 可通过在标签上添加`mesh-shape`属性来为元素添加该组件。
- *
- * > ⚠️ 如果Mesh或GLTF内部结构非常复杂,创建和维持该组件可能会占用较多的资源。如果发现该组件会导致小程序性能下降,可以考虑改用其他轮廓类型,并开启{@link IShapeData.autoFit | autoFit}属性。
- *
- * > ⚠️ MeshShape使用的Mesh的顶点数量不能超过65535个。如果超过了,推荐使用CubeShape+autoFit来代替。
- *
- * @see {@link IMeshShapeData}
- */
- export default class MeshShape extends Shape<IMeshShapeData> {
- static EVENTS: string[]
- readonly schema: IComponentSchema
- protected _type: EShapeType
- protected getImplClass(implType: ShapeImplType): new () => ShapeImpl
- }
- export class BasicMeshShape extends BasicShape<IMeshShapeData> {
- nativeComp: phys3D.MeshCollider
- create(el: Element, shape: MeshShape, data: IMeshShapeData): void
- onTick(dateTime: number, data: IShapeData): void
- protected autoFit(data: IMeshShapeData): void
- protected applyData(data: IMeshShapeData): void
- }
- }
- declare module 'XrFrame/components/physics/CapsuleShape' {
- import Shape, {
- BasicShape,
- EShapeType,
- IShapeData,
- ShapeImpl,
- ShapeImplType
- } from 'XrFrame/components/physics/Shape'
- import Vector3 from 'XrFrame/math/vector3'
- import Element from 'XrFrame/core/Element'
- import { IComponentSchema } from 'XrFrame/core/Component'
- /**
- * @see {@link CapsuleShape}
- */
- export interface ICapsuleShapeData extends IShapeData {
- /**
- * 胶囊体两端球体的半径。
- * @default 0.5
- */
- radius?: number
- /**
- * 胶囊体的长度。
- * @default 2
- */
- height?: number
- /**
- * 胶囊体的朝向。
- * @default ECapsuleShapeDirection["Y-Axis"]
- */
- direction?: ECapsuleShapeDirection
- }
- export const CapsuleShapeSchema: IComponentSchema
- /**
- * 胶囊体轮廓的朝向。
- *
- * @category Physics
- */
- export enum ECapsuleShapeDirection {
- 'X-Axis' = 0,
- 'Y-Axis' = 1,
- 'Z-Axis' = 2
- }
- /**
- * 为当前元素创建一个可交互的胶囊体轮廓。
- * 可通过在标签上添加`capsule-shape`属性来为元素添加该组件。
- *
- * @see {@link ICapsuleShapeData}
- */
- export default class CapsuleShape extends Shape<ICapsuleShapeData> {
- static EVENTS: string[]
- readonly schema: IComponentSchema
- protected _type: EShapeType
- protected getImplClass(implType: ShapeImplType): new () => ShapeImpl
- }
- export class BasicCapsuleShape extends BasicShape<ICapsuleShapeData> {
- nativeComp: phys3D.CapsuleCollider
- /**
- * 轮廓相对于元素中心点的偏移量。
- */
- get center(): Vector3
- set center(v: Vector3)
- /**
- * 胶囊体两端球体的半径。
- */
- get radius(): number
- set radius(v: number)
- static defaultHeight: number
- /**
- * 胶囊体的长度。
- */
- get height(): number
- set height(v: number)
- /**
- * 胶囊体的朝向。
- */
- get direction(): ECapsuleShapeDirection
- set direction(v: ECapsuleShapeDirection)
- create(el: Element, shape: CapsuleShape, data: ICapsuleShapeData): void
- protected autoFit(data: ICapsuleShapeData): void
- protected applyData(data: ICapsuleShapeData): void
- }
- }
- declare module 'XrFrame/components/physics/CubeShape' {
- import Shape, {
- BasicShape,
- EShapeType,
- IShapeData,
- ShapeImpl,
- ShapeImplType
- } from 'XrFrame/components/physics/Shape'
- import Vector3 from 'XrFrame/math/vector3'
- import Element from 'XrFrame/core/Element'
- import { IComponentSchema } from 'XrFrame/core/Component'
- /**
- * @see {@link CubeShape}
- */
- export interface ICubeShapeData extends IShapeData {
- /**
- * 长方体沿x,y,z轴的长度。
- * @default [1, 1, 1]
- */
- size?: [number, number, number]
- }
- export const CubeShapeSchema: IComponentSchema
- /**
- * 为当前元素创建一个可交互的长方体轮廓。
- * 可通过在标签上添加`cube-shape`属性来为元素添加该组件。
- *
- * @see {@link ICubeShapeData}
- */
- export default class CubeShape extends Shape<ICubeShapeData> {
- static EVENTS: string[]
- readonly schema: IComponentSchema
- protected _type: EShapeType
- protected getImplClass(implType: ShapeImplType): new () => ShapeImpl
- }
- export class BasicCubeShape extends BasicShape<ICubeShapeData> {
- nativeComp: phys3D.BoxCollider
- /**
- * 轮廓相对于元素中心点的偏移量。
- */
- get center(): Vector3
- set center(v: Vector3)
- /**
- * 长方体沿x,y,z轴的长度。
- */
- get size(): Vector3
- set size(v: Vector3)
- create(el: Element, shape: CubeShape, data: ICubeShapeData): void
- protected autoFit(data: ICubeShapeData): void
- protected applyData(data: ICubeShapeData): void
- }
- }
- declare module 'XrFrame/components/physics/Rigidbody' {
- import Vector3 from 'XrFrame/math/vector3'
- import Quaternion from 'XrFrame/math/quaternion'
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import {
- CollisionDetectionMode,
- ForceMode
- } from 'XrFrame/components/physics/types'
- import Element from 'XrFrame/core/Element'
- export interface IRigidbodyData {
- /**
- * 是否禁用刚体。
- * @default false
- */
- disabled?: boolean
- /**
- * 物体的质量。
- * @limit mass > 0
- * @default 1
- */
- mass?: number
- /**
- * 刚体是否受重力影响。
- * @default true
- */
- useGravity?: boolean
- /**
- * 限制刚体在某个轴上的位移和旋转。
- * 具体值参考{@link RigidbodyConstraints}
- */
- constraintsMask?: number
- /**
- * 是否为*运动学(Kinematic)* 刚体。
- * 设置为*运动学*刚体后,除非手动调用{@link movePosition},否则物体不会在*物理模拟*阶段发生位移或旋转。可以理解为,刚体的行为完全在用户的控制之下。
- * @default false
- */
- kinematic?: boolean
- }
- export const RigidbodySchema: {
- mass: {
- type: string
- }
- useGravity: {
- type: string
- }
- constraintsMask: {
- type: string
- }
- disabled: {
- type: string
- }
- kinematic: {
- type: string
- }
- }
- /**
- * 刚体组件。
- *
- * 让物体在物理系统中成为一个有质量的刚体。只有添加了这个组件之后,物体才有可能在物理系统的*物理模拟*阶段发生位移和旋转。
- * @category Physics
- */
- export default class Rigidbody extends Component<IRigidbodyData> {
- readonly schema: IComponentSchema
- readonly priority: number
- /**
- * 刚体的质量。
- * @limit mass > 0
- * @default 1
- */
- get mass(): number
- set mass(v: number)
- /**
- * 线性阻尼。
- * 影响物体的{@link velocity | 线性速度}。
- * @limit linearDamping >= 0
- * @default 0
- */
- get linearDamping(): number
- set linearDamping(v: number)
- /**
- * 角速度阻尼。
- * 影响物体的{@link angularVelocity | 角速度}。
- * @limit angularDamping >= 0
- * @default 0.05
- */
- get angularDamping(): number
- set angularDamping(v: number)
- /**
- * 刚体是否受重力影响。
- * @default true
- */
- get useGravity(): boolean
- set useGravity(v: boolean)
- /**
- * 是否为*运动学(Kinematic)* 刚体。
- * 设置为*运动学*刚体后,除非手动调用{@link movePosition},否则物体不会在*物理模拟*阶段发生位移或旋转。可以理解为,刚体的行为完全在用户的控制之下。
- * @default false
- */
- get isKinematic(): boolean
- set isKinematic(v: boolean)
- /**
- * @unimplemented
- * @default true
- */
- get detectCollisions(): boolean
- set detectCollisions(v: boolean)
- /**
- * 设置刚体的碰撞检测模式。
- * 详见{@link CollisionDetectionMode}。
- * @default {@link CollisionDetectionMode.Discrete}
- */
- get collisionDetectionMode(): CollisionDetectionMode
- set collisionDetectionMode(v: CollisionDetectionMode)
- /**
- * 限制物体的旋转(X轴,Y轴,Z轴)。
- * @default [false, false, false]
- */
- get rotationConstraints(): boolean[]
- set rotationConstraints(v: boolean[])
- /**
- * 限制物体的位移(X轴,Y轴,Z轴)。
- * @default [false, false, false]
- */
- get positionConstraints(): boolean[]
- set positionConstraints(v: boolean[])
- /**
- * 直接获取或修改刚体在*物理系统*中的位置。
- * 物理系统中的位置是独立于Transform组件的。
- *
- * \**如果你不清楚修改这一项的后果,请不要手动修改它。修改{@link Transform.position}来代替。*
- */
- get position(): Vector3
- set position(v: Vector3)
- /**
- * 直接获取或修改刚体在*物理系统*中的旋转(以四元数表示)。
- * 物理系统中的旋转是独立于节点系统中的Transform的,详见{@link //TODO}。
- *
- * \**如果你不清楚修改这一项的后果,请不要手动修改它。修改{@link Transform3D.euler}或{@link Transform3D.quaternion}来代替。*
- */
- get rotation(): Quaternion
- set rotation(v: Quaternion)
- /**
- * 刚体的角速度。
- */
- get angularVelocity(): Vector3
- set angularVelocity(v: Vector3)
- /**
- * 刚体的质心相对于LocalTransform的偏移量。
- * 如果不手动设置这一项,会自动根据刚体附着的轮廓来计算质心。
- * @see {@link resetCenterOfMass}
- */
- get centerOfMass(): Vector3
- set centerOfMass(v: Vector3)
- /**
- * 是否允许*物理模拟*过程中对刚体进行旋转。
- * @default true
- */
- get freezeRotation(): boolean
- set freezeRotation(v: boolean)
- /**
- * 刚体的转动惯量。
- * 如果不手动设置的话,会自动根据刚体上附着的轮廓计算得出。
- * @see {@link resetInertiaTensor}
- */
- get inertiaTensor(): number
- set inertiaTensor(v: number)
- /**
- * 最大角速度(弧度)。
- * @default 7
- */
- get maxAngularVelocity(): number
- set maxAngularVelocity(v: number)
- /**
- * 最大分离速度。
- * *物理模拟*解决碰撞(相交)的过程中,最大能允许的分离速度。
- * @default Infinity
- */
- get maxDepenetrationVelocity(): number
- set maxDepenetrationVelocity(v: number)
- /**
- * 设置刚体进入休眠的动能阈值。
- * @default 0.005
- */
- get sleepThreshold(): number
- set sleepThreshold(v: number)
- /**
- * 设置*物理模拟*过程中解决碰撞的迭代次数。
- * 更高的迭代次数,会消耗更多性能,产生更自然的物理碰撞效果。
- * 如果发现静息状态的刚体(比如说放在地面上),会发生抖动,可以考虑提高这项数值。
- *
- * @limit solverIterations > 0
- * @default 6
- */
- get solverIterations(): number
- set solverIterations(v: number)
- /**
- * 设置*物理模拟*过程中计算碰撞后速度的迭代次数。
- * 更高的迭代次数,会消耗更多性能,产生更准确的分离速度。
- *
- * @limit solverVelocityIterations > 0
- * @default 1
- */
- get solverVelocityIterations(): number
- set solverVelocityIterations(v: number)
- /**
- * 刚体的线性速度。
- *
- * \**修改这一项会造成速度突变,一般情况下可以使用{@link addForce}来代替。*
- */
- get velocity(): Vector3
- set velocity(v: Vector3)
- /**
- * @internal
- */
- constructor()
- applyData(data: IRigidbodyData): void
- onTick(dateTime: number, data: IRigidbodyData): void
- onAdd(parent: Element, data: IRigidbodyData): void
- onUpdate(data: IRigidbodyData, preData: IRigidbodyData): void
- onRemove(parent: Element, data: IRigidbodyData): void
- onRelease(data: IRigidbodyData): void
- enable(): void
- disable(): void
- /** @internal */
- get nativeComp(): phys3D.DynamicRigidbody
- /**
- * @returns 刚体质心在世界坐标中的位置。
- */
- getWorldCenterOfMass(): Vector3
- /**
- * 为刚体施加力,会影响刚体的{@link velocity | 线性速度}。
- * @param force 世界坐标下矢量形式的力,作用在物体质心上。
- * @param mode 力的类型。
- */
- addForce(force: Vector3, mode: ForceMode): void
- /**
- * 为刚体施加力矩,会影响刚体的{@link angularVelocity | 角速度}。
- * @param torque 世界坐标下矢量形式的力矩。
- * @param mode 力矩的类型。
- */
- addTorque(torque: Vector3, mode: ForceMode): void
- /**
- * @returns 刚体是否处于休眠状态。
- * @see {@link sleep}
- */
- isSleeping(): boolean
- /**
- * 强迫刚体进入休眠状态(至少一帧),休眠状态详见{@link //todo}。
- * \**如果下一帧发生碰撞则会立刻醒来。*
- */
- sleep(): void
- /**
- * 强制唤醒刚体(离开休眠状态)。
- * @see {@link sleep}
- */
- wakeUp(): void
- /**
- * 生成一次模拟爆炸的力。
- * 爆炸范围可以视作一个球状物体,如果球体和刚体产生*相交*,则会在刚体上产生推力。
- * 推力的大小和*相交点*与球心的距离有关,推力的方向从球心指向相交点,推力作用位于*相交点*。
- *
- * 视刚体有无附着的轮廓,分为两种情况:
- * + 无轮廓(或爆炸球心在刚体轮廓内)
- * 相交的判定使用刚体的质心;相交点也取刚体的质心。
- * + 有轮廓
- * 相交的判定使用刚体的所有轮廓;相交点取轮廓距离球心最近的那一点。
- * @param explosionForce 爆炸力的大小。
- * @param explosionPosition 爆炸球体的球心位置。
- * @param explosionRadius 爆炸球体的半径。
- * @param upwardsModifier 使用相对数值来修改推力的*作用位置*的y坐标。
- * @param mode 力的类型。
- * @limit explosionForce > 0
- */
- AddExplosionForce(
- explosionForce: number,
- explosionPosition: Vector3,
- explosionRadius: number,
- upwardsModifier: number,
- mode: ForceMode
- ): void
- /**
- * 为刚体施加力,会影响刚体的{@link velocity | 线性速度}和{@link angularVelocity | 角速度}。
- * @param force 世界坐标下矢量形式的力,作用在position位置上。
- * @param position 力的作用位置。
- * @param mode 力的类型。
- */
- AddForceAtPosition(
- force: Vector3,
- position: Vector3,
- mode: ForceMode
- ): void
- /**
- * 为刚体施加力,会影响刚体的{@link velocity | 线性速度}。
- * @param force **局部**坐标下矢量形式的力,作用在物体质心上。
- * @param mode 力的类型。
- */
- addRelativeForce(force: Vector3, mode: ForceMode): void
- /**
- * 为刚体施加力矩,会影响刚体的{@link angularVelocity | 角速度}。
- * @param torque **局部**坐标下矢量形式的力矩。
- * @param mode 力矩的类型。
- */
- addRelativeTorque(torque: Vector3, mode: ForceMode): void
- /**
- * 测试刚体**表面上**距离某点最近的位置。
- * 如果给予的position在刚体内部,会返回position。
- * 如果刚体无附着的轮廓,会返回[Infinity, Infinity, Infinity]。
- */
- closestPointOnBounds(position: Vector3): Vector3
- /**
- * 获取刚体内某一点在世界坐标下的速度。
- * @param worldPoint 世界坐标下的位置(其实在刚体外也可以)。
- */
- getPointVelocity(worldPoint: Vector3): Vector3
- /**
- * 获取刚体内某一点在**局部**坐标下的速度。
- * @param relativePoint **局部**坐标下的位置(其实在刚体外也可以)。
- */
- getRelativePointVelocity(relativePoint: Vector3): Vector3
- /**
- * 对于***非**运动学刚体*来说,等于直接修改{@link position};
- * 对于*运动学刚体*来说,位置变化会在下一帧生效。可以视作物体在这一帧的*物理模拟*中沿直线路径**移动**到了目的地。
- * @param position 位移的终点
- * @see {@link isKinematic}
- */
- movePosition(position: Vector3): void
- /**
- * @unimplemented 暂未支持,请使用{@link rotation}属性或{@link Transform3D.quaternion}代替。
- */
- moveRotation(rotation: Quaternion): void
- /**
- * 手动触发,根据刚体附着的轮廓重新计算刚体的质心。
- * @see {@link centerOfMass}
- */
- resetCenterOfMass(): void
- /**
- * 手动触发,根据刚体附着的轮廓重新计算刚体的转动惯量。
- * @see {@link inertiaTensor}
- */
- resetInertiaTensor(): void
- /**
- * 根据给定的密度和刚体附着的轮廓,来计算刚体的质量。
- * @see {@link mass}
- */
- setDensity(density: number): void
- }
- }
- declare module 'XrFrame/components/physics/ShapeInteract' {
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- import { CombineMode } from 'XrFrame/components/physics/types'
- export enum EShapeInteractType {
- None = 0,
- Overlap = 1,
- Collide = 2
- }
- export interface IShapeInteractData {
- /**
- * 是否禁用Shape间交互。
- *
- * @default false
- */
- disabled?: boolean
- /**
- * 是否能与其他Shape发生物理碰撞。
- *
- * @default false
- */
- collide?: boolean
- /**
- * 弹性系数,决定碰撞时的能量损失比例。
- *
- * 弹性系数 = 1时,碰撞无能量损失。
- * @limit 0 <= bounciness <= 1
- * @default 0
- */
- bounciness?: number
- /**
- * 静摩擦系数
- * @limit 0 <= staticFriction <= 1
- * @default 0.6
- */
- staticFriction?: number
- /**
- * 动摩擦系数。
- * @limit 0 <= dynamicFriction <= 1
- * @default 0.6
- */
- dynamicFriction?: number
- }
- export const ShapeInteractSchema: {
- disabled: {
- type: string
- }
- collide: {
- type: string
- }
- bounciness: {
- type: string
- }
- staticFriction: {
- type: string
- }
- dynamicFriction: {
- type: string
- }
- }
- /**
- * 拥有ShapeInterace组件的Shape才能与其他Shape发生交互。
- * 将`collide`属性设置为true来与其他Shape进行物理碰撞,仅当两个Shape的collide属性**都为true**时它们才能发生碰撞。
- */
- export default class ShapeInteract extends Component<IShapeInteractData> {
- readonly schema: IComponentSchema
- _disabled: boolean
- _collide: boolean
- get dynamicFriction(): number
- set dynamicFriction(value)
- /**
- * 静摩擦系数
- * @limit 0 <= staticFriction <= 1
- * @default 0.6
- */
- get staticFriction(): number
- set staticFriction(value)
- /**
- * 弹性系数,决定碰撞时的能量损失比例。
- *
- * 弹性系数 = 1时,碰撞无能量损失。
- * @limit 0 <= bounciness <= 1
- * @default 0
- */
- get bounciness(): number
- set bounciness(value)
- /**
- * 如何结合发生碰撞的两个物体的摩擦系数。
- * @default {@link CombineMode.Average}
- */
- get frictionCombine(): CombineMode
- set frictionCombine(v: CombineMode)
- /**
- * 如何结合发生碰撞的两个物体的弹性系数。
- * @default {@link CombineMode.Average}
- */
- get bounceCombine(): CombineMode
- set bounceCombine(v: CombineMode)
- constructor()
- /**
- * @internal
- */
- get material(): phys3D.Material
- onAdd(parent: Element, data: IShapeInteractData): void
- onUpdate(data: IShapeInteractData, preData: IShapeInteractData): void
- getInteractType(): EShapeInteractType
- }
- }
- declare module 'XrFrame/components/gizmo/ShapeGizmos' {
- import Component from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- import CapsuleGizmo from 'XrFrame/components/gizmo/CapsuleGizmo'
- import Shape, { ShapeImplType } from 'XrFrame/components/physics/Shape'
- import CubeGizmo from 'XrFrame/components/gizmo/CubeGizmo'
- /**
- * @see {@link ShapeGizmos}
- */
- export interface IShapeGizmosData {}
- export const ShapeGizmosSchema: {}
- interface GizmoInfo {
- shape: Shape<any>
- gizmoCtor: null | typeof CubeGizmo | typeof CapsuleGizmo
- shadowGizmos: ShapeGizmos[]
- type: ShapeImplType
- version: number
- }
- /**
- * 将当前元素下的所有{@link Shape | 轮廓}都显示出来。
- * 在标签上添加`shape-gizmo`属性来创建该组件。
- *
- * @see {@link IShapeGizmosData}
- */
- export default class ShapeGizmos extends Component<IShapeGizmosData> {
- onAdd(parent: Element, data: IShapeGizmosData): void
- onUpdate(data: IShapeGizmosData, preData: IShapeGizmosData): void
- onTick(deltaTime: number, data: IShapeGizmosData): void
- onRemove(parent: Element, data: IShapeGizmosData): void
- onRelease(data: IShapeGizmosData): void
- /**
- * @internal
- */
- buildGizmo(info: GizmoInfo): void
- }
- export {}
- }
- declare module 'XrFrame/components/AssetPostProcess' {
- /**
- * AssetPostProcess.ts
- *
- * * @Date : 10/14/2022, 4:35:12 PM
- */
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- /**
- * `AssetPostProcess`资源数据接口。
- */
- export interface IAssetPostProcessData {
- /**
- * 资源`id`。
- */
- assetId: string
- /**
- * 同{@link IPostProcessOptions.type}。
- */
- type: string
- /**
- * 同{@link IPostProcessOptions.isHDR}。
- */
- isHDR?: boolean
- /**
- * 同{@link IPostProcessOptions.data}。
- */
- data?: {
- [key: string]: string
- }
- }
- /**
- * {@link AssetPostProcess}的`schema`,详见{@link IAssetPostProcessData}。
- */
- export const AssetPostProcessSchema: IComponentSchema
- /**
- * 渲染纹理创建组件,用于在`xml`中创建{@link PostProcess}资源,一般被代理到{@link XRAssetPostProcess}元素。
- */
- export default class AssetPostProcess extends Component<IAssetPostProcessData> {
- /**
- * 详见{@link AssetPostProcessSchema}。
- */
- readonly schema: IComponentSchema
- /**
- * 对应后处理资源的数据,可用于修改。
- */
- get assetData(): {
- [key: string]: any
- }
- onAdd(parent: Element, data: IAssetPostProcessData): void
- onUpdate(
- data: IAssetPostProcessData,
- preData: IAssetPostProcessData
- ): void
- /**
- * 移除AssetPostProcess。
- */
- onRemove(parent: Element, data: IAssetPostProcessData): void
- }
- }
- declare module 'XrFrame/elements/xr-node' {
- /**
- * xr-node.ts
- *
- * * @Date : 2022/3/18下午2:15:02
- */
- import Element, { IEntityComponents } from 'XrFrame/core/Element'
- /**
- * 默认包含{@link Transform}组件。
- */
- export const NodeDefaultComponents: IEntityComponents
- /**
- * 默认将{@link Transform}组件的属性进行映射。
- */
- export const NodeDataMapping: {
- 'node-id': string[]
- visible: string[]
- layer: string[]
- position: string[]
- rotation: string[]
- scale: string[]
- } & {
- [key: string]: string[]
- }
- /**
- * 标签为`xr-node`,场景中所有3D节点的基础。
- *
- * 默认组件见{@link NodeDefaultComponents},属性映射见{@link NodeDataMapping}。
- */
- export default class XRNode extends Element {
- static IS(element: Element): element is XRNode
- readonly defaultComponents: IEntityComponents
- readonly dataMapping: {
- [key: string]: string[]
- }
- readonly isXRNode: boolean
- }
- }
- declare module 'XrFrame/elements/xr-shadow' {
- /**
- * xr-shadow.ts
- *
- * * @Date : 6/14/2022, 3:59:17 PM
- */
- import Element, { IEntityComponents } from 'XrFrame/core/Element'
- /**
- * 默认包含{@link XRNode}的所有默认组件。
- */
- export const ShadowDefaultComponents: IEntityComponents
- /**
- * 默认包含{@link XRNode}的所有属性映射。
- */
- export const ShadowDataMapping: {
- 'node-id': string[]
- visible: string[]
- layer: string[]
- position: string[]
- rotation: string[]
- scale: string[]
- } & {
- [key: string]: string[]
- }
- /**
- * 标签为`xr-shadow`。
- * 是一种特殊的节点,开发者**仅可在其下以及子孙挂载自己创建的节点**!
- *
- * 默认组件见{@link ShadowDefaultComponents},属性映射见{@link ShadowDataMapping}。
- */
- export default class XRShadow extends Element {
- readonly defaultComponents: IEntityComponents
- readonly dataMapping: {
- [key: string]: string[]
- }
- _appendChild(_child: Element, custom?: boolean): void
- _removeChild(_child: Element, _index?: number, custom?: boolean): void
- _insertBefore(_child: Element, _before?: Element, _index?: number): void
- _replaceChild(
- _child: Element,
- _oldChild?: Element,
- _index?: number
- ): void
- _spliceBefore(
- _before: number | Element,
- _deleteCount: number,
- _list: Element
- ): void
- _spliceAppend(_list: Element): void
- _spliceRemove(_before: Element, _deleteCount: number): void
- }
- }
- declare module 'XrFrame/elements/xr-camera' {
- /**
- * xr-camera.ts
- *
- * * @Date : 2022/3/29下午5:03:57
- */
- import Element, { IEntityComponents } from 'XrFrame/core/Element'
- /**
- * 默认包含{@link XRNode}的所有默认组件,以及{@link Camera}组件。
- */
- export const CameraDefaultComponents: IEntityComponents
- /**
- * 默认包含{@link XRNode}的所有属性映射,以及将{@link Camera}组件的属性进行映射。
- */
- export const CameraDataMapping: {
- target: string[]
- 'render-target': string[]
- 'is-perspective': string[]
- 'cull-mask': string[]
- depth: string[]
- fov: string[]
- near: string[]
- far: string[]
- 'orth-size': string[]
- background: string[]
- 'is-ar-camera': string[]
- 'is-clear-depth': string[]
- 'is-clear-stencil': string[]
- 'is-clear-color': string[]
- 'clear-depth': string[]
- 'clear-stencil': string[]
- 'clear-color': string[]
- 'post-process': string[]
- 'allow-features': string[]
- } & {
- 'node-id': string[]
- visible: string[]
- layer: string[]
- position: string[]
- rotation: string[]
- scale: string[]
- } & {
- [key: string]: string[]
- }
- /**
- * 标签为`xr-camera`。
- *
- * 默认组件见{@link CameraDefaultComponents},属性映射见{@link CameraDataMapping}。
- */
- export default class XRCamera extends Element {
- readonly defaultComponents: IEntityComponents
- readonly dataMapping: {
- [key: string]: string[]
- }
- }
- }
- declare module 'XrFrame/elements/xr-mesh' {
- /**
- * xr-mesh.ts
- *
- * * @Date : 2022/3/29下午5:05:49
- */
- import Element, { IEntityComponents } from 'XrFrame/core/Element'
- /**
- * 默认包含{@link XRNode}的所有默认组件,以及{@link Mesh}组件。
- */
- export const MeshDefaultComponents: IEntityComponents
- /**
- * 默认包含{@link XRNode}的所有属性映射,以及将{@link Mesh}组件的属性进行映射。
- */
- export const MeshDataMapping: {
- 'never-cull': string[]
- 'cast-shadow': string[]
- 'receive-shadow': string[]
- geometry: string[]
- material: string[]
- uniforms: string[]
- states: string[]
- 'env-data': string[]
- } & {
- 'node-id': string[]
- visible: string[]
- layer: string[]
- position: string[]
- rotation: string[]
- scale: string[]
- } & {
- [key: string]: string[]
- }
- /**
- * 标签为`xr-mesh`。
- *
- * 默认组件见{@link MeshDefaultComponents},属性映射见{@link MeshDataMapping}。
- */
- export default class XRMesh extends Element {
- readonly defaultComponents: IEntityComponents
- readonly dataMapping: {
- [key: string]: string[]
- }
- }
- }
- declare module 'XrFrame/elements/xr-light' {
- /**
- * xr-light.ts
- *
- * * @Date : 4/12/2022, 10:37:57 AM
- */
- import Element, { IEntityComponents } from 'XrFrame/core/Element'
- /**
- * 默认包含{@link XRNode}的所有默认组件,以及{@link Light}组件。
- */
- export const LightDefaultComponents: IEntityComponents
- /**
- * 默认包含{@link XRNode}的所有属性映射,以及将{@link Light}组件的属性进行映射。
- */
- export const LightDataMapping: {
- type: string[]
- 'cast-shadow': string[]
- 'shadow-distance': string[]
- 'shadow-strength': string[]
- 'shadow-bias': string[]
- color: string[]
- intensity: string[]
- range: string[]
- 'inner-cone-angle': string[]
- 'outer-cone-angle': string[]
- } & {
- 'node-id': string[]
- visible: string[]
- layer: string[]
- position: string[]
- rotation: string[]
- scale: string[]
- } & {
- [key: string]: string[]
- }
- /**
- * 标签为`xr-ar-tracker`。
- *
- * 默认组件见{@link LightDefaultComponents},属性映射见{@link LightDataMapping}。
- */
- export default class XRLight extends Element {
- readonly defaultComponents: IEntityComponents
- readonly dataMapping: {
- [key: string]: string[]
- }
- }
- }
- declare module 'XrFrame/elements/xr-gltf' {
- import { IEntityComponents } from 'XrFrame/core/Element'
- import XRShadow from 'XrFrame/elements/xr-shadow'
- /**
- * 默认包含{@link XRNode}的所有默认组件,以及{@link GLTF}组件。
- */
- export const GLTFDefaultComponents: IEntityComponents
- /**
- * 默认包含{@link XRNode}的所有属性映射,以及将{@link GLTF}组件的属性进行映射。
- *
- * + model → {@link IGLTFComponentData.model}
- * + cast-shadow → {@link IGLTFComponentData.castShadow}
- * + receive-shadow → {@link IGLTFComponentData.receiveShadow}
- *
- */
- export const GLTFDataMapping: {
- model: string[]
- 'cast-shadow': string[]
- 'receive-shadow': string[]
- 'never-cull': string[]
- states: string[]
- } & {
- 'node-id': string[]
- visible: string[]
- layer: string[]
- position: string[]
- rotation: string[]
- scale: string[]
- } & {
- [key: string]: string[]
- }
- /**
- * 标签为`xr-gltf`。
- * 不能在这个标签内放置子标签。
- *
- * 默认组件见{@link GLTFDefaultComponents},属性映射见{@link GLTFDataMapping}。
- */
- export default class XRGLTF extends XRShadow {
- readonly defaultComponents: IEntityComponents
- readonly dataMapping: {
- [key: string]: string[]
- }
- }
- }
- declare module 'XrFrame/elements/xr-asset-material' {
- /**
- * xr-asset-material.ts
- *
- * * @Date : 2022/3/18下午5:27:37
- */
- import Element, { IEntityComponents } from 'XrFrame/core/Element'
- export const AssetMaterialDefaultComponents: IEntityComponents
- /**
- * 将{@link AssetMaterial}的属性进行映射。
- */
- export const AssetMaterialDataMapping: {
- 'asset-id': string[]
- effect: string[]
- marcos: string[]
- uniforms: string[]
- states: string[]
- 'render-queue': string[]
- 'env-data': string[]
- } & {
- [key: string]: string[]
- }
- /**
- * 标签为`xr-asset-material`。
- *
- * 默认组件见{@link AssetMaterialDefaultComponents},属性映射见{@link AssetMaterialDataMapping}。
- */
- export default class XRAssetMaterial extends Element {
- readonly defaultComponents: IEntityComponents
- readonly dataMapping: {
- [key: string]: string[]
- }
- }
- }
- declare module 'XrFrame/elements/xr-asset-render-texture' {
- /**
- * xr-asset-render-texture.ts
- *
- * * @Date : 8/29/2022, 12:51:29 PM
- */
- import Element, { IEntityComponents } from 'XrFrame/core/Element'
- export const AssetRenderTextureDefaultComponents: IEntityComponents
- /**
- * 将{@link AssetRenderTexture}的属性进行映射。
- */
- export const AssetRenderTextureDataMapping: {
- 'asset-id': string[]
- width: string[]
- height: string[]
- 'is-hdr': string[]
- } & {
- [key: string]: string[]
- }
- /**
- * 标签为`xr-asset-render-texture`。
- *
- * 默认组件见{@link AssetRenderTextureDefaultComponents},属性映射见{@link AssetRenderTextureDataMapping}。
- */
- export default class XRAssetRenderTexture extends Element {
- readonly defaultComponents: IEntityComponents
- readonly dataMapping: {
- [key: string]: string[]
- }
- }
- }
- declare module 'XrFrame/elements/xr-asset-load' {
- /**
- * xr-asset-load.ts
- *
- * * @Date : 2022/3/16下午5:29:40
- */
- import Element from 'XrFrame/core/Element'
- /**
- * 将{@link AssetLoad}组件的属性进行映射。
- */
- export const AssetLoadDataMapping: {
- type: string[]
- 'asset-id': string[]
- src: string[]
- defer: string[]
- options: string[]
- } & {
- [key: string]: string[]
- }
- /**
- * 标签为`xr-asset-load`。
- *
- * 属性映射见{@link AssetLoadDataMapping}。
- */
- export default class XRAssetLoad extends Element {
- readonly dataMapping: {
- [key: string]: string[]
- }
- readonly neverTick: boolean
- }
- }
- declare module 'XrFrame/elements/xr-assets' {
- /**
- * xr-assets.ts
- *
- * * @Date : 2022/3/16下午5:28:52
- */
- import Element, { IEntityComponents } from 'XrFrame/core/Element'
- /**
- * 默认包含{@link Assets}组件。
- */
- export const AssetsDefaultComponents: IEntityComponents
- /**
- * 标签为`xr-assets`。
- *
- * 默认组件见{@link AssetsDefaultComponents}。
- */
- export default class XRAssets extends Element {
- readonly defaultComponents: IEntityComponents
- readonly neverTick: boolean
- }
- }
- declare module 'XrFrame/elements/xr-env' {
- /**
- * xr-env.ts
- *
- * * @Date : 5/12/2022, 12:56:19 PM
- */
- import Element, { IEntityComponents } from 'XrFrame/core/Element'
- /**
- * 默认包含{@link Env}组件。
- */
- export const EnvDefaultComponents: IEntityComponents
- /**
- * 默认将{@link Env}组件的属性进行映射。
- */
- export const EnvDataMapping: {
- 'env-data': string[]
- 'sky-map': string[]
- 'is-sky2d': string[]
- rotation: string[]
- 'diffuse-exp': string[]
- 'specular-exp': string[]
- } & {
- [key: string]: string[]
- }
- /**
- * 标签为`xr-env`。
- *
- * 默认组件见{@link EnvDefaultComponents},属性映射见{@link EnvDataMapping}。
- */
- export default class XREnv extends Element {
- readonly defaultComponents: IEntityComponents
- readonly dataMapping: {
- [key: string]: string[]
- }
- readonly neverTick: boolean
- }
- }
- declare module 'XrFrame/elements/xr-ar-tracker' {
- /**
- * xr-ar-tracker.ts
- *
- * * @Date : 6/27/2022, 3:42:45 PM
- */
- import Element, { IEntityComponents } from 'XrFrame/core/Element'
- /**
- * 默认包含{@link XRNode}的所有默认组件,以及{@link ARTracker}组件。
- */
- export const ARTrackerDefaultComponents: IEntityComponents
- /**
- * 默认包含{@link XRNode}的所有属性映射,以及将{@link ARTracker}组件的属性进行映射。
- */
- export const ARTrackerDataMapping: {
- mode: string[]
- 'hit-id': string[]
- image: string[]
- src: string[]
- 'auto-sync': string[]
- } & {
- 'node-id': string[]
- visible: string[]
- layer: string[]
- position: string[]
- rotation: string[]
- scale: string[]
- } & {
- [key: string]: string[]
- }
- /**
- * 标签为`xr-ar-tracker`。
- *
- * 默认组件见{@link ARTrackerDefaultComponents},属性映射见{@link ARTrackerDataMapping}。
- */
- export default class XRARTracker extends Element {
- readonly defaultComponents: IEntityComponents
- readonly dataMapping: {
- [key: string]: string[]
- }
- }
- }
- declare module 'XrFrame/elements/xr-text' {
- import Element, { IEntityComponents } from 'XrFrame/core/Element'
- export const TextDefaultComponents: IEntityComponents
- export const TextDataMapping: {
- [key: string]: string[]
- }
- export default class XRText extends Element {
- readonly defaultComponents: IEntityComponents
- readonly dataMapping: {
- [key: string]: string[]
- }
- }
- }
- declare module 'XrFrame/elements/xr-particle' {
- import Element, { IEntityComponents } from 'XrFrame/core/Element'
- export const ParticleDefaultComponents: IEntityComponents
- export const ParticleDataMapping: {
- [key: string]: string[]
- }
- export default class XRParticle extends Element {
- readonly defaultComponents: IEntityComponents
- readonly dataMapping: {
- [key: string]: string[]
- }
- }
- }
- declare module 'XrFrame/elements/xr-asset-post-process' {
- /**
- * xr-asset-post-process.ts
- *
- * * @Date : 10/14/2022, 5:18:21 PM
- */
- import Element, { IEntityComponents } from 'XrFrame/core/Element'
- export const AssetPostProcessDefaultComponents: IEntityComponents
- /**
- * 将{@link AssetPostProcess}的属性进行映射。
- */
- export const AssetPostProcessDataMapping: {
- 'asset-id': string[]
- type: string[]
- 'is-hdr': string[]
- data: string[]
- } & {
- [key: string]: string[]
- }
- /**
- * 标签为`xr-asset-render-texture`。
- *
- * 默认组件见{@link AssetPostProcessDefaultComponents},属性映射见{@link AssetPostProcessDataMapping}。
- */
- export default class XRAssetPostProcess extends Element {
- readonly defaultComponents: IEntityComponents
- readonly dataMapping: {
- [key: string]: string[]
- }
- }
- }
- declare module 'XrFrame/systems/AssetsSystem' {
- import Component from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- import { IAssetLoadData, IAssetWithState } from 'XrFrame/loader/types'
- export interface IAssetsSystemData {}
- /**
- * 资源系统,负责整个场景的资源管理。
- *
- * 一般不需要手动管理,而是利用{@link AssetLoad}、{@link registerGeometry}之类的使用。
- */
- export default class AssetsSystem extends Component<IAssetsSystemData> {
- readonly priority: number
- /**
- * 手动添加一个资源。
- */
- addAsset<T>(type: string, id: string, asset: T): void
- /**
- * 手动加载一个资源。
- */
- loadAsset(
- params: IAssetLoadData,
- parent?: Element
- ): Promise<IAssetWithState<any>>
- /**
- * 手动释放一个资源。
- *
- * 注意在`xml`里加载的资源不要手动释放。
- */
- releaseAsset(type: string, id: string): void
- /**
- * 获取一个资源,如果尚未加载完成,也会返回`undefined`。
- */
- getAsset<T>(type: string, id: string, fallback?: string): T
- /**
- * 获取一个资源以及加载状态。
- */
- getAssetWithState<T>(
- type: string,
- id: string,
- fallback?: string
- ): IAssetWithState<T>
- /**
- * 取消加载一个资源。
- */
- cancelAsset(type: string, id: string): void
- /**
- * @internal
- */
- /**
- * @internal
- */
- onRelease(data: IAssetsSystemData): void
- }
- }
- declare module 'XrFrame/systems/NodeSystem' {
- import Component from 'XrFrame/core/Component'
- export interface INodeSystemData {}
- /**
- * 节点系统,负责整个场景节点的管理。
- */
- export default class NodeSystem extends Component<INodeSystemData> {
- readonly priority: number
- onTick(deltaTime: number, data: INodeSystemData): void
- }
- }
- declare module 'XrFrame/systems/TickSystem' {
- /**
- * TickSystem.ts
- *
- * * @Date : 2022/3/29上午10:50:57
- */
- import Component from 'XrFrame/core/Component'
- export interface ITickSystemData {}
- /**
- * Tick系统,负责整个场景生命周期的驱动。
- */
- export default class TickSystem extends Component<ITickSystemData> {
- readonly priority: number
- onTick(deltaTime: number, data: ITickSystemData): void
- }
- }
- declare module 'XrFrame/systems/AnimationSystem' {
- /**
- * AnimationSystem.ts
- *
- * * @Date : 6/17/2022, 2:35:17 PM
- */
- import Animator from 'XrFrame/components/Animator'
- import Component from 'XrFrame/core/Component'
- export interface IAnimationSystemData {}
- /**
- * 动画系统,负责整个场景动画的管理。
- */
- export default class AnimationSystem extends Component<IAnimationSystemData> {
- readonly priority: number
- onTick(deltaTime: number, data: IAnimationSystemData): void
- /**
- * @internal
- */
- /**
- * @internal
- */
- }
- }
- declare module 'XrFrame/systems/VideoSystem' {
- /**
- * VideoSystem.ts
- *
- * * @Date : 8/26/2022, 8:02:21 PM
- */
- import VideoTexture from 'XrFrame/assets/VideoTexture'
- import Component from 'XrFrame/core/Component'
- import { Element } from 'XrFrame/xrFrameSystem'
- export interface IVideoSystemData {}
- /**
- * 视频系统,负责整个场景视频的管理。
- */
- export default class VideoSystem extends Component<IVideoSystemData> {
- readonly priority: number
- onAdd(parent: Element, data: IVideoSystemData): void
- onTick(deltaTime: number, data: IVideoSystemData): void
- onRelease(data: IVideoSystemData): void
- /**
- * @internal
- */
- /**
- * @internal
- */
- }
- }
- declare module 'XrFrame/systems/RenderSystem' {
- /**
- * RenderSystem.ts
- *
- * * @Date : 2022/3/16下午4:20:58
- */
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- import Camera from 'XrFrame/components/Camera'
- import Env from 'XrFrame/components/Env'
- import RenderGraph from 'XrFrame/render-graph/RenderGraph'
- import LightManager from 'XrFrame/systems/LightManager'
- import Observable from 'XrFrame/core/Observable'
- /**
- * `RenderSystem`系统数据接口。
- */
- export interface IRenderSystemData {
- /**
- * 是否支持画布输出透明通道,并且能够和背景混合。
- * `xml`中数据类型为`boolean`。
- */
- alpha: boolean
- /**
- * 场景中阴影的颜色。
- * `xml`中数据类型为`color`。
- */
- shadowColor: number[]
- }
- /**
- * {@link RenderSystem}的`schema`,详见{@link IRenderSystemData}。
- */
- export const RenderSystemSchema: IComponentSchema
- /**
- * 渲染系统,负责整个场景渲染的管理。
- */
- export default class RenderSystem extends Component<IRenderSystemData> {
- readonly priority: number
- /**
- * 详见{@link RenderSystemSchema}。
- */
- readonly schema: IComponentSchema
- protected _lights: LightManager
- protected _renderGraph?: RenderGraph
- protected _sortedCameras: Camera[]
- protected _dirtyCameras: Camera[]
- protected _features: {
- [key: string]: boolean | number | string
- }
- protected _dirtyFeatures: {
- [key: string]: boolean | number | string
- }
- protected _camerasChangeEvent: Observable<this>
- protected _env: Env
- /**
- * @internal
- */
- get lights(): LightManager
- /**
- * @internal
- */
- get env(): Env
- /**
- * @internal
- */
- get camerasChangeEvent(): Observable<this, any>
- /**
- * 获取场景中的所有相机,已按照深度排序。
- *
- * @internal
- */
- get cameras(): Camera[]
- /**
- * 获取场景中的所有当帧修改过的相机,已按照深度排序。
- *
- * @internal
- */
- get changedCameras(): Camera[]
- /**
- * 当前正在使用的RenderGraph。
- */
- get renderGraph(): RenderGraph<any>
- get shadowColor(): number[]
- /**
- * 修改全局宏信息。
- */
- changeMacros(macros: {
- [name: string]: string | number | boolean
- }): void
- /**
- * 获取全局宏信息。
- */
- getMacro(key: string): string | number | boolean
- /**
- * 修改全局渲染特性。
- */
- changeFeatures(features: {
- [key: string]: string | number | boolean
- }): void
- /**
- * 获取全局渲染特性。
- */
- getFeature(key: string): boolean | number | string
- onAdd(parent: Element, data: IRenderSystemData): void
- onTick(): void
- onRelease(data: IRenderSystemData): void
- /**
- * 使用某个RenderGraph,默认会使用内置的`ForwardBaseRG`。
- */
- useRenderGraph(rg: RenderGraph): void
- /**
- * 开启全局GPU实例化。
- */
- enableInstance(): void
- /**
- * 关闭全局GPU实例化。
- */
- disableInstance(): void
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- protected _sortCameras(): void
- }
- }
- declare module 'XrFrame/systems/PhysicsSystem' {
- import { Camera } from 'XrFrame/components'
- import Component from 'XrFrame/core/Component'
- import { Kanata } from 'XrFrame/ext'
- import Vector3 from 'XrFrame/math/vector3'
- import { RaycastDesc } from 'XrFrame/physics/raycast'
- import Element from 'XrFrame/core/Element'
- import Shape from 'XrFrame/components/physics/Shape'
- /**
- * `touch-shape`和`untouch-shape`事件的回调参数。
- */
- export interface IShapeTouchEvent {
- /**
- * 渲染*被选中的{@link Shape | 轮廓}*的相机。
- */
- camera: Camera
- /**
- * *被选中的{@link Shape | 轮廓}*所在的元素。
- */
- target: Element
- /**
- * 被选中的{@link Shape | 轮廓}。
- */
- shape: Shape
- /**
- * 点击位置在二维canvas中的x坐标。
- */
- x: number
- /**
- * 点击位置在二维canvas中的y坐标。
- */
- y: number
- /**
- * {@link camera}在三维场景中的位置。
- */
- origin: [number, number, number]
- /**
- * 从{@link camera}投射出的射线的单位向量。
- */
- dir: [number, number, number]
- /**
- * @unimplemented
- */
- force: number
- }
- /**
- * `drag-shape`事件的回调参数。
- */
- export interface IShapeDragEvent extends IShapeTouchEvent {
- /**
- * 点击位置在二维canvas中的x坐标的变化量。
- */
- deltaX: number
- /**
- * 点击位置在二维canvas中的y坐标的变化量。
- */
- deltaY: number
- }
- /**
- * @see {@link PhysicsSystem}
- */
- export interface IPhysicsSystemData {}
- /**
- * 物理系统,管理着场景中的所有{@link Shape | 轮廓}和{@link Rigidbody | 刚体}。
- */
- export default class PhysicsSystem extends Component<IPhysicsSystemData> {
- /**
- * @internal
- */
- nativeSystem: phys3D.PhysSystem
- /**
- * 是否进行物理模拟。
- */
- enableSimulation: boolean
- constructor()
- /** @internal */
- addShape(shape: Shape): void
- /** @internal */
- removeShape(shape: Shape): void
- onAdd(): void
- maxPhysicsDeltaTime: number
- fixedDeltaTime: number
- /**
- * @internal
- */
- onTick(dt: number, data: IPhysicsSystemData): void
- /**
- * @internal
- */
- bindRigidbodyWithEntity(
- rigidbody: phys3D.Rigidbody,
- entity: Kanata.Entity3D
- ): void
- /**
- * @internal
- */
- unbindRigidbody(rigidbody: phys3D.Rigidbody): void
- /**
- * 射线检测,判断给定射线是否与至少一个轮廓相交,并返回与**最近**的那个轮廓相交的信息。
- * 返回的信息记录在desc.hit里,需要事先创建一个RaycastHit对象来负责接收。
- */
- raycast(desc: RaycastDesc): boolean
- /**
- * 全局重力。
- * @default [0, -9.8, 0]
- */
- get gravity(): Vector3
- set gravity(v: Vector3)
- /**
- * 设置碰撞矩阵。
- * @param str 用于表达碰撞矩阵的字符串
- * @internal
- */
- setCollisionMatrix(str: string): void
- /**
- * 设定某一对layer之间是否会发生碰撞。
- * @param ignore `true`表示**不**碰撞。
- */
- ignoreLayerCollision(
- layer1: number,
- layer2: number,
- ignore?: boolean
- ): void
- }
- }
- declare module 'XrFrame/systems/ARSystem' {
- import { Camera, Mesh } from 'XrFrame/components'
- import ARTracker, { TTrackMode } from 'XrFrame/components/ARTracker'
- import Component, { IComponentSchema } from 'XrFrame/core/Component'
- import Matrix4 from 'XrFrame/math/matrix4'
- import Vector3 from 'XrFrame/math/vector3'
- type Element = import('XrFrame/core/Element').default
- /**
- * AR追踪原始数据。
- */
- export interface IARRawData {
- /**
- * 该帧生成时间,单位是纳秒(ns)。
- * 在版本`v2.30.1`之后支持。
- */
- timestamp: number
- /**
- * 当前相机帧画面宽度。
- */
- width: number
- /**
- * 当前相机帧画面高度。
- */
- height: number
- /**
- * 当前相机帧画面`y`通道,yuv420。
- */
- yBuffer: ArrayBuffer
- /**
- * 当前相机帧画面`uv`通道,yuv420。
- */
- uvBuffer: ArrayBuffer
- /**
- * 当前相机帧内参矩阵。
- */
- intrinsics: Float32Array
- /**
- * 当前相机帧视图矩阵。
- */
- viewMatrix: Float32Array
- }
- /**
- * `ARSystem`系统数据接口。
- */
- export interface IARSystemData {
- /**
- * 系统支持的追踪模式,目前仅支持一个!
- * `xml`中数据类型为`array`,默认值为`Plane`。
- */
- modes: TTrackMode[]
- /**
- * 使用前置还是后置相机,默认后置`Back`。
- */
- camera?: 'Front' | 'Back'
- /**
- * 在支持的情况下,是否开启实时深度遮挡。
- * **目前暂时不可用!**
- */
- depthMask?: boolean
- /**
- * 开启实时深度遮挡时,遮挡的近处阈值。
- * 值是空间实际尺度(m),默认为`0.02`。
- */
- depthNear?: number
- /**
- * 开启实时深度遮挡时,遮挡的远处阈值。
- * 值是空间实际尺度(m),默认为`20`。
- */
- depthFar?: number
- /**
- * 开启实时深度遮挡时,显示一个用于Debug的图层。
- * **目前暂时不可用!**
- */
- depthDebug?: boolean
- /**
- * 在`v2`平面模式下,平面检测模式。
- * `1`为水平面,`2`为垂直平面,`3`为两个都支持。
- * 默认为`3`。
- */
- planeMode?: number
- /**
- * 在`Face`/`Body`/`Hand`模式下,使用原生的AI3D推理估计。
- * 默认为`false`。
- * **目前暂时不可用!**
- */
- pose3d?: boolean
- }
- /**
- * {@link ARSystem}的`schema`,详见{@link IARSystemData}。
- */
- export const ARSystemSchema: IComponentSchema
- /**
- * AR系统,负责整个场景AR相关对象的管理。
- *
- * 代理自小程序的`VKSession`。
- */
- export default class ARSystem extends Component<IARSystemData> {
- static EVENTS: string[]
- /**
- * 详见{@link ARSystemSchema}。
- */
- readonly schema: IComponentSchema
- readonly priority: number
- /**
- * 当前设备是否启动成功。
- */
- get supported(): boolean
- /**
- * 当前启动的追踪模式。
- */
- get arModes(): TTrackMode[]
- /**
- * 当前启动的AR系统版本。
- */
- get arVersion(): number
- /**
- * 当前是否已经可用。
- */
- get ready(): boolean
- /**
- * 在`Face`/`Body`/`Hand`模式下,当前识别到的姿态数量。
- */
- get posCount(): number
- onAdd(parent: Element, data: IARSystemData): void
- onTick(deltaTime: number, data: IARSystemData): void
- onUpdate(data: IARSystemData, preData: IARSystemData): void
- onRemove(parent: Element, data: IARSystemData): void
- onRelease(data: IARSystemData): void
- /**
- * 在`Plane`模式下,同步某个节点到当前追踪到的和平面的交点。
- *
- * @param nodeIdOrElement 节点的`nodeId`或是`element`引用。
- * @param switchVisible 是否要自动切换显示或隐藏。
- * @returns 是否放置成功
- */
- placeHere(
- nodeIdOrElement: string | Element,
- switchVisible?: boolean
- ): boolean
- /**
- * 在`Plane`模式下,重置平面。
- */
- resetPlane(): void
- /**
- * 获取AR的追踪的原始数据。
- */
- getARRawData(): IARRawData
- /**
- * 提供一个修改某个设置为`isARCamera`的相机的试图矩阵的手段。
- */
- forceSetViewMatrix(camera: Camera, mat: Matrix4 | null): void
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- }
- export {}
- }
- declare module 'XrFrame/systems/ShareSystem' {
- /**
- * ShareSystem.ts
- *
- * * @Date : 9/19/2022, 5:04:24 PM
- */
- import Component from 'XrFrame/core/Component'
- export interface IShareSystemData {}
- /**
- * 分享到临时文件的配置。
- */
- export interface IShareCaptureOptions {
- /**
- * 输出图片编码。
- * @default 'jpg'
- */
- fileType?: 'jpg' | 'png'
- /**
- * 输出图片jpg时的品质,0~1。
- * @default 0.8
- */
- quality?: number
- }
- /**
- * 分享录屏的配置。
- */
- export interface IShareRecordOptions {
- /**
- * 输出帧率。
- * @default 30
- */
- fps?: number
- /**
- * 视频比特率。
- * @default 1000
- */
- videoBitsPerSecond?: number
- /**
- * 录制视频宽度,不传的话使用Canvas宽度。
- */
- width?: number
- /**
- * 录制视频高度,不传的话使用Canvas高度。
- */
- height?: number
- }
- /**
- * 录屏状态枚举。
- */
- export enum EShareRecordState {
- Idle = 0,
- Waiting = 1,
- Recording = 2,
- Paused = 3
- }
- /**
- * 分享系统,负责分享相关功能。
- */
- export default class ShareSystem extends Component<IShareSystemData> {
- readonly priority: number
- /**
- * 当前是否支持分享系统。
- */
- get supported(): boolean
- /**
- * 当前录屏状态。
- */
- get recordState(): EShareRecordState
- onTick(deltaTime: number, data: IShareSystemData): void
- /**
- * @deprecated 请在`v3.0.2`后使用异步版本,同步版本不再维护,请使用`captureToDataURLAsync`。
- * 截屏输出为`base64`。
- */
- captureToDataURL(options?: IShareCaptureOptions): string
- /**
- * @deprecated 请在`v3.0.2`后使用异步版本,同步版本不再维护,请使用`captureToArrayBufferAsync`。
- * 截屏输出为`ArrayBuffer`。
- */
- captureToArrayBuffer(options?: IShareCaptureOptions): ArrayBuffer
- /**
- * 截屏输出为`base64`。
- * 基础库`v3.0.2`以上版本支持。
- */
- captureToDataURLAsync(options?: IShareCaptureOptions): Promise<string>
- /**
- * 截屏输出为`ArrayBuffer`。
- * 基础库`v3.0.2`以上版本支持。
- */
- captureToArrayBufferAsync(
- options?: IShareCaptureOptions
- ): Promise<ArrayBuffer>
- /**
- * 截屏输出为本地路径,回调完成后会自动释放。
- *
- * @params callback 接受结果的回调,处理完后会释放文件。在v2.27.1前是异步,之后兼容同步和异步。
- */
- captureToLocalPath(
- options: IShareCaptureOptions,
- callback: (fp: string) => Promise<void> | void
- ): Promise<void>
- /**
- * 直接截屏分享给好友。
- */
- captureToFriends(options?: IShareCaptureOptions): Promise<void>
- /**
- * 启动录屏。
- * 基础库`v3.1.1`以上版本支持。
- */
- recordStart(options?: IShareRecordOptions): Promise<void>
- /**
- * 暂停本次录屏。
- * 基础库`v3.1.1`以上版本支持。
- */
- recordPause(): Promise<void>
- /**
- * 唤醒本次录屏。
- */
- recordResume(): Promise<void>
- /**
- * 录屏完成,输出到临时文件。
- * 基础库`v3.1.1`以上版本支持。
- *
- * @returns 临时文件地址
- */
- recordFinishToTempFile(): Promise<string>
- /**
- * 录屏完成,直接保存到用户相册。
- * 基础库`v3.1.1`以上版本支持。
- */
- recordFinishToAlbum(): Promise<void>
- }
- }
- declare module 'XrFrame/systems/GizmoSystem' {
- /**
- * @author shanexyzhou@tencent.com
- */
- import CapsuleGizmo from 'XrFrame/components/gizmo/CapsuleGizmo'
- import CubeGizmo from 'XrFrame/components/gizmo/CubeGizmo'
- import Component from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- export interface IGizmoSystemData {}
- type GizmoComponent = CubeGizmo | CapsuleGizmo
- /**
- * 动画系统,负责为Gizmo组件创建管理相对应的GizmoMesh元素。
- */
- export default class GizmoSystem extends Component<IGizmoSystemData> {
- readonly priority: number
- onTick(deltaTime: number, data: IGizmoSystemData): void
- /**
- * @internal
- * 因为exparser的原因,不能通过脚本为普通xml节点添加子节点,
- * 只能给XRShadow添加子节点,所以把需要添加gizmo的节点复制一份放在shadowRoot下,
- * 每帧去同步transform。
- */
- addGizmo(gizmo: GizmoComponent): Element
- /**
- * @internal
- */
- removeGizmo(gizmo: GizmoComponent): void
- }
- export {}
- }
- declare module 'XrFrame/loader/AssetLoader' {
- import { IAssetLoadData } from 'XrFrame/loader/types'
- type Scene = import('XrFrame/core/Scene').default
- /**
- * 指定继承自{@link AssetLoader}的自定义资源加载器,可以接受的的额外配置的`schema`。
- * 在基础库版本**v2.29.2**以上导出。
- *
- * 比如使用{@link CubeTextureLoader}加载资源时:
- *
- * ```xml
- * <xr-asset-load
- * type="cube-texture" asset-id="sky-cube" src="/assets/textures/skybox/"
- * options="faces: right.jpg left.jpg top.jpg bottom.jpg front.jpg back.jpg"
- * />
- * ```
- *
- * 对应的`schema`接口为:
- * ```ts
- * export interface ICubeTextureLoaderOptions {
- * // left right top bottom front back
- * faces: string[];
- * }
- * ```ts
- *
- * 对应的`schema`为:
- * ```ts
- * schema = {
- * faces: {type: 'array'}
- * };
- * ```
- */
- export interface ILoaderOptionsSchema {
- [key: string]: {
- type: string
- defaultValue?: any
- }
- }
- /**
- * 资源加载器的基类,配合{@link AssetsSystem}使用。
- * 在基础库版本**v2.29.2**以上导出。
- *
- * @template T 加载资源的类型。
- * @template ILoadOptions 可接受额外配置的类型。
- */
- export default class AssetLoader<T, ILoadOptions> {
- /**
- * 和{@link Component.schema}类似,指定解析Options的实际`schema`,对应于`ILoadOptions`。
- */
- readonly schema: ILoaderOptionsSchema
- /**
- * 当前资源所属场景的实例。
- */
- get scene(): import('XrFrame/core/Scene').default
- constructor(_scene: Scene, type: string)
- /**
- * @internal
- */
- /**
- * 加载一个资源,并根据情况执行`callbacks`中的回调。
- * **理论上必须要实现!**
- *
- * @param callbacks 开发者需要在加载进度更新时执行`onLoading`,在加载完成时执行`onLoaded`,在加载出错是执行`onError`
- */
- load(
- data: IAssetLoadData<ILoadOptions>,
- callbacks: {
- onLoading(progress: number): void
- onLoaded(result: T, localPath?: string): void
- onError(error: Error): void
- }
- ): void
- /**
- * 取消加载特定资源。一般不需要自己编写逻辑,而是使用`entity.canceled`在加载终点丢弃。
- * 注意`entity.canceled`是在这里赋值的,所以一般继承请务必先执行`super.cancel()`!
- */
- cancel(params: IAssetLoadData<ILoadOptions>): void
- /**
- * 释放资源时将会调用,用于自定义释放逻辑。
- */
- release(params: IAssetLoadData<ILoadOptions>, value: T): void
- /**
- * 返回默认资源列表。
- * 所有默认资源都是惰性加载的。
- */
- getBuiltin(): Array<{
- assetId: string
- src: string
- options: ILoadOptions
- }>
- }
- export function getAssetLoaderTypes(): string[]
- export function getAssetLoader(
- type: string
- ): new (
- scene: import('XrFrame/core/Scene').default,
- type: string
- ) => AssetLoader<any, any>
- /**
- * 注册一个资源加载器。注意注册后该`type`会被自动注册到DataValue中:{@link registerDataValue}。
- * 在基础库版本**v2.29.2**以上导出。
- *
- * @param type 类型,也是写在{@link AssetLoad}上的那个`type`。
- * @param clz 继承自{@link AssetLoader}的自定义资源加载器类。
- */
- export function registerAssetLoader(
- type: string,
- clz: new (scene: Scene, type: string) => AssetLoader<any, any>
- ): void
- export {}
- }
- declare module 'XrFrame/loader/TextureLoader' {
- /**
- * TextureLoader.ts
- *
- * * @Date : 2022/4/1下午5:19:36
- */
- import { Kanata } from 'XrFrame/ext'
- import AssetLoader, {
- ILoaderOptionsSchema
- } from 'XrFrame/loader/AssetLoader'
- import { IAssetLoadData } from 'XrFrame/loader/types'
- export function isPOT(img: Kanata.IImage): boolean
- /**
- * {@link TextureLoader}可接受的自定义参数`schema`。
- */
- export interface ITextureLoaderOptions {
- /**
- * 各向异性系数。
- * @default 1
- */
- anisoLevel?: number
- /**
- * wrapU,值为数字,见{@link EWrapMode}。
- * @default 2
- */
- wrapU?: number
- /**
- * wrapV,值为数字,见{@link EWrapMode}。
- * @default 2
- */
- wrapV?: number
- /**
- * magFilter,值为数字,见{@link EFilterMode}。
- * 默认值依据纹理是否POT而定。
- */
- magFilter?: number
- /**
- * minFilter,值为数字,见{@link EFilterMode}。
- * 默认值依据纹理是否POT而定。
- */
- minFilter?: number
- /**
- * 是否要生成mipmaps。
- * @default false
- */
- generateMipmaps?: boolean
- }
- type ITextureLoadData = IAssetLoadData<ITextureLoaderOptions>
- /**
- * 纹理资源{@link Texture}的加载器。
- *
- * 内置资源可以通过{@link registerTexture}注册,拥有内置资源`brdf-lut`、`white`、`transparent`、`black`、`red`、`green`、`blue`、`yellow`、`babyblue`、`babygreen`、`babyred`。
- */
- export default class TextureLoader extends AssetLoader<
- Kanata.Texture,
- ITextureLoaderOptions
- > {
- readonly schema: ILoaderOptionsSchema
- load(
- params: ITextureLoadData,
- callbacks: {
- onLoading(progress: number): void
- onLoaded(value: Kanata.Texture): void
- onError(error: Error): void
- }
- ): void
- getBuiltin(): Array<{
- assetId: string
- src: string
- options: {}
- }>
- release(params: ITextureLoadData, value: Kanata.Texture): void
- }
- export {}
- }
- declare module 'XrFrame/loader/ImageLoader' {
- /**
- * ImageLoader.ts
- *
- * * @Date : 6/13/2022, 12:40:11 PM
- */
- import { Kanata } from 'XrFrame/ext'
- import AssetLoader, {
- ILoaderOptionsSchema
- } from 'XrFrame/loader/AssetLoader'
- import { IAssetLoadData } from 'XrFrame/loader/types'
- export interface IImageLoaderOptions {}
- type IImageLoadData = IAssetLoadData<IImageLoaderOptions>
- /**
- * 图片数据资源{@link IImage}的加载器。
- *
- * 图片数据不同于纹理资源{@link Texture},请自行按照场景使用。
- */
- export default class ImageLoader extends AssetLoader<
- Kanata.IImage,
- IImageLoaderOptions
- > {
- readonly schema: ILoaderOptionsSchema
- load(
- params: IImageLoadData,
- callbacks: {
- onLoading(progress: number): void
- onLoaded(value: Kanata.IImage): void
- onError(error: Error): void
- }
- ): void
- release(params: IImageLoadData, value: Kanata.IImage): void
- }
- export {}
- }
- declare module 'XrFrame/loader/CubeTextureLoader' {
- /**
- * CubeCubeTextureLoader.ts
- *
- * * @Date : 5/10/2022, 11:24:51 AM
- */
- import { Kanata } from 'XrFrame/ext'
- import AssetLoader, {
- ILoaderOptionsSchema
- } from 'XrFrame/loader/AssetLoader'
- import { IAssetLoadData } from 'XrFrame/loader/types'
- /**
- * {@link CubeTextureLoader}可接受的自定义参数`schema`。
- */
- export interface ICubeTextureLoaderOptions {
- /**
- * 顺序为 left right top bottom front back。
- */
- faces: string[]
- /**
- * 各向异性系数。
- * @default 1
- */
- anisoLevel: number
- /**
- * wrapU,值为数字,见{@link EWrapMode}。
- * @default 2
- */
- wrapU?: number
- /**
- * wrapV,值为数字,见{@link EWrapMode}。
- * @default 2
- */
- wrapV?: number
- /**
- * wrapW,值为数字,见{@link EWrapMode}。
- * @default 2
- */
- wrapW?: number
- /**
- * magFilter,值为数字,见{@link EFilterMode}。
- * 默认值依据纹理是否POT而定。
- */
- magFilter?: number
- /**
- * minFilter,值为数字,见{@link EFilterMode}。
- * 默认值依据纹理是否POT而定。
- */
- minFilter?: number
- /**
- * 是否要生成mipmaps。
- * @default false
- */
- generateMipmaps?: boolean
- }
- type ICubeTextureLoadData = IAssetLoadData<ICubeTextureLoaderOptions>
- /**
- * 立方体资源{@link CubeTexture}的加载器。
- *
- * 内置资源可以通过{@link registerTextureCube}注册,拥有内置资源`brdf-lut`、`white`、`transparent`、`black`、`red`、`green`、`blue`、`yellow`。
- */
- export default class CubeTextureLoader extends AssetLoader<
- Kanata.Texture,
- ICubeTextureLoaderOptions
- > {
- /**
- * 详见{@link ICubeTextureLoaderOptions}。
- */
- readonly schema: ILoaderOptionsSchema
- load(
- params: ICubeTextureLoadData,
- callbacks: {
- onLoading(progress: number): void
- onLoaded(value: Kanata.Texture): void
- onError(error: Error): void
- }
- ): void
- release(params: ICubeTextureLoadData, value: Kanata.Texture): void
- }
- export {}
- }
- declare module 'XrFrame/loader/VideoTextureLoader' {
- /**
- * VideoTextureLoader.ts
- *
- * * @Date : 8/26/2022, 8:02:51 PM
- */
- import VideoTexture from 'XrFrame/assets/VideoTexture'
- import AssetLoader, {
- ILoaderOptionsSchema
- } from 'XrFrame/loader/AssetLoader'
- import { IAssetLoadData } from 'XrFrame/loader/types'
- /**
- * {@link VideoTextureLoader}可接受的自定义参数`schema`。
- *
- * 基本同{@link IVideoTextureOptions}。
- */
- export interface IVideoTextureLoaderOptions {
- anisoLevel: number
- placeHolder?: string
- autoPlay?: boolean
- loop?: boolean
- abortAudio?: boolean
- }
- type IVideoTextureLoadData = IAssetLoadData<IVideoTextureLoaderOptions>
- /**
- * 视频纹理资源{@link VideoTexture}的加载器。
- */
- export default class VideoTextureLoader extends AssetLoader<
- VideoTexture,
- IVideoTextureLoaderOptions
- > {
- /**
- * 详见{@link IVideoTextureLoaderOptions}。
- */
- readonly schema: ILoaderOptionsSchema
- load(
- params: IVideoTextureLoadData,
- callbacks: {
- onLoading(progress: number): void
- onLoaded(value: VideoTexture): void
- onError(error: Error): void
- }
- ): Promise<void>
- release(params: IVideoTextureLoadData, value: VideoTexture): void
- }
- export {}
- }
- declare module 'XrFrame/loader/EnvDataLoader' {
- /**
- * EnvDataLoader.ts
- *
- * * @Date : 5/10/2022, 11:27:49 AM
- */
- import EnvData from 'XrFrame/assets/EnvData'
- import AssetLoader, {
- ILoaderOptionsSchema
- } from 'XrFrame/loader/AssetLoader'
- import { IAssetLoadData } from 'XrFrame/loader/types'
- interface IBufferSlice {
- offset: number
- length: number
- type: string
- }
- export interface IEnvDataSource {
- skybox?: {
- type: '2D' | 'Cube'
- half: boolean
- map: (string | string[]) | IBufferSlice
- }
- diffuse?: {
- coefficients: number[][]
- }
- specular?: {
- type: '2D'
- rgbd: boolean
- mipmaps: boolean
- mipmapCount?: number
- map: string | IBufferSlice
- }
- }
- export interface IEnvDataLoaderOptions {}
- type IEnvDataLoadData = IAssetLoadData<IEnvDataLoaderOptions>
- /**
- * 环境数据资源{@link EnvData}的加载器。
- *
- * 拥有内置资源`xr-frame-team-workspace-day`、`xr-frame-team-workspace-night`以及`xr-frame-team-workspace-day2`。
- * 加载的资源一般由[xr-frame-cli](https://github.com/wechat-miniprogram/xr-frame-cli)生成。
- */
- export default class EnvDataLoader extends AssetLoader<
- EnvData,
- IEnvDataLoaderOptions
- > {
- readonly schema: ILoaderOptionsSchema
- load(
- params: IEnvDataLoadData,
- callbacks: {
- onLoading(progress: number): void
- onLoaded(value: EnvData): void
- onError(error: Error): void
- }
- ): Promise<void>
- getBuiltin(): Array<{
- assetId: string
- src: string
- options: IEnvDataLoaderOptions
- }>
- release(params: IEnvDataLoadData, value: EnvData): void
- }
- export {}
- }
- declare module 'XrFrame/loader/GlTFLoader' {
- /**
- * GLTFLoader.ts
- *
- * * @Date : 2022/3/16下午3:47:56
- */
- import GLTFModel from 'XrFrame/assets/GLTFModel'
- import AssetLoader, {
- ILoaderOptionsSchema
- } from 'XrFrame/loader/AssetLoader'
- import { IAssetLoadData } from 'XrFrame/loader/types'
- import { Scene } from 'XrFrame/elements'
- export enum GLBChunkType {
- JSON = 1313821514,
- BIN = 5130562
- }
- export interface IGLTFLoaderOptions {
- /**
- * *(基础库2.31.1及之后)*
- * 可以忽略xr-frame对GLTF模型的某一些限制,来强行渲染有问题的GLTF模型。
- * ErrorCode会在渲染模型失败后,由console报出。
- * 填写-1则忽略所有限制。
- */
- ignoreError: number[]
- /**
- * *(基础库2.32.1及之后)*
- * 开启了之后会在GLTFModel中保留原始json。
- */
- preserveRaw: boolean
- }
- type IGLTFLoadData = IAssetLoadData<IGLTFLoaderOptions>
- /**
- * GLTF资源加载器,加载完毕后返回一个{@link GLTFModel}。
- */
- export default class GLTFLoader extends AssetLoader<
- GLTFModel,
- IGLTFLoaderOptions
- > {
- readonly schema: ILoaderOptionsSchema
- load(
- param: IGLTFLoadData,
- callbacks: {
- onLoading(progress: number): void
- onLoaded(value: GLTFModel): void
- onError(error: Error): void
- }
- ): Promise<void>
- cancel(params: IGLTFLoadData): void
- release(params: IGLTFLoadData, value: GLTFModel): void
- /**
- * @internal
- */
- static createGLTFModel(
- scene: Scene,
- buffer: ArrayBuffer,
- param: IGLTFLoadData,
- onLoading?: (progress: number) => void
- ): Promise<GLTFModel>
- }
- export {}
- }
- declare module 'XrFrame/loader/KeyframeLoader' {
- /**
- * KeyframeLoader.ts
- *
- * * @Date : 6/21/2022, 6:48:33 PM
- */
- import KeyframeAnimation from 'XrFrame/animation/KeyframeAnimation'
- import AssetLoader, {
- ILoaderOptionsSchema
- } from 'XrFrame/loader/AssetLoader'
- import { IAssetLoadData } from 'XrFrame/loader/types'
- export interface IKeyframeLoaderOptions {}
- type IKeyframeLoadData = IAssetLoadData<IKeyframeLoaderOptions>
- /**
- * 帧动画资源{@link KeyframeAnimation}的加载器。
- */
- export default class KeyframeLoader extends AssetLoader<
- KeyframeAnimation,
- IKeyframeLoaderOptions
- > {
- readonly schema: ILoaderOptionsSchema
- load(
- params: IKeyframeLoadData,
- callbacks: {
- onLoading(progress: number): void
- onLoaded(value: KeyframeAnimation): void
- onError(error: Error): void
- }
- ): Promise<void>
- }
- export {}
- }
- declare module 'XrFrame/loader/RawLoader' {
- import AssetLoader, {
- ILoaderOptionsSchema
- } from 'XrFrame/loader/AssetLoader'
- import { IAssetLoadData } from 'XrFrame/loader/types'
- /**
- * 原始数据加载器的参数。
- */
- export interface IRawLoaderOptions {
- /**
- * 编码,默认为`binary`。
- */
- encoding?: 'binary' | 'utf-8'
- }
- type IRawLoadData = IAssetLoadData<IRawLoaderOptions>
- /**
- * 原始数据的加载器。
- */
- export default class RawLoader extends AssetLoader<
- string | ArrayBuffer,
- IRawLoaderOptions
- > {
- readonly schema: ILoaderOptionsSchema
- load(
- params: IRawLoadData,
- callbacks: {
- onLoading(progress: number): void
- onLoaded(value: string | ArrayBuffer): void
- onError(error: Error): void
- }
- ): Promise<void>
- }
- export {}
- }
- declare module 'XrFrame/loader/AtlasLoader' {
- /**
- * AtlasLoader.ts
- *
- * * @Date : 10/13/2022, 5:35:00 PM
- */
- import Atlas from 'XrFrame/assets/Atlas'
- import AssetLoader, {
- ILoaderOptionsSchema
- } from 'XrFrame/loader/AssetLoader'
- import { IAssetLoadData } from 'XrFrame/loader/types'
- export interface IAtlasSource {
- meta: {
- image: string
- size: {
- w: number
- h: number
- }
- }
- frames: {
- [key: string]: {
- frame: {
- x: number
- y: number
- w: number
- h: number
- }
- spriteSourceSize: {
- x: number
- y: number
- w: number
- h: number
- }
- sourceSize: {
- w: number
- h: number
- }
- }
- }
- }
- export interface IAtlasLoaderOptions {}
- type IAtlasLoadData = IAssetLoadData<IAtlasLoaderOptions>
- /**
- * 图集资源{@link Atlas}的加载器。
- * @version 2.27.1
- *
- * 推荐使用[Shoebox](https://www.renderhjs.net/shoebox/)生成。
- */
- export default class AtlasLoader extends AssetLoader<
- Atlas,
- IAtlasLoaderOptions
- > {
- readonly schema: ILoaderOptionsSchema
- load(
- params: IAtlasLoadData,
- callbacks: {
- onLoading(progress: number): void
- onLoaded(value: Atlas): void
- onError(error: Error): void
- }
- ): Promise<void>
- getBuiltin(): Array<{
- assetId: string
- src: string
- options: IAtlasLoaderOptions
- }>
- }
- export {}
- }
- declare module 'XrFrame/loader/types' {
- /**
- * types.ts
- *
- * * @Date : 2022/4/1下午2:19:33
- */
- type Assets = import('XrFrame/components/Assets').default
- export function isAsset(value: any): value is IAssetWithState<any>
- export enum EAssetState {
- Undefined = 0,
- Defer = 1,
- Loading = 2,
- Existed = 3
- }
- export interface IAssetWithState<T> {
- __isAsset: boolean
- __params?: IAssetLoadData
- __group?: Assets
- value?: T
- state: EAssetState
- promise?: Promise<IAssetWithState<T>>
- }
- /**
- * {@link AssetLoad}组件数据接口。
- */
- export interface IAssetLoadData<T = any> {
- /**
- * 资源类型,必须是使用{@link registerAssetLoader}中注册过的类型。
- * `xml`中数据为`string`类型。
- */
- type: string
- /**
- * 资源Id。
- * `xml`中数据为`string`类型。
- */
- assetId: string
- /**
- * 资源地址。
- * `xml`中数据为`string`类型。
- */
- src: string
- /**
- * 资源权重,用于在同一批加载的资源的`progress`事件中计算进度,详见{@link Assets}。
- * `xml`中数据为`number`类型。
- */
- weight?: number
- /**
- * 资源追加配置,视资源类型而定。
- * `xml`中数据为`dict`类型。
- */
- options: T
- /**
- * 是否要按需延迟加载,如果开启,则只有在资源被实际引用时才会被加载。
- * `xml`中数据为`boolean`类型。
- */
- defer?: boolean
- /**
- * @internal
- */
- canceled?: boolean
- /**
- * @internal
- */
- startTs?: number
- /**
- * 加载时长(s),仅用于统计。
- */
- duration?: number
- /**
- * 当前加载进度。
- */
- progress?: number
- }
- export {}
- }
- declare module 'XrFrame/animation/NativeAnimation' {
- import { Kanata } from 'XrFrame/ext'
- import Animation, { TDirection } from 'XrFrame/animation/Animation'
- import Element from 'XrFrame/core/Element'
- export enum ENativeAnimationSimulatorType {
- None = 0,
- Morph = 1
- }
- export interface INativeAnimationData {
- clip: Kanata.AnimationClipModel
- bindings: Kanata.Entity3D[]
- frameCount: number
- names: string[]
- simulators?: Array<{
- type: ENativeAnimationSimulatorType
- target: Element
- subElements: Element[]
- }>
- }
- export const DefaultNativeAnimationFPS = 60
- /**
- * 使用客户端加速的动画片段,通常由gltf实例化而来,仅供内部使用。
- */
- export default class NativeAnimation extends Animation<INativeAnimationData> {
- onInit(data: INativeAnimationData): void
- onPlay(
- el: Element,
- clipName: string,
- options: any
- ): {
- duration: number
- loop?: number
- delay?: number
- direction?: TDirection
- }
- onUpdate(el: Element, progress: number, reverse: boolean): void
- }
- }
- declare module 'XrFrame/loader/glTF/GLTFRootNode' {
- import GLTFAnimationsNode, {
- GLTFAnimationsLoaded,
- GLTFAnimationsNodeRaw
- } from 'XrFrame/loader/glTF/animations/GLTFAnimationsNode'
- import GLTFAccessorsNode, {
- GLTFAccessorsNodeRaw
- } from 'XrFrame/loader/glTF/buffers/GLTFAccessorsNode'
- import GLTFBuffersNode, {
- GLTFBuffersNodeRaw
- } from 'XrFrame/loader/glTF/buffers/GLTFBuffersNode'
- import GLTFBufferViewsNode, {
- GLTFBufferViewsNodeRaw
- } from 'XrFrame/loader/glTF/buffers/GLTFBufferViewsNode'
- import { GLTFExtensionsProfiles } from 'XrFrame/loader/glTF/extensions/GLTFExtensions'
- import GLTFMeshesNode, {
- GLTFMeshesLoaded,
- GLTFMeshesNodeRaw
- } from 'XrFrame/loader/glTF/geometry/GLTFMeshesNode'
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import GLTFMaterialsNode, {
- GLTFMaterialsLoaded,
- GLTFMaterialsNodeRaw
- } from 'XrFrame/loader/glTF/materials/GLTFMaterialsNode'
- import GLTFNodesNode, {
- GLTFNodesLoaded,
- GLTFNodesNodeRaw
- } from 'XrFrame/loader/glTF/scenes/GLTFNodesNode'
- import { GLTFSceneLoaded } from 'XrFrame/loader/glTF/scenes/GLTFSceneNode'
- import GLTFScenesNode, {
- GLTFScenesLoaded,
- GLTFScenesNodeRaw
- } from 'XrFrame/loader/glTF/scenes/GLTFScenesNode'
- import GLTFSkinsNode, {
- GLTFSkinsLoaded,
- GLTFSkinsNodeRaw
- } from 'XrFrame/loader/glTF/skins/GLTFSkinsNode'
- import GLTFImagesNode, {
- GLTFImagesNodeRaw
- } from 'XrFrame/loader/glTF/textures/GLTFImagesNode'
- import GLTFSamplersNode, {
- GLTFSamplersLoaded,
- GLTFSamplersNodeRaw
- } from 'XrFrame/loader/glTF/textures/GLTFSamplersNode'
- import GLTFTexturesNode, {
- GLTFTexturesLoaded,
- GLTFTexturesNodeRaw
- } from 'XrFrame/loader/glTF/textures/GLTFTexturesNode'
- import { EValidation } from 'XrFrame/loader/glTF/utils/exceptions'
- type Scene = import('XrFrame/core/Scene').default
- export interface GLTFRootNodeRaw {
- buffers?: GLTFBuffersNodeRaw
- bufferViews?: GLTFBufferViewsNodeRaw
- accessors?: GLTFAccessorsNodeRaw
- images?: GLTFImagesNodeRaw
- samplers?: GLTFSamplersNodeRaw
- textures?: GLTFTexturesNodeRaw
- materials?: GLTFMaterialsNodeRaw
- meshes?: GLTFMeshesNodeRaw
- nodes?: GLTFNodesNodeRaw
- scenes?: GLTFScenesNodeRaw
- skins?: GLTFSkinsNodeRaw
- animations?: GLTFAnimationsNodeRaw
- scene?: number
- extensions?: object
- extensionsRequired?: string[]
- extensionsUsed?: string[]
- }
- export interface GLTFRootLoaded {
- samplers: GLTFSamplersLoaded
- textures: GLTFTexturesLoaded
- materials: GLTFMaterialsLoaded
- meshes: GLTFMeshesLoaded
- nodes: GLTFNodesLoaded
- scenes: GLTFScenesLoaded
- scene: GLTFSceneLoaded
- skins: GLTFSkinsLoaded
- animations: GLTFAnimationsLoaded
- }
- export interface GLTFDesc {
- raw: object
- scene: Scene
- uri?: string
- ignoreError?: number[]
- extensionProfiles?: GLTFExtensionsProfiles
- defaultBinary?: ArrayBuffer
- }
- export default class GLTFRootNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFRootNodeRaw
- readonly uri: string
- readonly defaultBinary: ArrayBuffer | null
- nodesCollector: {
- [path: string]: GLTFBaseNode[]
- }
- extensionProfiles: GLTFExtensionsProfiles
- extensionGlobals: {
- [name: string]: object
- }
- resource: GLTFRootLoaded | null
- buffersNode: GLTFBuffersNode | undefined
- bufferViewsNode: GLTFBufferViewsNode | undefined
- accessorsNode: GLTFAccessorsNode | undefined
- imagesNode: GLTFImagesNode | undefined
- samplersNode: GLTFSamplersNode | undefined
- texturesNode: GLTFTexturesNode | undefined
- materialsNode: GLTFMaterialsNode | undefined
- meshesNode: GLTFMeshesNode | undefined
- nodesNode: GLTFNodesNode | undefined
- scenesNode: GLTFScenesNode | undefined
- skinsNode: GLTFSkinsNode | undefined
- animationsNode: GLTFAnimationsNode | undefined
- ignoreError: {
- [errorType in EValidation]?: true
- }
- constructor(desc: GLTFDesc)
- build(): void
- preload(
- reportProgress?: (progress: number) => void
- ): Promise<GLTFRootLoaded>
- getLoadedResource(): GLTFRootLoaded
- getNodesByPath(path: string): GLTFBaseNode[]
- getRootExtensionRaw(extName: string): object | undefined
- /**
- * 在preload完之后可以调用这个函数,会把原始buffer的引用都释放掉。
- * 每个子节点的raw也会释放掉(以防数据是dataURI的形式)。
- */
- releaseRawBuffer(): void
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/scenes/GLTFNodesNode' {
- import { GLTFArrayNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import GLTFNodeNode, {
- GLTFNodeLoaded,
- GLTFNodeNodeRaw,
- GLTFNodePrerequisites
- } from 'XrFrame/loader/glTF/scenes/GLTFNodeNode'
- type ChildNode = GLTFNodeNode
- export type GLTFNodesNodeRaw = GLTFNodesNodeRaw[]
- export type GLTFTreeNode = {
- data: GLTFNodeLoaded
- children: GLTFTreeNode[]
- parent: GLTFTreeNode | null
- index: number
- extensions?: object
- }
- export type GLTFNodesLoaded = GLTFTreeNode[]
- export default class GLTFNodesNode extends GLTFArrayNode<ChildNode> {
- ChildCtor(childRaw: GLTFNodeNodeRaw): GLTFNodeNode
- readonly raw: GLTFNodesNodeRaw
- get nodeName(): string
- res: GLTFNodesLoaded
- preload(prerequisites: GLTFNodePrerequisites): Promise<GLTFNodesLoaded>
- getLoadedResource(): GLTFNodesLoaded
- }
- export {}
- }
- declare module 'XrFrame/physics/RaycastHit' {
- import Shape from 'XrFrame/components/physics/Shape'
- import { Scene } from 'XrFrame/elements'
- import Vector3 from 'XrFrame/math/vector3'
- export default class RaycastHit {
- constructor(scene: Scene, nativeComp?: phys3D.RaycastHit)
- /**
- * @internal
- * native层真正的raycastHit对象,业务侧无需关心
- */
- get nativeRaycastHit(): phys3D.RaycastHit
- /**
- * 与射线相交的Shape。
- */
- get shape(): Shape<any>
- /**
- * 从射线的原点到碰撞点的距离。
- */
- get distance(): number
- set distance(v: number)
- /**
- * 射线与轮廓的交点表面的法线。
- */
- get normal(): Vector3
- set normal(v: Vector3)
- /**
- * 在世界空间中,射线与轮廓的交点。
- */
- get point(): Vector3
- set point(v: Vector3)
- }
- }
- declare module 'XrFrame/physics/Collision' {
- import Shape from 'XrFrame/components/physics/Shape'
- import ContactPoint, { IContactPoint } from 'XrFrame/physics/ContactPoint'
- import { Vector3ReadOnly } from 'XrFrame/math/vector3'
- const collisionMap: WeakMap<phys3D.Collision, Collision>
- export { collisionMap }
- /**
- * 物理碰撞事件(collide-begin等)的信息。
- * @category Physics
- * @readonly
- */
- export interface ICollideEvent {
- /**
- * 从碰撞到分离所用的冲量之和。
- */
- readonly impulse: Vector3ReadOnly
- /**
- * 两个刚体的相对线性碰撞速度。
- */
- readonly relativeVelocity: Vector3ReadOnly
- /**
- * 发生碰撞的另一个轮廓。
- */
- readonly shape: Shape
- /**
- * 本次碰撞的接触点。
- */
- readonly contacts: IContactPoint[]
- }
- /**
- * 物理重叠事件(overlap-begin等)的信息。
- * @category Physics
- * @readonly
- */
- export interface IOverlapEvent {
- /**
- * 重叠的另一个轮廓。
- */
- readonly shape: Shape
- }
- export default class Collision implements ICollideEvent {
- constructor(native: phys3D.Collision)
- get impulse(): Vector3ReadOnly
- get relativeVelocity(): Vector3ReadOnly
- get shape(): Shape<any>
- get contacts(): ContactPoint[]
- }
- }
- declare module 'XrFrame/physics/ContactPoint' {
- import Shape from 'XrFrame/components/physics/Shape'
- import { Vector3ReadOnly } from 'XrFrame/math/vector3'
- const contactPointMap: WeakMap<phys3D.ContactPoint, ContactPoint>
- export { contactPointMap }
- /**
- * 物理事件返回的{@link ICollideEvent | 碰撞信息}中的碰撞点。
- * @category Physics
- */
- export interface IContactPoint {
- /**
- * 在该碰撞点处,两个物体的距离。
- *
- * 不一定是0或小于0,因为只要两个物体的距离小于{@link Collider.contactOffset}之和,就会判定为碰撞。
- */
- readonly separation: number
- /**
- * 碰撞平面的法线。
- */
- readonly normal: Vector3ReadOnly
- /**
- * 碰撞点的位置。
- */
- readonly point: Vector3ReadOnly
- /**
- * 接收碰撞事件的轮廓。
- */
- readonly thisShape: Shape
- /**
- * 另一个轮廓。
- */
- readonly otherShape: Shape
- }
- export default class ContactPoint implements IContactPoint {
- get separation(): number
- get normal(): Vector3ReadOnly
- get point(): Vector3ReadOnly
- get thisShape(): Shape<any>
- get otherShape(): Shape<any>
- constructor(native: phys3D.ContactPoint)
- }
- }
- declare module 'XrFrame/physics/raycast' {
- import Vector3 from 'XrFrame/math/vector3'
- import RaycastHit from 'XrFrame/physics/RaycastHit'
- /**
- * raycast函数的参数。
- * @field origin 射线起点。
- * @field unitDir 射线方向(单位向量)。
- * @field distance 射线的最大长度。
- * @field hit 用来接收碰撞信息的容器。
- * @field layerMask 可以用来屏蔽一些物体。
- * @field (未实现)queryTriggerInteraction,是否能与Trigger相交(默认能)。
- */
- export type RaycastDesc = {
- origin: Vector3
- unitDir: Vector3
- distance?: number
- hit?: RaycastHit
- layerMask?: number
- }
- /**
- * 射线检测,判断给定射线是否与至少一个碰撞体相交,并返回与**最近**的那个碰撞体相交的信息。
- */
- export function raycast(
- Phys3D: typeof phys3D,
- system: phys3D.PhysSystem,
- desc: RaycastDesc
- ): boolean
- }
- declare module 'XrFrame/kanata/lib/frontend' {
- import MeshRendererComponent from 'XrFrame/kanata/lib/frontend/component/MeshRendererComponent'
- import renderEnv from 'XrFrame/kanata/lib/frontend/resource/renderEnv'
- export { RenderEnv } from 'XrFrame/kanata/lib/frontend/resource/renderEnv'
- export { default as AnimatorComponent } from 'XrFrame/kanata/lib/frontend/component/AnimatorComponent'
- export { default as CameraComponent } from 'XrFrame/kanata/lib/frontend/component/CameraComponent'
- export { default as LightCameraComponent } from 'XrFrame/kanata/lib/frontend/component/LightCameraComponent'
- export { default as CullingComponent } from 'XrFrame/kanata/lib/frontend/component/CullingComponent'
- export { default as MeshRendererComponent } from 'XrFrame/kanata/lib/frontend/component/MeshRendererComponent'
- export { default as SkinnedSkeletonComponent } from 'XrFrame/kanata/lib/frontend/component/SkinnedSkeletonComponent'
- export { default as DynamicBonesComponent } from 'XrFrame/kanata/lib/frontend/component/DynamicBonesComponent'
- export { default as Entity2D } from 'XrFrame/kanata/lib/frontend/entity/Entity2D'
- export { default as Entity3D } from 'XrFrame/kanata/lib/frontend/entity/Entity3D'
- export { default as AnimationClipModel } from 'XrFrame/kanata/lib/frontend/resource/AnimationClipModel'
- export { default as AnimationClipBinding } from 'XrFrame/kanata/lib/frontend/resource/AnimationClipBinding'
- export { default as AnimatorControllerModel } from 'XrFrame/kanata/lib/frontend/resource/AnimatorControllerModel'
- export { default as AnimatorControllerStateModel } from 'XrFrame/kanata/lib/frontend/resource/AnimatorControllerStateModel'
- export { default as DataBuffer } from 'XrFrame/kanata/lib/frontend/resource/DataBuffer'
- export { default as DataModel } from 'XrFrame/kanata/lib/frontend/resource/DataModel'
- export { default as Effect } from 'XrFrame/kanata/lib/frontend/resource/Effect'
- export { default as Material } from 'XrFrame/kanata/lib/frontend/resource/Material'
- export {
- default as RenderPass,
- IRenderPassOptions
- } from 'XrFrame/kanata/lib/frontend/resource/RenderPass'
- export { default as SkeletonBoneInverseModel } from 'XrFrame/kanata/lib/frontend/resource/SkeletonBoneInverseModel'
- export {
- default as Texture,
- ITextureOptions
- } from 'XrFrame/kanata/lib/frontend/resource/Texture'
- export { default as UniformBlock } from 'XrFrame/kanata/lib/frontend/resource/UniformBlock'
- export { default as UniformDescriptor } from 'XrFrame/kanata/lib/frontend/resource/UniformDescriptor'
- export { default as IndexBuffer } from 'XrFrame/kanata/lib/frontend/resource/IndexBuffer'
- export { default as IndexData } from 'XrFrame/kanata/lib/frontend/resource/IndexData'
- export { default as VertexBuffer } from 'XrFrame/kanata/lib/frontend/resource/VertexBuffer'
- export { default as VertexData } from 'XrFrame/kanata/lib/frontend/resource/VertexData'
- export { default as VertexLayout } from 'XrFrame/kanata/lib/frontend/resource/VertexLayout'
- export { default as VertexDataDescriptor } from 'XrFrame/kanata/lib/frontend/resource/VertexDataDescriptor'
- export { default as View } from 'XrFrame/kanata/lib/frontend/resource/View'
- export { default as ScalableList } from 'XrFrame/kanata/lib/frontend/resource/ScalableList'
- export { default as crossContext } from 'XrFrame/kanata/lib/frontend/shared/crossContext'
- const IS_VALID: () => boolean,
- GET_MAIN_CANVAS: () => HTMLCanvasElement,
- Image: {
- new (): import('XrFrame/kanata/lib/backend').IImage
- IS(obj: any): obj is import('XrFrame/kanata/lib/backend').IImage
- },
- Phys3D: any
- const downloader: import('XrFrame/kanata/lib/backend').IDownloader
- export { renderEnv }
- export {
- Image,
- downloader as Downloader,
- IS_VALID,
- GET_MAIN_CANVAS,
- Phys3D
- }
- export const createWeakRef: <T>(wrapper: T) => {
- deref: () => T
- }
- export const createWeakRefSentry: () => any
- export const createNativeUUMap: () => import('XrFrame/kanata/lib/backend').INativeMap<number>
- export const createNativeSUMap: () => import('XrFrame/kanata/lib/backend').INativeMap<string>
- export const createNativeULUMap: () => import('XrFrame/kanata/lib/backend').ILongIntNativeMap
- export const loadTTFFont: (
- url: string,
- callback: (font: string) => void
- ) => void
- export const getGlyphInfo: (
- fontSetting: import('XrFrame/kanata/lib/backend').IFontSetting,
- charCode: number
- ) => import('XrFrame/kanata/lib/backend').IGlyphInfo
- export const refreshNodesWorldTransform: () => void
- export const setGlobalPhysicSystem: (system: any) => void
- export const bindRigidBodyToNode: (rigidBody: any, nodeId: number) => void
- export const bindCCTToNode: (cc: any, nodeId: number) => void
- export const unbindRigidBody: (rigidBody: any) => void
- export const unbindCCT: (cc: any) => void
- export const decodeBase64: (base64: string) => ArrayBuffer
- export const initDraco: () => Promise<void>
- export const decodeDraco: (
- buffer: ArrayBuffer | ArrayBufferView,
- decodeType: import('XrFrame/kanata/lib/backend').EDracoDecodeType
- ) => import('XrFrame/kanata/lib/backend').DracoDecoded
- export function destroy(): void
- export function update(delta: number): void
- export const setNodeName: (id: number, name: string) => void
- export const setRenderComponentName: (
- comp: MeshRendererComponent,
- name: string
- ) => void
- export const debugPrint: (msg: string) => void
- export const eventBridge: {
- bindEntityToBone: any
- unbindEntityFromBone: any
- bindEntitiesToBones: any
- unbindEntitiesFromBones: any
- }
- }
- declare module 'XrFrame/kanata/lib/backend/interface' {
- /**
- * index.ts
- *
- * * @Date : 2020/8/18 下午4:48:36
- */
- export interface IEngineSettings {
- /** log过滤器 */
- logFilter: boolean
- /** log等级 */
- logLevel: string
- /** 最大缓存极限 */
- cacheSizeLimit: number
- /** 是否开启MSAA */
- realSizeLimit: number
- /** 设计分辨率宽 */
- designWidth: number
- /** 设计分辨率高 */
- designHeight: number
- /** 渲染分辨率宽 */
- renderWidth: number
- /** 渲染分辨率高 */
- renderHeight: number
- /** 是否开启MSAA */
- mainScreenMSAA: boolean
- /** 是否开启透明通道输出 */
- alpha?: boolean
- /** loader下载文件的默认根路径 */
- baseURL: string
- /** 如果baseURL找不到并且重试次数`globalHTTPRetry`大于0,则会依次尝试使用 */
- backupURLs: string[]
- /** 全局loader下载文件重试次数 */
- globalHTTPRetry: string
- /** 物理引擎的重力 */
- gravity: number
- /** 物理引擎的模拟步进固定间隔 */
- fixedDeltaTime: number
- useEngineSubcontext: boolean
- /** 物理碰撞矩阵,以十六进制字符串表示 */
- physics3DLayerCollisionMatrix: string
- /** 拼缓存的文件名的 */
- cacheDelimiter: string
- /** 自动生成的worker文件入口路径 */
- workerPath: string
- /** worker执行任务超时时间 */
- workerTimeout: number
- gfxIgnoreAssert: boolean
- profileGfx: string
- /** 全局Uniform定义 */
- shaderGlobalProperties: Array<{
- key: string
- type:
- | 'Float'
- | 'Vector2'
- | 'Vector3'
- | 'Vector4'
- | 'Matrix4'
- | 'Texture'
- default: number | number[] | string
- }>
- /** 音频全局定义 */
- audio?: {
- /** 全局音量 */
- globalVolume?: number
- /** 真实音频数量上限 */
- maxRealVoices?: number
- }
- }
- /**
- * 顶点数据格式枚举。
- */
- export enum EVertexFormat {
- FLOAT = 0,
- FLOAT2 = 1,
- FLOAT3 = 2,
- FLOAT4 = 3,
- BYTE4 = 4,
- BYTE4N = 5,
- UBYTE4 = 6,
- UBYTE4N = 7,
- SHORT2 = 8,
- SHORT2N = 9,
- SHORT4 = 10,
- SHORT4N = 11,
- UINT10_N2 = 12
- }
- /**
- * 顶点数据步进类型枚举。
- */
- export enum EVertexStep {
- /**
- * 逐顶点。
- */
- PER_VERTEX = 0,
- /**
- * 在使用Instance的情况下,逐实例。
- */
- PER_INSTANCE = 1
- }
- /**
- * 索引数据类型。
- */
- export enum EIndexType {
- /**
- * 无效值。
- */
- NONE = 1,
- /**
- * 16位索引。
- */
- UINT16 = 2,
- /**
- * 32位索引,注意在某些设备上不支持。
- */
- UINT32 = 3
- }
- /**
- * 压缩纹理类型。
- */
- export type TCompressTexture = 'etc1' | 'etc2' | 'astc' | 'pvrtc' | 's3tc'
- /**
- * 纹理类型雷剧。
- */
- export enum ETextureType {
- /**
- * 2D纹理。
- */
- D2 = 0,
- /**
- * 立方体纹理。
- */
- Cube = 1,
- /**
- * 2D纹理数组。
- */
- D2Array = 2,
- /**
- * 3D纹理。
- */
- D3 = 3
- }
- /**
- * 纹理格式枚举。
- */
- export enum ETextureFormat {
- /** Inputs or Render Target Formats. */
- RGBA8 = 0,
- SRGBA8 = 1,
- RGB10A2 = 2,
- RG8 = 3,
- R8 = 4,
- RGBA32F = 5,
- RGBA16F = 6,
- RG11B10F = 7,
- RGB8 = 8,
- RGB16F = 9,
- RGB32F = 10,
- /** Render Target Only. */
- Depth_Low = 20,
- Depth_High = 21,
- Depth_Stencil = 22,
- RGBA4 = 23,
- RGB565 = 24,
- RGB5A1 = 25,
- /** Compresseds */
- ETC1RGB8 = 100,
- ETC2RGB8 = 110,
- ETC2RGBA8 = 111,
- PVRTC2RGBV1 = 120,
- PVRTC4RGBV1 = 121,
- PVRTC2RGBAV1 = 122,
- PVRTC4RGBAV1 = 123,
- ASTC4x4 = 140,
- ASTC5x5 = 141,
- ASTC6x6 = 142,
- ASTC8x6 = 143,
- ASTC8x8 = 144,
- DXT1 = 150,
- DXT3 = 151,
- DXT5 = 152
- }
- /**
- * 纹理寻址模式枚举。
- */
- export enum EWrapMode {
- REPEAT = 1,
- CLAMP_TO_EDGE = 2,
- MIRRORED_REPEAT = 3
- }
- /**
- * 纹理过滤模式枚举。
- */
- export enum EFilterMode {
- NEAREST = 1,
- LINEAR = 2,
- NEAREST_MIPMAP_NEAREST = 3,
- NEAREST_MIPMAP_LINEAR = 4,
- LINEAR_MIPMAP_NEAREST = 5,
- LINEAR_MIPMAP_LINEAR = 6
- }
- /**
- * Uniform值得类型枚举。
- */
- export enum EUniformType {
- FLOAT = 0,
- FLOAT2 = 1,
- FLOAT3 = 2,
- FLOAT4 = 3,
- MAT2 = 4,
- MAT3 = 5,
- MAT4 = 6,
- SAMPLER = 7
- }
- /**
- * 背面剔除类型枚举。
- */
- export enum ECullMode {
- NONE = 0,
- FRONT = 1,
- BACK = 2
- }
- /**
- * 正面顶点绕序枚举。
- */
- export enum EFaceWinding {
- CCW = 1,
- CW = 2
- }
- /**
- * 各种测试的比较函数枚举。
- */
- export enum ECompareFunc {
- LESS = 1,
- LEQUAL = 2,
- EQUAL = 3,
- GEQUAL = 4,
- GREATER = 5,
- NOTEQUAL = 6,
- NEVER = 7,
- ALWAYS = 8
- }
- /**
- * 模板测试操作枚举。
- */
- export enum EStencilOp {
- ZERO = 0,
- KEEP = 1,
- REPLACE = 2,
- INCR_WRAP = 3,
- INCR = 4,
- DECR_WRAP = 5,
- DECR = 6,
- INVERT = 7
- }
- /**
- * 混合因子枚举。
- */
- export enum EBlendFactor {
- ZERO = 0,
- ONE = 1,
- SRC_COLOR = 2,
- ONE_MINUS_SRC_COLOR = 3,
- SRC_ALPHA = 4,
- ONE_MINUS_SRC_ALPHA = 5,
- DST_ALPHA = 6,
- ONE_MINUS_DST_ALPHA = 7,
- DST_COLOR = 8,
- ONE_MINUS_DST_COLOR = 9,
- SRC_ALPHA_SATURATE = 10,
- CONSTANT_COLOR = 11,
- ONE_MINUS_CONSTANT_COLOR = 12
- }
- /**
- * 混合方式枚举。
- */
- export enum EBlendEquation {
- FUNC_ADD = 0,
- FUNC_SUBTRACT = 1,
- FUNC_REVERSE_SUBTRACT = 2,
- MIN = 3,
- MAX = 4
- }
- /**
- * 颜色通道掩码枚举。
- */
- export enum EColorMask {
- /**
- * 将会禁掉所有通道的输出。
- */
- NONE = 16,
- R = 1,
- G = 2,
- B = 4,
- A = 8,
- RGB = 7,
- RGBA = 15
- }
- /**
- * 像素数据类型枚举。
- */
- export enum EPixelType {
- UNSIGNED_BYTE = 5121,
- FLOAT = 5126,
- UNSIGNED_SHORT_5_6_5 = 33635,
- UNSIGNED_SHORT_4_4_4_4 = 32819,
- UNSIGNED_SHORT_5_5_5_1 = 32820
- }
- /**
- * 清屏操作枚举。
- */
- export enum ELoadAction {
- /**
- * 清除屏幕颜色。
- */
- CLEAR = 0,
- /**
- * 不清屏,但依赖前面渲染的结果。
- */
- LOAD = 1,
- /**
- * 完全不关心是否清屏。
- */
- DONTCARE = 2
- }
- export enum EDataModelType {
- AnimationClip = 1,
- SkeletonBoneInverse = 2
- }
- /**
- * 渲染组件类型枚举。
- */
- export enum EMeshRenderType {
- /**
- * 未知类型。
- */
- UnKnown = 0,
- /**
- * 静态3D类型。
- */
- Static3D = 1,
- /**
- * 蒙皮3D类型。
- */
- Skinned3D = 2,
- /**
- * UI类型。
- */
- UI = 3
- }
- /**
- * 图元渲染类型枚举。
- */
- export enum EPrimitiveType {
- TRIANGLES = 0,
- TRIANGLE_STRIP = 1,
- LINES = 2,
- LINE_STRIP = 3,
- POINTS = 4,
- ZERO = 5
- }
- /**
- * 阴影类型枚举。
- */
- export enum EShadowMode {
- /**
- * 关闭阴影。
- */
- None = 0,
- /**
- * 开启单级联阴影,并开启PCF。
- */
- OneCascade_PCF = 1,
- /**
- * 开启二级联阴影,并开启PCF。
- */
- TwoCascade_PCF = 2,
- /**
- * 开启四级联阴影,并开启PCF。
- */
- FourCascade_PCF = 4,
- /**
- * 开启单级联阴影,并开启PCSS。
- */
- PCSS = 5
- }
- /**
- * 阴影匹配类型枚举。
- */
- export enum EShadowFitMode {
- /**
- * 阴影范围适配视锥体。
- * 更稳定,可能降低阴影精度。
- */
- FitFrustum = 0,
- /**
- * 阴影范围适配物体。
- * 能提高阴影精度,但可能会导致阴影不稳定。
- */
- FitObjects = 1
- }
- /**
- * 顶点数据布局用途枚举。
- */
- export enum EVertexLayoutUsage {
- CUSTOM = 0,
- POSITION = 1,
- NORMAL = 2,
- TANGENT = 3,
- UV0 = 4,
- UV1 = 5,
- UV2 = 6,
- UV3 = 7,
- COLOR = 8,
- BONEINDEX = 9,
- BONEWEIGHT = 10
- }
- /**
- * 动态合批操作符枚举。
- */
- export enum EVertexBatchOperator {
- /**
- * 矩阵乘法。
- */
- MatrixMultiple = 0,
- /**
- * Scale offset。
- */
- UVST = 1
- }
- export enum EAnimationBlendType {
- Override = 0,
- Additive = 1
- }
- export enum EUseDefaultAddedAction {
- Ignore = 0,
- Refresh = 1
- }
- export enum EUseDefaultRetainedAction {
- Keep = 0,
- Refresh = 1,
- WriteBack = 2
- }
- export enum EUseDefaultRemovedAction {
- Keep = 0,
- Clear = 1,
- WriteBack = 2
- }
- export enum ESkinnedSkeletonFlag {
- Use3x4Matrix = 1,
- UseTextureMatrix = 2
- }
- export const RENDER_ENV_OFFSETS: {
- size: number
- resetFlag: number
- renderPass: number
- canvasWidth: number
- canvasHeight: number
- uniforms: number
- useInstanceOrNeverTranspose: number
- }
- export const POOL_SUB_ID_MASK = 65472
- export const POOL_SUB_ID_SHIT = 6
- export const ENTITY2D_OFFSETS: {
- size: number
- rotation: number
- position: number
- scale: number
- worldMatrix: number
- }
- export const ENTITY3D_OFFSETS: {
- size: number
- dfRotationType: number
- rotationType: number
- rotation: number
- position: number
- scale: number
- worldOffset: number
- worldMatrix: number
- }
- export const ENTITY3D_EXT_OFFSETS: {
- size: number
- layer: number
- mixedLayerMask: number
- }
- export const CULLING_OFFSETS: {
- size: number
- active: number
- dfActive: number
- layer: number
- boundingBallCenter: number
- boundingBallRadius: number
- entityId: number
- }
- export const CAMERA_OFFSETS: {
- size: number
- view: number
- depth: number
- active: number
- fov: number
- aspect: number
- near: number
- far: number
- up: number
- eye: number
- orthoSize: number
- isProjection: number
- cullingMask: number
- canvasSizeY: number
- targetTransform: number
- viewMatrix: number
- projectionMatrix: number
- viewMatrixInverse: number
- viewMatrix2D: number
- projectionMatrix2D: number
- viewMatrixInverse2D: number
- manualMatrix: number
- layerCullDistances: number
- }
- export const LIGHT_OFFSETS: {
- size: number
- view: number
- depth: number
- active: number
- shadowDistance: number
- shadowMode: number
- shadowFilterMode: number
- lightDir: number
- bounds: number
- lightSpaceMatrices: number
- }
- export const MESH_OFFSETS: {
- dynamicBatch: number
- skinHandle: number
- castShadow: number
- bindTarget: number
- start: number
- size: number
- materialId: number
- vertexBufferId: number
- indexBufferId: number
- startIndex: number
- numIndices: number
- }
- export const EFFECT_OFFSETS: {
- size: number
- useMaterialStates: number
- fstencil: number
- bstencil: number
- blendRGBA: number
- colorDepth: number
- state: number
- }
- export const MATERIAL_OFFSETS: {
- size: number
- renderQueue: number
- effect: number
- uniformBlock: number
- fstencilMask: number
- bstencilMask: number
- blendRGBAMask: number
- colorDepthMask: number
- stateMask: number
- fstencil: number
- bstencil: number
- blendRGBA: number
- colorDepth: number
- state: number
- useInstance: number
- }
- export const SKINNED_SKELETON_OFFSETS: {
- boneInverseModelId: number
- boneIndices: number
- perBoneIndices: number
- perBoneEntityId: number
- perBoneMatrixOld: number
- perBoneMatrixNew: number
- }
- export const DYNAMIC_BONES_OFFSETS: {
- stiffness: number
- elasticity: number
- damping: number
- }
- export interface IHandle {
- id: number
- data?: ArrayBuffer
- destroy?: Function
- __feObj?: any
- }
- /**
- * 顶点布局解构初始化参数。
- */
- export interface IVertexLayoutOptions {
- /**
- * 顶点属性列表。
- */
- attributes: Array<{
- /**
- * 属性名字。
- */
- name: string
- /**
- * 属性名格式。
- */
- format: EVertexFormat
- /**
- * 属性在Buffer中的偏移量(字节)。
- */
- offset: number
- /**
- * 属性的用途。
- */
- usage: EVertexLayoutUsage
- }>
- /**
- * 步进类型。
- *
- * @default EVertexStep.PER_VERTEX
- */
- step?: EVertexStep
- /**
- * 步长,不设定会自动计算。
- */
- stride?: number
- /**
- * 步进单位。
- *
- * @default 1
- */
- stepRate?: number
- }
- /**
- * 动态合批描述符创建参数。
- */
- export interface IVertexDataDescriptorOptions {
- vuMap: Array<[string, string, EVertexBatchOperator?]>
- ignored?: string[]
- ubIndex?: number
- }
- /**
- * UniformBlock描述符创建参数。
- */
- export interface IUniformDescriptorOptions {
- /**
- * 名字。
- */
- name?: string
- /**
- * Uniform描述列表。
- */
- uniforms: Array<{
- /**
- * 名字。
- */
- name: string
- /**
- * 类型。
- */
- type: EUniformType
- /**
- * 长度。
- */
- num?: number
- /**
- * @deprecated
- */
- needTranspose?: boolean
- }>
- }
- /**
- * 引擎原生图片接口。
- */
- export interface IImage {
- /**
- * 是否要预乘Alpha。
- */
- premultiplyAlpha: boolean
- /**
- * 加载完成的回调。
- */
- onload: (() => void) | null
- /**
- * 出错的回调。
- */
- onerror: ((error: Error) => void) | null
- /**
- * @internal
- */
- buffer?: ArrayBuffer
- /**
- * 对于`ArrayBuffer`创建的图片,第一次使用后是否要自动释放内存,在`xr-frame`中,默认自动释放。
- */
- autoRelease?: boolean
- /**
- * 图片地址或者待解码的ArrayBuffer。
- */
- src: string | ArrayBuffer | ArrayBufferView
- /**
- * 图片源于ArrayBuffer时,传入的mimetype。
- */
- type?: string
- /**
- * 图片本地缓存地址,仅在微信内有用。
- */
- localPath?: string
- /**
- * 图片宽度。
- */
- width: number
- /**
- * 图片高度。
- */
- height: number
- /**
- * 解码数据,视不同Backend而定。
- */
- readonly data?: ArrayBuffer | HTMLImageElement
- }
- /**
- * 可用于纹理的资源。
- */
- export type TTextureSource = ArrayBuffer | ArrayBufferView | IImage
- /**
- * 外部需要注入的下载器接口。
- */
- export interface IRealDownloader {
- load: (options: {
- src: string
- encoding: 'binary' | 'utf-8' | undefined
- onLoad: (res: { data: ArrayBuffer, filePath: string }) => void
- onError: (error: Error) => void
- }) => void
- }
- /**
- * 下载器。
- */
- export interface IDownloader {
- inWX: boolean
- REAL_DOWNLOADER: IRealDownloader
- LOAD(options: Parameters<IRealDownloader['load']>[0]): void
- }
- /**
- * 字体配置。
- */
- export interface IFontSetting {
- fontFamily: string
- bold?: string
- italic?: string
- size?: number
- }
- /**
- * 渲染层提供的特性列表。
- */
- export interface IFeatures {
- /**
- * 是否支持GPU实例化。
- */
- gpuInstance: boolean
- /**
- * 是否支持3D动态合批。
- */
- dynamicBatch3D: boolean
- /**
- * 是否支持硬件SRGB解码。
- */
- srgb: boolean
- /**
- * 是否支持各向异性滤波。
- */
- textureAnisotropic: boolean
- /**
- * 是否支持浮点纹理。
- */
- textureFloat: boolean
- /**
- * 是否支持半精度浮点纹理。
- */
- textureHalfFloat: boolean
- /**
- * 是否支持浮点类型的颜色缓冲。
- */
- colorBufferFloat: boolean
- /**
- * 是否支持深度纹理。
- */
- depthTexture: boolean
- /**
- * 是否支持在片段着色器采样深度。
- */
- fragDepth: boolean
- }
- export interface IRect {
- x: number
- y: number
- w: number
- h: number
- }
- /**
- * 对一个View进行清屏的操作。
- */
- export interface IViewAction {
- /**
- * 颜色操作。
- */
- colorAction?: ELoadAction
- /**
- * 深度操作。
- */
- depthAction?: ELoadAction
- /**
- * 模板操作。
- */
- stencilAction?: ELoadAction
- /**
- * 用于清屏的颜色值。
- *
- * @default [0,0,0,0]
- */
- clearColor?: [number, number, number, number]
- /**
- * 用于清屏的深度值。
- *
- * @default 1
- */
- clearDepth?: number
- /**
- * 用于清屏的模板值。
- *
- * @default 0
- */
- clearStencil?: number
- }
- /**
- * 视图接口。
- */
- export interface IView {
- /**
- * 视图清屏操作。
- */
- passAction: IViewAction
- /**
- * 视图区域。
- */
- viewport: IRect
- /**
- * 裁剪区域。
- */
- scissor: IRect
- }
- /**
- * 附件接口。
- */
- export interface IAttachment {
- texture: IHandle
- level?: number
- slice?: number
- }
- /**
- * 渲染通道描述符。
- */
- export interface IRenderPassDescriptor {
- colors: IAttachment[]
- depth: IAttachment
- stencil: IAttachment
- }
- export enum EEventType {
- SetRootEntity = 1,
- AddChild = 2,
- AddChildAtIndex = 3,
- RemoveFromParent = 4,
- DisperseSubTree = 5,
- BindToBone = 6,
- BindToBones = 7,
- UnBindFromBone = 8,
- UnBindFromBones = 9,
- EntityCommandActive = 10,
- EntityCommandInActive = 11
- }
- export interface IGlyphInfo {
- code: number
- tex: number
- uv_x: number
- uv_y: number
- uv_w: number
- uv_h: number
- advance: number
- bearing_x: number
- bearing_y: number
- width: number
- height: number
- }
- export interface IEventBridge {
- entityAddChild(entity: number, child: number): void
- entityAddChildAtIndex(
- entity: number,
- child: number,
- index: number
- ): void
- entityRemoveFromParent(entity: number): void
- entityClear(entity: number): void
- entitySetActive(entity: number, active: boolean): void
- entitySetLocalMatrixDirty(entity: number): void
- setRootEntity(entity: number): void
- refreshWorldTransform(): void
- bindEntityToBone(
- entity: {
- id: number
- },
- boneEntity: {
- id: number
- }
- ): void
- unbindEntityFromBone(entity: { id: number }): void
- bindEntitiesToBones(
- entities: Array<{
- id: number
- }>,
- boneEntities: Array<{
- id: number
- }>
- ): void
- unbindEntitiesFromBones(
- entities: Array<{
- id: number
- }>
- ): void
- }
- export interface IRenderEnv extends IHandle {
- version?: string
- backendType: string
- registerFallbackEffect(lightMode: string, handle?: IHandle): void
- changeMacros(macros: {
- [name: string]: string | number | boolean
- }): void
- changeVirtualMacros(macros: { [name: string]: boolean }): void
- setInternalInstanceInfo(
- type: EMeshRenderType,
- info: Array<{
- uniformKey: string
- attributeName: string
- type: EUniformType
- }>,
- ignored: string[]
- ): void
- getErrors(): string[]
- supportCompressTextures: TCompressTexture[]
- features: IFeatures
- commit_version: string
- use_puppet_sokol: boolean
- }
- export interface INativeMap<T> {
- set(key: T, value: number): void
- get(key: T): number | undefined
- del(key: T): void
- }
- export interface ILongIntNativeMap {
- set(key1: number, key2: number, value: number): void
- get(key1: number, key2: number): number | undefined
- del(key1: number, key2: number): void
- }
- export type WeakRef = any
- export enum EDracoErrorCode {
- kDecodeErrorNone = 0,
- kDecodeErrorDecodeGeometryType = 1,
- kDecodeErrorDracoDecode = 2,
- kDecodeErrorAttributeEmpty = 3,
- kDecodeErrorAttributeSizeNotEqual = 4,
- kDecodeErrorDecodeTypeError = 5
- }
- export enum EDracoGeometryType {
- kGeometryTypeInvalid = -1,
- kGeometryTypeTriangleMesh = 0,
- kGeometryTypePointCloud = 1
- }
- export enum EDracoDecodeType {
- kDecodeTypeCross = 0
- }
- export enum EDracoDataType {
- DT_INVALID = 0,
- DT_INT8 = 1,
- DT_UINT8 = 2,
- DT_INT16 = 3,
- DT_UINT16 = 4,
- DT_INT32 = 5,
- DT_UINT32 = 6,
- DT_INT64 = 7,
- DT_UINT64 = 8,
- DT_FLOAT32 = 9,
- DT_FLOAT64 = 10,
- DT_BOOL = 11,
- DT_TYPES_COUNT = 12
- }
- export interface DracoDecoded {
- errCode: EDracoErrorCode
- buffer: ArrayBuffer
- geoType: EDracoGeometryType
- stride: number
- count: number
- numIndices: number
- attrs: Array<{
- numComponents: number
- dataType: EDracoDataType
- offset: number
- numBytes: number
- }>
- }
- }
- declare module 'XrFrame/kanata/lib/index' {
- /**
- * index.ts
- *
- * * @Date : 2020/8/18 下午4:48:36
- */
- export * from 'XrFrame/kanata/lib/frontend'
- export * from 'XrFrame/kanata/lib/backend/interface'
- export const VERSION = '1.0.4'
- const Puppet: any
- export { Puppet }
- /**
- * 根据数据,返回二维节点对应结构的Float32array
- */
- export function composeRawBufferEntity2D(
- rotation: number,
- position: ArrayLike<number>,
- scale: ArrayLike<number>
- ): Float32Array
- /**
- * 根据数据,返回三维节点对应结构的Float32array,除WorldMatrix。
- */
- export function composeRawBufferEntity3D(
- useEuler: boolean,
- rotation: ArrayLike<number>,
- position: ArrayLike<number>,
- scale: ArrayLike<number>
- ): Float32Array
- /**
- * 根据数据,返回三维节点对应结构的Float32array
- */
- export function composeRawBufferEntity3DWhole(
- useEuler: boolean,
- rotation: ArrayLike<number>,
- position: ArrayLike<number>,
- scale: ArrayLike<number>
- ): Float32Array
- }
- declare module 'XrFrame/components/text/types' {
- import { Kanata } from 'XrFrame/ext'
- import { IGlyph } from 'XrFrame/glyph'
- export interface IRenderData {
- vertexBuffer?: Kanata.VertexBuffer
- indexBuffer?: Kanata.IndexBuffer
- vertexNum?: number
- indiceNum?: number
- texture?: number
- }
- export interface ICharacterData {
- x: number
- y: number
- width: number
- height: number
- batchIndex: number
- character: string
- glyph: IGlyph
- }
- export enum EHorzAlignment {
- Left = 0,
- Center = 1,
- Right = 2
- }
- export enum EVertAlignment {
- Top = 0,
- Middle = 1,
- Bottom = 2
- }
- }
- declare module 'XrFrame/glyph' {
- export interface IGlyph {
- character?: string
- offsetX: number
- offsetY: number
- bearingX: number
- bearingY: number
- advance: number
- width: number
- height: number
- uvs: number[]
- texture: number
- }
- }
- declare module 'XrFrame/components/text/typesetting' {
- import {
- EHorzAlignment,
- EVertAlignment,
- ICharacterData
- } from 'XrFrame/components/text/types'
- import { IGlyph } from 'XrFrame/glyph'
- export function Typesetting(
- glyphs: IGlyph[],
- batchArrays: ICharacterData[][],
- batchIndexs: number[],
- wrapWidth: number,
- wrapHeight: number,
- lineHeight: number,
- anchor: number[],
- padding: number[],
- vertAlign: EVertAlignment,
- horzAlign: EHorzAlignment
- ): void
- }
- declare module 'XrFrame/components/text/fillRenderData' {
- import { ICharacterData } from 'XrFrame/components/text/types'
- export function FillRenderData(
- vertexF32: Float32Array,
- indexU16: Uint16Array,
- batchArray: ICharacterData[]
- ): void
- }
- declare module 'XrFrame/components/particle/ParticleInstance' {
- import {
- FactorGradient,
- ColorGradient
- } from 'XrFrame/components/particle/gradient'
- import Particle from 'XrFrame/components/particle/Particle'
- import Vector2 from 'XrFrame/math/vector2'
- import Vector3 from 'XrFrame/math/vector3'
- import Vector4 from 'XrFrame/math/vector4'
- export default class ParticleInstance {
- static count: number
- id: number
- position: Vector3
- direction: Vector3
- speed: number
- color: Vector4
- colorStep: Vector4
- rampPos: Vector4
- lifeTime: number
- age: number
- drag: number
- size: number
- startSize: number
- sizeGradientFactor: number
- scale: Vector2
- angle: number
- angularSpeed: number
- particleSystem: Particle
- currentSize: number
- currentSize2: number
- currentSizeGradient: FactorGradient
- currentColor: Vector4
- currentColor2: Vector4
- currentColorGradient: ColorGradient
- currentAlpha: number
- currentAlpha2: number
- currentAlphaGradient: FactorGradient
- currentSpeedScale: number
- currentSpeedScale2: number
- currentSpeedScaleGradient: FactorGradient
- currentLimitSpeed: number
- currentLimitSpeed2: number
- currentLimitSpeedGradient: FactorGradient
- currentDrag: number
- currentDrag2: number
- currentDragGradient: FactorGradient
- subEmitterMuster: any
- startSpriteCellIndex: number
- endSpriteCellIndex: number
- cellIndex: number
- randomCellOffset: any
- constructor(particle: Particle)
- /**
- * 重置粒子实例的状态。
- */
- reset(): void
- /**
- * 将当前粒子实例的状态拷贝到目标实例。
- * @param {ParticleInstance} other 目标粒子实例
- */
- copyTo(other: ParticleInstance): void
- /**
- * 更新从动画图集采样的帧序号
- */
- updateCellIndex(): void
- clamp(num: any, left?: number, right?: number): any
- }
- }
- declare module 'XrFrame/components/emitter/BasicShapeEmitter' {
- import Vector3 from 'XrFrame/math/vector3'
- import ParticleInstance from 'XrFrame/components/particle/ParticleInstance'
- import Matrix4 from 'XrFrame/math/matrix4'
- export abstract class BasicShapeEmitter {
- /**
- * keep normalized length
- */
- direction?: Vector3
- /**
- * keep normalized length
- */
- direction2?: Vector3
- abstract startDirection(
- worldMatrix: Matrix4,
- direction: Vector3,
- ...args: any[]
- ): void
- abstract startPosition(
- worldMatrix: Matrix4,
- position: Vector3,
- ...args: any[]
- ): void
- processInstance?(instance: ParticleInstance, deltaTime: number): void
- setProperty(properties: any): void
- }
- }
- declare module 'XrFrame/components/emitter' {
- import BoxShapeEmitter from 'XrFrame/components/emitter/BoxShapeEmitter'
- import PointShapeEmitter from 'XrFrame/components/emitter/PointShapeEmitter'
- import DrawShapeEmitter from 'XrFrame/components/emitter/DrawShapeEmitter'
- import SphereShapeEmitter from 'XrFrame/components/emitter/SphereShapeEmitter'
- import ConeShapeEmitter from 'XrFrame/components/emitter/ConeShapeEmitter'
- import CircleShapeEmitter from 'XrFrame/components/emitter/CircleShapeEmitter'
- export {
- BoxShapeEmitter,
- PointShapeEmitter,
- DrawShapeEmitter,
- SphereShapeEmitter,
- ConeShapeEmitter,
- CircleShapeEmitter
- }
- }
- declare module 'XrFrame/components/emitter/SubEmitter' {
- import Particle from 'XrFrame/components/particle/Particle'
- /**
- * 粒子子发射器的依附状态。
- */
- export const enum SubEmitterState {
- /**
- * 依附于粒子整个生命周期
- */
- ATTACH = 0,
- /**
- * 在粒子生命周期末出现
- */
- END = 1
- }
- export class SubEmitter {
- particleSystem: Particle
- state: SubEmitterState
- constructor(particleSystem: any)
- /**
- * 通过克隆,获取指定的粒子子发射器实例
- * @return {SubEmitter} 克隆后的子发射器实例
- */
- clone(): SubEmitter
- }
- }
- declare module 'XrFrame/physics/event' {
- import type Element from 'XrFrame/core/Element'
- /**
- * 物理{@link PhysicsDelegate | Delegate}注册的事件回调类型。
- * @category Physics
- * @template E 事件回调接收的参数类型。
- */
- export type DelegateHandler<E> = (e: E) => void
- /**
- * 挂在entity上的delegate, 不持有native comp,
- * 而是持有多个subDelegate, 通过这些subDelegate来invoke.
- * 主要作用是让script里可以直接写个onCollisionEnter()的函数来接收该节点下所有物理组件的事件.
- */
- export class SharedDelegate<E extends object> {
- add(handler: DelegateHandler<E>, context?: any): void
- remove(handler: DelegateHandler<E>): void
- invoke(e: E): void
- dispose(): void
- }
- /**
- * 用来注册回调并接收某个**特定**物理事件的Delegate。
- * @category Physics
- * @template E 事件回调接收的参数类型。
- * @see {@link Collider} {@link CharacterController}
- */
- export class Delegate<E extends object> {
- /**
- * @class 挂在物理组件上的Delegate, 内部持有native comp, 由native comp来invoke.
- */
- protected nativeMethod: string
- _shared?: SharedDelegate<E>
- /** @internal */
- isPhysicsDelegate: true
- protected xmlEvent: string
- protected _el: Element
- /** @internal */
- protected _handlers: Map<DelegateHandler<E>, any>
- /** @internal */
- constructor(
- nativeCollider: phys3D.Collider | undefined,
- nativeMethod: string,
- el: Element,
- xmlEvent: string
- )
- get nativeCollider(): phys3D.Collider | undefined
- set nativeCollider(v: phys3D.Collider | undefined)
- clearNativeHandler(): void
- /**
- * 注册事件回调。
- */
- add(
- handler: DelegateHandler<E>,
- context?: any
- ): DelegateHandler<E> | void
- /**
- * 移除已注册的事件回调。
- */
- remove(handler: DelegateHandler<E>): void
- /**
- * @internal
- */
- invoke(native: phys3D.ControllerColliderHit | phys3D.Collision): void
- /**
- * 移除所有事件回调。
- */
- clear(): void
- /**
- * @internal
- */
- dispose(): void
- set el(v: Element)
- xmlInvoker?: DelegateHandler<E>
- addXMLInvoker(): void
- removeXMLInvoker(): void
- }
- }
- declare module 'XrFrame/components/physics/types' {
- export const allShapeNames: string[]
- /**
- * 对刚体(在某个轴上的)位移和旋转的限制。
- *
- * @category Physics
- * @see {@link IRigidbodyData.constraintsMask}
- */
- export enum RigidbodyConstraints {
- None = 0,
- FreezePositionX = 1,
- FreezePositionY = 2,
- FreezePositionZ = 4,
- FreezeRotationX = 8,
- FreezeRotationY = 16,
- FreezeRotationZ = 32,
- FreezePosition = 7,
- FreezeRotation = 56,
- FreezeAll = 63
- }
- /**
- * @category Physics
- */
- export enum CollisionDetectionMode {
- Discrete = 0,
- Continuous = 1,
- ContinuousDynamic = 2,
- ContinuousSpeculative = 3
- }
- /**
- * 力(或力矩)的类型,物理组件中某些接口会用到。
- * @category Physics
- * @see {@link Rigidbody.addForce} {@link Rigidbody.addTorque}
- */
- export enum ForceMode {
- /**
- * 持续性的力。
- */
- Force = 0,
- /**
- * 只持续一帧的力。
- */
- Impulse = 1,
- /**
- * 只持续一帧的力,无视物体的{@link Rigidbody.mass | 质量}(mass=1)。
- *
- * \**其实就是在下一帧修改物体速度。*
- */
- VelocityChange = 2,
- /**
- * 持续性的力,无视物体的{@link Rigidbody.mass | 质量}(mass=1)。
- *
- * \**其实就是每帧修改物体速度。*
- */
- Acceleration = 4
- }
- /**
- * 发生碰撞时摩擦系数和弹性系数的结合方式。
- * @see {@link Collider.frictionCombine} {@link Collider.bounceCombine}
- */
- export enum CombineMode {
- Average = 0,
- Mininum = 1,
- Multiply = 2,
- Maximum = 3
- }
- }
- declare module 'XrFrame/components/gizmo/CapsuleGizmo' {
- import Component from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- export interface ICapsuleGizmoData {
- radius: number
- height: number
- direction: number
- center: [number, number, number]
- }
- export const CapsuleGizmoSchema: {}
- export default class CapsuleGizmo extends Component<ICapsuleGizmoData> {
- static pieces: number
- onAdd(parent: Element, data: ICapsuleGizmoData): void
- onUpdate(data: ICapsuleGizmoData, preData: ICapsuleGizmoData): void
- onTick(deltaTime: number, data: ICapsuleGizmoData): void
- onRemove(parent: Element, data: ICapsuleGizmoData): void
- onRelease(data: ICapsuleGizmoData): void
- }
- }
- declare module 'XrFrame/components/gizmo/CubeGizmo' {
- import Component from 'XrFrame/core/Component'
- import Element from 'XrFrame/core/Element'
- export interface ICubeGizmoData {
- size: [number, number, number]
- center: [number, number, number]
- }
- export const CubeGizmoSchema: {}
- export default class CubeGizmo extends Component<ICubeGizmoData> {
- onAdd(parent: Element, data: ICubeGizmoData): void
- onUpdate(data: ICubeGizmoData, preData: ICubeGizmoData): void
- onTick(deltaTime: number, data: ICubeGizmoData): void
- onRemove(parent: Element, data: ICubeGizmoData): void
- onRelease(data: ICubeGizmoData): void
- }
- }
- declare module 'XrFrame/render-graph/RenderGraph' {
- import RGNode, { TRGNodeAny } from 'XrFrame/render-graph/RGNode'
- import Camera from 'XrFrame/components/Camera'
- type RenderSystem = import('XrFrame/systems/RenderSystem').default
- type Scene = import('XrFrame/core/Scene').default
- interface IDigraphNode {
- node: TRGNodeAny
- ins: number
- dist: number[]
- }
- /**
- * 渲染图。
- *
- * @category Render
- */
- export default class RenderGraph<IOptions = any> {
- protected _name: string
- protected _options: IOptions
- protected _scene?: Scene
- protected _isActive: boolean
- protected _isDirty: boolean
- protected _unusedIds: number[]
- protected _digraph: Array<IDigraphNode | undefined>
- protected _sorted: TRGNodeAny[]
- /**
- * 图名字。
- */
- get name(): string
- /**
- * 当前正在运行的Game实例。
- */
- get scene(): import('XrFrame/core/Scene').default
- /**
- * 当前的渲染上下文。
- */
- get context(): import('XrFrame/systems/RenderSystem').default
- constructor(_name: string, _options: IOptions)
- /**
- * 创建一个节点。
- */
- createNode<TRGNode extends TRGNodeAny>(
- name: string,
- clz: new (...args: any) => TRGNode,
- options: TRGNode['options']
- ): TRGNode
- /**
- * 销毁一个节点。
- */
- destroyNode(rgNode: TRGNodeAny): void
- /**
- * 连接两个节点。
- *
- * @param inputKey 需要将`from`节点的输出连接到哪个`to`节点的输入。
- */
- connect<TToNode extends TRGNodeAny>(
- from: TRGNodeAny,
- to: TToNode,
- inputKey?: keyof TToNode['inputTypes']
- ): void
- /**
- * 断开两个节点的连接。
- */
- disconnect(from: TRGNodeAny, to: TRGNodeAny): void
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * 清空整个图,一般用于图的重新构建。
- *
- * @param filter 过滤出需要保留、不被销毁的缓存节点,这些节点只会被重置状态。
- */
- protected _clear(
- filter?: (node: RGNode<any, any, any>) => boolean
- ): void
- protected _handleCamerasChange: (context: RenderSystem) => void
- /**
- * 图在被第一次真正使用时的回调。
- */
- onActive(context: RenderSystem, options: IOptions): void
- /**
- * 在渲染上下文中的相机改变时调用,一般用于重新构建图。
- */
- onCamerasChange(cameras: Camera[], changeCameras: Camera[]): void
- /**
- * 在图每帧执行前调用。
- */
- onExecuteBegin(context: RenderSystem, options: IOptions): void
- /**
- * 在图每帧执行后调用。
- */
- onExecuteDone(context: RenderSystem, options: IOptions): void
- /**
- * 在图不再使用时调用。
- */
- onDisable(context: RenderSystem, options: IOptions): void
- /**
- * @internal
- *
- * 编译整张图。
- */
- showDebugInfo(
- callback?: (
- digraph: Array<IDigraphNode | undefined>,
- sorted: TRGNodeAny[]
- ) => void
- ): string
- }
- export {}
- }
- declare module 'XrFrame/systems/LightManager' {
- /**
- * LightManager.ts
- *
- * * @Date : 4/11/2022, 2:29:36 PM
- */
- import Camera from 'XrFrame/components/Camera'
- import Light from 'XrFrame/components/Light'
- export interface IMainLightsInfo {
- hasAmbient: boolean
- hasMainDir: boolean
- ambientColorIns: Float32Array
- mainDir: Float32Array
- mainColorIns: Float32Array
- }
- export interface IAddLightsInfo {
- count: number
- info: Float32Array
- dir: Float32Array
- pos: Float32Array
- colorIns: Float32Array
- }
- export default class LightManager {}
- }
- declare module 'XrFrame/loader/glTF/animations/GLTFAnimationsNode' {
- import { GLTFArrayNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFNodesLoaded } from 'XrFrame/loader/glTF/scenes/GLTFNodesNode'
- import GLTFAnimationNode, {
- GLTFAnimationLoaded,
- GLTFAnimationNodeRaw
- } from 'XrFrame/loader/glTF/animations/GLTFAnimationNode'
- import { GLTFAccessorsLoaded } from 'XrFrame/loader/glTF/buffers/GLTFAccessorsNode'
- type ChildNode = GLTFAnimationNode
- export type GLTFAnimationsNodeRaw = GLTFAnimationsNodeRaw[]
- export type GLTFAnimationsLoaded = GLTFAnimationLoaded[]
- export default class GLTFAnimationsNode extends GLTFArrayNode<ChildNode> {
- ChildCtor(childRaw: GLTFAnimationNodeRaw): GLTFAnimationNode
- readonly raw: GLTFAnimationsNodeRaw
- get nodeName(): string
- preload: (
- prerequisites: [
- accessors: GLTFAccessorsLoaded,
- nodes: GLTFNodesLoaded
- ]
- ) => Promise<GLTFAnimationsLoaded>
- getLoadedResource(): GLTFAnimationsLoaded
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/buffers/GLTFAccessorsNode' {
- import { GLTFArrayNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import GLTFAccessorNode, {
- GLTFAccessorLoaded,
- GLTFAccessorNodeRaw
- } from 'XrFrame/loader/glTF/buffers/GLTFAccessorNode'
- import { GLTFBufferViewsLoaded } from 'XrFrame/loader/glTF/buffers/GLTFBufferViewsNode'
- type ChildNode = GLTFAccessorNode
- export type GLTFAccessorsNodeRaw = GLTFAccessorsNodeRaw[]
- export type GLTFAccessorsLoaded = GLTFAccessorLoaded[]
- export default class GLTFAccessorsNode extends GLTFArrayNode<ChildNode> {
- ChildCtor(childRaw: GLTFAccessorNodeRaw): GLTFAccessorNode
- readonly raw: GLTFAccessorsNodeRaw
- get nodeName(): string
- preload: (
- prerequisites: GLTFBufferViewsLoaded
- ) => Promise<GLTFAccessorsLoaded>
- getLoadedResource(): GLTFAccessorsLoaded
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/buffers/GLTFBuffersNode' {
- import { GLTFArrayNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import GLTFBufferNode, {
- GLTFBufferLoaded,
- GLTFBufferNodeRaw
- } from 'XrFrame/loader/glTF/buffers/GLTFBufferNode'
- type ChildNode = GLTFBufferNode
- export type GLTFBuffersNodeRaw = GLTFBufferNodeRaw[]
- export type GLTFBuffersLoaded = GLTFBufferLoaded[]
- export default class GLTFBuffersNode extends GLTFArrayNode<ChildNode> {
- ChildCtor(childRaw: GLTFBufferNodeRaw): GLTFBufferNode
- readonly raw: GLTFBuffersNodeRaw
- get nodeName(): string
- getLoadedResource(): GLTFBuffersLoaded
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/buffers/GLTFBufferViewsNode' {
- import { GLTFArrayNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFBufferLoaded } from 'XrFrame/loader/glTF/buffers/GLTFBufferNode'
- import GLTFBufferViewNode, {
- GLTFBufferViewLoaded,
- GLTFBufferViewNodeRaw
- } from 'XrFrame/loader/glTF/buffers/GLTFBufferViewNode'
- type ChildNode = GLTFBufferViewNode
- export type GLTFBufferViewsNodeRaw = GLTFBufferViewsNodeRaw[]
- export type GLTFBufferViewsLoaded = GLTFBufferViewLoaded[]
- export default class GLTFBufferViewsNode extends GLTFArrayNode<ChildNode> {
- ChildCtor(childRaw: GLTFBufferViewNodeRaw): GLTFBufferViewNode
- readonly raw: GLTFBufferViewsNodeRaw
- get nodeName(): string
- preload: (
- prerequisites: [GLTFBufferLoaded]
- ) => Promise<GLTFBufferViewsLoaded>
- getLoadedResource(): GLTFBufferViewsLoaded
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/extensions/GLTFExtensions' {
- /**
- * 创建GLTFExtensionProfileBuilder实例来定义一种extension,
- * 类内提供了三种方法来操作gltf树:
- * + 一种是substitutePreload,替换gltf节点的preload函数;
- * + 一种是postBuild,在gltf树preload全部完成之后,再对其进行自定义操作;
- * + 一种是registerRunInSlot,需要先在gltf节点内部使用extensionSlot定义一个槽位,然后往这个槽位里填写代码。
- *
- * 具体要使用哪些extension请看GLTFLoader.ts。
- */
- type SlotCode = (
- raw: object,
- extensionGlobal: object,
- prerequisites: any,
- args: any
- ) => Promise<void>
- type ForceSlotCode = (
- extensionGlobal: object,
- prerequisites: any,
- args: any
- ) => Promise<void>
- export class GLTFExtensionProfileBuilder {
- constructor(extName: string)
- registerRootInit(
- init: (raw: object, extensionGlobal: object) => void
- ): void
- registerSubstitutePreload(
- path: string,
- preload: (
- raw: object,
- extensionGlobal: object,
- prerequisites?: object
- ) => Promise<any>
- ): void
- registerPostBuild(
- execute: (root: any, extensionGlobal: object) => Promise<void>
- ): void
- registerRunInSlot(slotId: string, code: SlotCode): void
- /**
- * 不管当前节点有没有extension,都运行,但是运行的时候不会给extRaw(因为可能没有)。
- */
- registerForceRunInSlot(slotId: string, code: ForceSlotCode): void
- }
- export interface GLTFExtensionProfile {
- readonly name: string
- readonly preloads: {
- [path: string]: (
- raw: string,
- extensionGlobal: object,
- prerequisites?: object
- ) => Promise<any>
- }
- readonly postBuild?: (root: any, extensionGlobal: object) => void
- readonly slotCodeMap: Map<string, SlotCode>
- readonly forceSlotCodeMap: Map<string, ForceSlotCode>
- readonly rootInit: (raw: object, extensionGlobal: object) => void
- }
- export type GLTFExtensionsProfiles = {
- [name: string]: GLTFExtensionProfile
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/geometry/GLTFMeshesNode' {
- import { Kanata } from 'XrFrame/ext'
- import { GLTFAccessorsLoaded } from 'XrFrame/loader/glTF/buffers/GLTFAccessorsNode'
- import { GLTFArrayNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFMaterialsLoaded } from 'XrFrame/loader/glTF/materials/GLTFMaterialsNode'
- import GLTFMeshNode, {
- GLTFMeshLoaded,
- GLTFMeshNodeRaw
- } from 'XrFrame/loader/glTF/geometry/GLTFMeshNode'
- type ChildNode = GLTFMeshNode
- export type GLTFMeshesNodeRaw = GLTFMeshesNodeRaw[]
- export type GLTFMeshesLoaded = GLTFMeshLoaded[]
- export default class GLTFMeshesNode extends GLTFArrayNode<ChildNode> {
- ChildCtor(childRaw: GLTFMeshNodeRaw): GLTFMeshNode
- readonly raw: GLTFMeshesNodeRaw
- get nodeName(): string
- preload: (
- prerequisites: [
- materials: GLTFMaterialsLoaded,
- accessors: GLTFAccessorsLoaded,
- vbMap: Map<string, [ArrayBuffer, Kanata.VertexLayout, object]>
- ]
- ) => Promise<GLTFMeshesLoaded>
- getLoadedResource(): GLTFMeshesLoaded
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/GLTFBaseNode' {
- import { GLTFValidation } from 'XrFrame/loader/glTF/utils/exceptions'
- type Scene = import('XrFrame/core/Scene').default
- function _empty(): {
- and: typeof _empty
- }
- export abstract class GLTFBaseNode {
- readonly raw: any
- abstract get nodeName(): string
- parent: GLTFBaseNode
- scene: Scene
- isValid: boolean
- constructor(raw: object, parent?: GLTFBaseNode)
- /**
- * 利用raw生成子节点
- */
- abstract build(): void
- /**
- * @param msg 需要带句号
- */
- protected assert(
- pred: any,
- msg?: string
- ):
- | this
- | {
- and: typeof _empty
- }
- protected validate(
- use: GLTFValidation<any>,
- pred?: boolean | string,
- ...args: string[]
- ):
- | this
- | {
- and: typeof _empty
- }
- /**
- * 加载静态资源,buffer/image等。
- * 所有错误在这个方法抛出,包括格式错误,加载错误等。
- */
- abstract preload(prerequisites?: object): Promise<object>
- /**
- * 给extension内部使用的,在extension替换preload的时候,用来储存原preload。
- */
- protected _preload: (prerequisites?: object) => Promise<object>
- /**
- * 获取加载后的资源。
- * 无报错 throws nothing。
- */
- abstract getLoadedResource(): object
- protected findRoot(withPath?: boolean): any
- getExtensionRaw(extName: string): object | undefined
- /**
- * 调用这个函数可以放置一个**允许extension代码插入**的位置。
- */
- protected extensionSlot(id: string, args: object): Promise<void>
- releaseLoadedResource(): void
- }
- export abstract class GLTFArrayNode<
- T extends GLTFBaseNode
- > extends GLTFBaseNode {
- abstract readonly raw: object[]
- abstract ChildCtor(childRaw: object): T
- children: T[]
- protected resources: any[]
- preload(prerequisites?: any): Promise<any>
- build(): void
- releaseLoadedResource(): void
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/materials/GLTFMaterialsNode' {
- import { GLTFArrayNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFTexturesLoaded } from 'XrFrame/loader/glTF/textures/GLTFTexturesNode'
- import GLTFMaterialNode, {
- GLTFMaterialLoaded,
- GLTFMaterialNodeRaw
- } from 'XrFrame/loader/glTF/materials/GLTFMaterialNode'
- type ChildNode = GLTFMaterialNode
- export type GLTFMaterialsNodeRaw = GLTFMaterialsNodeRaw[]
- export type GLTFMaterialsLoaded = GLTFMaterialLoaded[]
- export default class GLTFMaterialsNode extends GLTFArrayNode<ChildNode> {
- ChildCtor(childRaw: GLTFMaterialNodeRaw): GLTFMaterialNode
- readonly raw: GLTFMaterialsNodeRaw
- get nodeName(): string
- preload: (
- prerequisites: [textrues: GLTFTexturesLoaded]
- ) => Promise<GLTFMaterialsLoaded>
- getLoadedResource(): GLTFMaterialsLoaded
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/scenes/GLTFSceneNode' {
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import {
- GLTFNodesLoaded,
- GLTFTreeNode
- } from 'XrFrame/loader/glTF/scenes/GLTFNodesNode'
- export interface GLTFSceneNodeRaw {
- nodes?: number[]
- name?: string
- }
- export type GLTFSceneLoaded = GLTFTreeNode[]
- export default class GLTFSceneNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFSceneNodeRaw
- build(): void
- preload(
- prerequisites: [nodes: GLTFNodesLoaded]
- ): Promise<GLTFSceneLoaded>
- getLoadedResource(): GLTFSceneLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/scenes/GLTFScenesNode' {
- import { GLTFArrayNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFNodesLoaded } from 'XrFrame/loader/glTF/scenes/GLTFNodesNode'
- import GLTFSceneNode, {
- GLTFSceneLoaded,
- GLTFSceneNodeRaw
- } from 'XrFrame/loader/glTF/scenes/GLTFSceneNode'
- type ChildNode = GLTFSceneNode
- export type GLTFScenesNodeRaw = GLTFScenesNodeRaw[]
- export type GLTFScenesLoaded = GLTFSceneLoaded[]
- export default class GLTFScenesNode extends GLTFArrayNode<ChildNode> {
- ChildCtor(childRaw: GLTFSceneNodeRaw): GLTFSceneNode
- readonly raw: GLTFScenesNodeRaw
- get nodeName(): string
- preload: (
- prerequisites: [nodes: GLTFNodesLoaded]
- ) => Promise<GLTFScenesLoaded>
- getLoadedResource(): GLTFScenesLoaded
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/skins/GLTFSkinsNode' {
- import { GLTFAccessorsLoaded } from 'XrFrame/loader/glTF/buffers/GLTFAccessorsNode'
- import { GLTFArrayNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import GLTFSkinNode, {
- GLTFSkinLoaded,
- GLTFSkinNodeRaw
- } from 'XrFrame/loader/glTF/skins/GLTFSkinNode'
- type ChildNode = GLTFSkinNode
- export type GLTFSkinsNodeRaw = GLTFSkinsNodeRaw[]
- export type GLTFSkinsLoaded = GLTFSkinLoaded[]
- export default class GLTFSkinsNode extends GLTFArrayNode<ChildNode> {
- ChildCtor(childRaw: GLTFSkinNodeRaw): GLTFSkinNode
- readonly raw: GLTFSkinsNodeRaw
- get nodeName(): string
- preload: (
- prerequisites: [accessors: GLTFAccessorsLoaded]
- ) => Promise<GLTFSkinsLoaded>
- getLoadedResource(): GLTFSkinsLoaded
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/textures/GLTFImagesNode' {
- import { GLTFBufferViewsLoaded } from 'XrFrame/loader/glTF/buffers/GLTFBufferViewsNode'
- import { GLTFArrayNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import GLTFImageNode, {
- GLTFImageLoaded,
- GLTFImageNodeRaw
- } from 'XrFrame/loader/glTF/textures/GLTFImageNode'
- type ChildNode = GLTFImageNode
- export type GLTFImagesNodeRaw = GLTFImagesNodeRaw[]
- export type GLTFImagesLoaded = GLTFImageLoaded[]
- export default class GLTFImagesNode extends GLTFArrayNode<ChildNode> {
- ChildCtor(childRaw: GLTFImageNodeRaw): GLTFImageNode
- readonly raw: GLTFImagesNodeRaw
- get nodeName(): string
- preload: (
- prerequisites: [bufferViews: GLTFBufferViewsLoaded]
- ) => Promise<GLTFImagesLoaded>
- getLoadedResource(): GLTFImagesLoaded
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/textures/GLTFSamplersNode' {
- import { GLTFArrayNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import GLTFSamplerNode, {
- GLTFSamplerLoaded,
- GLTFSamplerNodeRaw
- } from 'XrFrame/loader/glTF/textures/GLTFSamplerNode'
- type ChildNode = GLTFSamplerNode
- export type GLTFSamplersNodeRaw = GLTFSamplersNodeRaw[]
- export type GLTFSamplersLoaded = GLTFSamplerLoaded[]
- export default class GLTFSamplersNode extends GLTFArrayNode<ChildNode> {
- ChildCtor(childRaw: GLTFSamplerNodeRaw): GLTFSamplerNode
- readonly raw: GLTFSamplersNodeRaw
- get nodeName(): string
- preload: () => Promise<GLTFSamplersLoaded>
- getLoadedResource(): GLTFSamplersLoaded
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/textures/GLTFTexturesNode' {
- import { GLTFArrayNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFImagesLoaded } from 'XrFrame/loader/glTF/textures/GLTFImagesNode'
- import { GLTFSamplersLoaded } from 'XrFrame/loader/glTF/textures/GLTFSamplersNode'
- import GLTFTextureNode, {
- GLTFTextureLoaded,
- GLTFTextureNodeRaw
- } from 'XrFrame/loader/glTF/textures/GLTFTextureNode'
- type ChildNode = GLTFTextureNode
- export type GLTFTexturesNodeRaw = GLTFTexturesNodeRaw[]
- export type GLTFTexturesLoaded = GLTFTextureLoaded[]
- export default class GLTFTexturesNode extends GLTFArrayNode<ChildNode> {
- ChildCtor(childRaw: GLTFTextureNodeRaw): GLTFTextureNode
- readonly raw: GLTFTexturesNodeRaw
- get nodeName(): string
- preload: (
- prerequisites: [
- images: GLTFImagesLoaded,
- samplers: GLTFSamplersLoaded
- ]
- ) => Promise<GLTFTexturesLoaded>
- getLoadedResource(): GLTFTexturesLoaded
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/utils/exceptions' {
- import type { GLTFTargetNodeRaw } from 'XrFrame/loader/glTF/animations/channels/GLTFTargetNode'
- import type { GLTFAccessorNodeRaw } from 'XrFrame/loader/glTF/buffers/GLTFAccessorNode'
- import type { GLTFAttributesNodeRaw } from 'XrFrame/loader/glTF/geometry/primitives/attributes/GLTFAttributesNode'
- import type { GLTFPrimitiveNodeRaw } from 'XrFrame/loader/glTF/geometry/primitives/GLTFPrimitiveNode'
- import type { GLTFNodeNodeRaw } from 'XrFrame/loader/glTF/scenes/GLTFNodeNode'
- import type { GLTFTextureNodeRaw } from 'XrFrame/loader/glTF/textures/GLTFTextureNode'
- export enum EValidation {
- TextureSource = 10001,
- SkinAccessor = 10101,
- NodeWeights = 10201,
- MorphAttrib = 10301,
- UVSlot = 10401,
- JointSlot = 10402,
- WeightSlot = 10403,
- MorphTargetsCount = 10501,
- PrimitiveType = 10502,
- IndexBufferLength = 10503,
- SparseAccessor = 10601,
- NormalizedAccessor = 10602
- }
- interface Validation<T> {
- id: EValidation
- msg: string
- validate?(raw: T): boolean
- fatal?: boolean
- }
- export namespace GLTFValidations {
- const UndefinedTextureSource: Validation<GLTFTextureNodeRaw>
- const SkinAccessorNotCompact: Validation<void>
- const UnsupportedNodeWeights: Validation<GLTFNodeNodeRaw>
- const UnsupportedMorphAttrib: Validation<GLTFTargetNodeRaw>
- const UnsupportedUVSlot: Validation<GLTFAttributesNodeRaw>
- const UnsupportedJointSlot: Validation<GLTFAttributesNodeRaw>
- const UnsupportedWeightSlot: Validation<GLTFAttributesNodeRaw>
- const MorphTargetsCountExceeded: Validation<GLTFPrimitiveNodeRaw>
- const UnsupportedPrimitiveType: Validation<GLTFPrimitiveNodeRaw>
- const InvalidIndexBufferLength: Validation<GLTFPrimitiveNodeRaw>
- const UnsupportedSparseAccessor: Validation<GLTFAccessorNodeRaw>
- const UnsupportedNormalizedAccessor: Validation<GLTFAccessorNodeRaw>
- }
- export { Validation as GLTFValidation }
- export const GLTFValidationMap: {
- 10001: Validation<GLTFTextureNodeRaw>
- 10101: Validation<void>
- 10201: Validation<GLTFNodeNodeRaw>
- 10301: Validation<GLTFTargetNodeRaw>
- 10401: Validation<GLTFAttributesNodeRaw>
- 10402: Validation<GLTFAttributesNodeRaw>
- 10403: Validation<GLTFAttributesNodeRaw>
- 10501: Validation<GLTFPrimitiveNodeRaw>
- 10502: Validation<GLTFPrimitiveNodeRaw>
- 10503: Validation<GLTFPrimitiveNodeRaw>
- 10601: Validation<GLTFAccessorNodeRaw>
- 10602: Validation<GLTFAccessorNodeRaw>
- }
- }
- declare module 'XrFrame/loader/glTF/scenes/GLTFNodeNode' {
- import { GLTFMeshesLoaded } from 'XrFrame/loader/glTF/geometry/GLTFMeshesNode'
- import { GLTFMeshLoaded } from 'XrFrame/loader/glTF/geometry/GLTFMeshNode'
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFSkinLoaded } from 'XrFrame/loader/glTF/skins/GLTFSkinNode'
- import { GLTFSkinsLoaded } from 'XrFrame/loader/glTF/skins/GLTFSkinsNode'
- import { GLTF } from 'XrFrame/loader/glTF/utils/types'
- export interface GLTFNodeNodeRaw {
- children?: number[]
- mesh?: number
- matrix?: number[]
- rotation?: [number, number, number, number]
- scale?: [number, number, number]
- translation?: [number, number, number]
- weights?: number
- skin?: number
- name?: string
- extensions?: object
- extras?: any
- }
- export interface GLTFNodeLoaded {
- children: number[]
- transform: GLTF.Transform
- mesh?: GLTFMeshLoaded
- skin?: GLTFSkinLoaded
- name: string
- extras?: any
- }
- export type GLTFNodePrerequisites = [
- meshes: GLTFMeshesLoaded,
- skins: GLTFSkinsLoaded
- ]
- export default class GLTFNodeNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFNodeNodeRaw
- build(): void
- preload(prerequisites: GLTFNodePrerequisites): Promise<GLTFNodeLoaded>
- getLoadedResource(): GLTFNodeLoaded
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/component/MeshRendererComponent' {
- /**
- * MeshRendererComponent.ts
- *
- * * @Date : 9/3/2020, 7:54:23 PM
- */
- import { EMeshRenderType } from 'XrFrame/kanata/lib/backend'
- import NativeObject from 'XrFrame/kanata/lib/frontend/shared/NativeObject'
- import Entity3D from 'XrFrame/kanata/lib/frontend/entity/Entity3D'
- import Entity2D from 'XrFrame/kanata/lib/frontend/entity/Entity2D'
- import UniformBlock from 'XrFrame/kanata/lib/frontend/resource/UniformBlock'
- import VertexBuffer from 'XrFrame/kanata/lib/frontend/resource/VertexBuffer'
- import IndexBuffer from 'XrFrame/kanata/lib/frontend/resource/IndexBuffer'
- import VertexData from 'XrFrame/kanata/lib/frontend/resource/VertexData'
- import IndexData from 'XrFrame/kanata/lib/frontend/resource/IndexData'
- import Material from 'XrFrame/kanata/lib/frontend/resource/Material'
- import SkinnedSkeletonComponent from 'XrFrame/kanata/lib/frontend/component/SkinnedSkeletonComponent'
- import CullingComponent from 'XrFrame/kanata/lib/frontend/component/CullingComponent'
- export default class MeshRendererComponent extends NativeObject {
- static OFFSETS: {
- dynamicBatch: number
- skinHandle: number
- castShadow: number
- bindTarget: number
- start: number
- size: number
- materialId: number
- vertexBufferId: number
- indexBufferId: number
- startIndex: number
- numIndices: number
- }
- static CREATE_FAKE(
- entity: Entity3D | Entity2D,
- options: {
- meshCount: number
- uniformBlock?: UniformBlock
- }
- ): FakeMeshRenderComponent
- protected _uniforms: UniformBlock
- get uniforms(): UniformBlock
- get meshCount(): number
- get castShadow(): boolean
- set castShadow(value: boolean)
- get dynamicBatch(): boolean
- set dynamicBatch(value: boolean)
- set skinSkeleton(sk: SkinnedSkeletonComponent)
- set bindTarget(target: Entity3D | Entity2D | null)
- get macros(): {
- [name: string]: string | number | boolean
- }
- constructor(
- entity: Entity3D | Entity2D,
- options: {
- meshCount: number
- uniformBlock: UniformBlock
- renderType: EMeshRenderType
- culling?: CullingComponent
- macros?: {
- [name: string]: string | number | boolean
- }
- }
- )
- protected _createNativeObj(
- entity: Entity3D | Entity2D,
- options: {
- meshCount: number
- uniformBlock: UniformBlock
- renderType: EMeshRenderType
- culling?: CullingComponent
- macros?: {
- [name: string]: string | number | boolean
- }
- }
- ): import('XrFrame/kanata/lib/backend').IHandle & {
- setSharedDirty(): void
- }
- changeMacros(macros?: {
- [name: string]: string | number | boolean
- }): void
- getStartIndex(index: number): number
- setStartIndex(index: number, value: number): void
- getNumIndices(index: number): number
- setNumIndices(index: number, value: number): void
- getVertexBuffer(index: number): VertexBuffer
- setVertexBuffer(index: number, buffer: VertexBuffer): void
- getIndexBuffer(index: number): IndexBuffer
- setIndexBuffer(index: number, buffer: IndexBuffer): void
- getVertexData(index: number): VertexData
- setVertexData(index: number, buffer: VertexData): void
- getIndexData(index: number): IndexData
- setIndexData(index: number, buffer: IndexData): void
- getMaterial(index: number): Material
- setMaterial(index: number, material: Material | null): void
- fastSet(
- vertexes: Array<VertexBuffer | VertexData>,
- indexes: Array<VertexData | IndexBuffer>,
- materials: Material[],
- startIndexes: number[],
- numIndices: number[]
- ): void
- setDirty(): void
- copyStates(comp: MeshRendererComponent): void
- }
- class FakeMeshRenderComponent extends MeshRendererComponent {
- protected _createNativeObj(
- entity: Entity3D | Entity2D,
- options: {
- meshCount: number
- uniformBlock: UniformBlock
- renderType: EMeshRenderType
- culling: CullingComponent
- }
- ): {
- id: number
- data: ArrayBuffer
- setSharedDirty: () => void
- }
- get uniforms(): UniformBlock
- set uniforms(uniforms: UniformBlock)
- }
- export {}
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/renderEnv' {
- /**
- * renderEnv.ts
- *
- * * @Date : 1/18/2021, 3:53:26 PM
- */
- import {
- EMeshRenderType,
- EUniformType,
- IFeatures,
- IRenderEnv,
- TCompressTexture
- } from 'XrFrame/kanata/lib/backend'
- import View from 'XrFrame/kanata/lib/frontend/resource/View'
- import Effect from 'XrFrame/kanata/lib/frontend/resource/Effect'
- import RenderPass from 'XrFrame/kanata/lib/frontend/resource/RenderPass'
- import UniformBlock from 'XrFrame/kanata/lib/frontend/resource/UniformBlock'
- export class RenderEnv {
- id: number
- __handle: IRenderEnv
- useExtendedMemory: boolean
- get version(): number[]
- get backendType(): string
- get canvasWidth(): number
- set canvasWidth(value: number)
- get canvasHeight(): number
- set canvasHeight(value: number)
- get supportCompressTextures(): TCompressTexture[]
- get features(): IFeatures
- get commitVersion(): string
- get usePuppetSokol(): boolean
- get useInstance(): boolean
- set useInstance(value: boolean)
- get neverTranspose(): boolean
- set neverTranspose(value: boolean)
- get isWrongWrapMapping(): boolean
- get isNotWrongEffectSort(): boolean
- get isGoodInstance(): boolean
- get isGoodPhysAndScalableList(): boolean
- constructor()
- supportCompressTexture(type: TCompressTexture): boolean
- registerFallbackEffect(lightMode: string, effect?: Effect): void
- beginFrame(): void
- endFrame(): void
- clearView(view: View): void
- setEnvUniform(index: number, uniforms: UniformBlock): void
- setRenderPass(renderPass: RenderPass): void
- changeMacros(macros: {
- [name: string]: string | number | boolean
- }): void
- getMacro(key: string): string | number | boolean
- changeVirtualMacros(macros: { [name: string]: boolean }): void
- getVirtualMacro(key: string): boolean
- setInternalInstanceInfo(
- type: EMeshRenderType,
- info: Array<{
- uniformKey: string
- attributeName: string
- type: EUniformType
- }>,
- ignored: string[]
- ): void
- getErrors(): string[]
- }
- const renderEnv: RenderEnv
- export default renderEnv
- }
- declare module 'XrFrame/kanata/lib/frontend/component/AnimatorComponent' {
- import NativeObject from 'XrFrame/kanata/lib/frontend/shared/NativeObject'
- import Entity3D from 'XrFrame/kanata/lib/frontend/entity/Entity3D'
- import AnimationClipModel from 'XrFrame/kanata/lib/frontend/resource/AnimationClipModel'
- export default class AnimatorComponent extends NativeObject {
- static UPDATE_ANIMATORS(
- animators: AnimatorComponent[],
- size: number
- ): void
- animationClipModels: AnimationClipModel[]
- constructor()
- bindAnimations(
- animationClipModels: AnimationClipModel[],
- entities: Array<Array<Entity3D | null>>,
- rootEntity?: Entity3D
- ): void
- setClipParams(
- index: number,
- frameIndex: number,
- blendWeight: number
- ): void
- getAnimationClipCount(): number
- getNodeCount(): number
- getAnimationParameter(index: number): {
- animationClipId: number
- frameIndex: number
- percentage: number
- }
- getEntity(index: number): number
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/component/CameraComponent' {
- import NativeObject from 'XrFrame/kanata/lib/frontend/shared/NativeObject'
- import Entity3D from 'XrFrame/kanata/lib/frontend/entity/Entity3D'
- import Entity2D from 'XrFrame/kanata/lib/frontend/entity/Entity2D'
- import View from 'XrFrame/kanata/lib/frontend/resource/View'
- import ScalableList from 'XrFrame/kanata/lib/frontend/resource/ScalableList'
- export default class CameraComponent extends NativeObject {
- static OFFSETS: {
- size: number
- view: number
- depth: number
- active: number
- fov: number
- aspect: number
- near: number
- far: number
- up: number
- eye: number
- orthoSize: number
- isProjection: number
- cullingMask: number
- canvasSizeY: number
- targetTransform: number
- viewMatrix: number
- projectionMatrix: number
- viewMatrixInverse: number
- viewMatrix2D: number
- projectionMatrix2D: number
- viewMatrixInverse2D: number
- manualMatrix: number
- layerCullDistances: number
- }
- get active(): boolean
- set active(value: boolean)
- get depth(): number
- set depth(value: number)
- get isProjection(): boolean
- set isProjection(value: boolean)
- get view(): View
- set view(value: View)
- get fov(): number
- set fov(value: number)
- get aspect(): number
- set aspect(value: number)
- get near(): number
- set near(value: number)
- get far(): number
- set far(value: number)
- get orthoSize(): number
- set orthoSize(value: number)
- get cullingMask(): number
- set cullingMask(value: number)
- get layerCullDistances(): Float32Array | number[]
- set layerCullDistances(value: Float32Array | number[])
- get canvasSizeY(): number
- set canvasSizeY(value: number)
- set targetTransform(entityId: number)
- get targetTransform(): number
- set up(vec3: Float32Array)
- constructor(entity: Entity2D | Entity3D, isUI?: boolean)
- cull(cullResult: ScalableList, lightMode: string): void
- draw(renderList: ScalableList, lightMode: string): void
- changeProjectionMatrix(manual: boolean, mat4?: Float32Array): void
- changeViewMatrix(manual: boolean, mat4?: Float32Array): void
- updateMatrix(): void
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/component/LightCameraComponent' {
- /**
- * CameraLightComponent.ts
- *
- * * @Date : 9/3/2020, 7:54:13 PM
- */
- import { EShadowMode } from 'XrFrame/kanata/lib/backend'
- import NativeObject from 'XrFrame/kanata/lib/frontend/shared/NativeObject'
- import View from 'XrFrame/kanata/lib/frontend/resource/View'
- import UniformBlock from 'XrFrame/kanata/lib/frontend/resource/UniformBlock'
- import ScalableList from 'XrFrame/kanata/lib/frontend/resource/ScalableList'
- import CameraComponent from 'XrFrame/kanata/lib/frontend/component/CameraComponent'
- export default class LightCameraComponent extends NativeObject {
- static OFFSETS: {
- size: number
- view: number
- depth: number
- active: number
- shadowDistance: number
- shadowMode: number
- shadowFilterMode: number
- lightDir: number
- bounds: number
- lightSpaceMatrices: number
- }
- get view(): View
- set view(value: View)
- get active(): boolean
- set active(value: boolean)
- get depth(): number
- set depth(value: number)
- get shadowDistance(): number
- set shadowDistance(value: number)
- get shadowFilterMode(): number
- set shadowFilterMode(value: number)
- get shadowMode(): EShadowMode
- set shadowMode(value: EShadowMode)
- get lightSpaceMatrices(): Float32Array
- constructor()
- draw(
- camera: CameraComponent,
- renderList: ScalableList,
- lightMode: string
- ): void
- prepareUniforms(uniforms: UniformBlock): void
- setLightDir(x: number, y: number, z: number): void
- setCascadedSplits(s0: number, s1: number, s2: number): void
- protected _updateBounds(auto: boolean): void
- protected _adjustSplitPercents(index: number, percent: number): number
- protected _setSplitPercents(index: number, percent: number): number
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/component/CullingComponent' {
- import Entity3D from 'XrFrame/kanata/lib/frontend/entity/Entity3D'
- import Entity2D from 'XrFrame/kanata/lib/frontend/entity/Entity2D'
- import PoolObject from 'XrFrame/kanata/lib/frontend/pool/PoolObject'
- import PoolManager from 'XrFrame/kanata/lib/frontend/pool/PoolManager'
- export default class CullingComponent extends PoolObject {
- static POLL_MANAGER: PoolManager
- constructor(entity: Entity2D | Entity3D)
- getActive(): boolean
- setActive(val: boolean): void
- getLayer(): number
- setLayer(val: number): void
- getBoundingBallCenter(): Float32Array
- setBoundingBallCenter(val: Float32Array, offset?: number): void
- getBoundingBallRadius(): number
- setBoundingBallRadius(val: number): void
- bindEntity(entity: Entity2D | Entity3D): void
- destroy(): void
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/component/SkinnedSkeletonComponent' {
- import NativeObject from 'XrFrame/kanata/lib/frontend/shared/NativeObject'
- import SkeletonBoneInverseModel from 'XrFrame/kanata/lib/frontend/resource/SkeletonBoneInverseModel'
- import Entity3D from 'XrFrame/kanata/lib/frontend/entity/Entity3D'
- export default class SkinnedSkeletonComponent extends NativeObject {
- static UPDATE_MATS(
- comps: SkinnedSkeletonComponent[],
- size: number
- ): void
- get boneNum(): number
- get boneInverseModel(): SkeletonBoneInverseModel
- get boneOffsetMatrices(): Float32Array
- constructor(boneNum: number, flag: number)
- setBoneMatrix(
- boneInverseModel: SkeletonBoneInverseModel,
- boneIndices: number[],
- boneEntities: Entity3D[]
- ): void
- getBoneNum(): number
- getBoneOffsetMatrices(): Float32Array
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/component/DynamicBonesComponent' {
- import NativeObject from 'XrFrame/kanata/lib/frontend/shared/NativeObject'
- import Entity3D from 'XrFrame/kanata/lib/frontend/entity/Entity3D'
- export default class DynamicBonesComponent extends NativeObject {
- static OFFSETS: {
- stiffness: number
- elasticity: number
- damping: number
- }
- get stiffness(): number
- set stiffness(v: number)
- get damping(): number
- set damping(v: number)
- get elasticity(): number
- set elasticity(v: number)
- constructor(rootNode?: Entity3D)
- preUpdate(): void
- update(
- dt: number,
- rootMotion?: {
- x: number
- y: number
- z: number
- }
- ): void
- rebuild(): void
- resetRoot(root?: Entity3D): void
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/entity/Entity2D' {
- import PoolObject from 'XrFrame/kanata/lib/frontend/pool/PoolObject'
- import PoolManager from 'XrFrame/kanata/lib/frontend/pool/PoolManager'
- export default class Entity2D extends PoolObject {
- static POLL_MANAGER: PoolManager
- static OFFSETS: {
- size: number
- rotation: number
- position: number
- scale: number
- worldMatrix: number
- }
- localPositionOffset: number
- localRotationOffset: number
- localScaleOffset: number
- worldMatrixOffset: number
- constructor()
- addChild(child: Entity2D): void
- addChildAtIndex(child: Entity2D, index: number): void
- removeFromParent(): void
- setAsRoot(): void
- destroy(): void
- clear(): void
- setLocalMatrixDirty(): void
- set active(val: boolean)
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/entity/Entity3D' {
- import PoolObject from 'XrFrame/kanata/lib/frontend/pool/PoolObject'
- import PoolManager from 'XrFrame/kanata/lib/frontend/pool/PoolManager'
- export default class Entity3D extends PoolObject {
- static POLL_MANAGER: PoolManager
- static OFFSETS: {
- size: number
- dfRotationType: number
- rotationType: number
- rotation: number
- position: number
- scale: number
- worldOffset: number
- worldMatrix: number
- }
- static CREATE_TREE(
- length: number,
- buffer: ArrayBuffer,
- out: any[],
- calculateWordMatrix?: boolean
- ): boolean
- localRotationTypeOffset: number
- localQuaternionOffset: number
- localPositionOffset: number
- localScaleOffset: number
- worldMatrixOffset: number
- extOffset: number
- layerOffset: number
- mixedLayerMaskOffset: number
- constructor()
- setUsingEuler(on: boolean): void
- isUsingEuler(): boolean
- setLayer(layer: number): void
- getLayer(): number
- getMixedLayerMask(): number
- addChild(child: Entity3D): void
- addChildAtIndex(child: Entity3D, index: number): void
- removeFromParent(): void
- setAsRoot(): void
- destroy(): void
- /**
- * 如果只调用entityClear指令,那么Kanata就无法回收根节点下面的子节点了。
- * 目前Kanata的frontend没有父子关系信息只能这么做了。
- * 这个方法目前只能减少eventBridge的指令量,避免在大规模节点销毁的时候频繁触发eventBridge的溢出提交。
- * @param entities
- * @param length
- */
- clear(entities: Entity3D[], length: number): void
- setLocalMatrixDirty(): void
- set active(val: boolean)
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/AnimationClipModel' {
- import DataModel from 'XrFrame/kanata/lib/frontend/resource/DataModel'
- export default class AnimationClipModel extends DataModel {
- setAnimationClip(ab: ArrayBuffer): void
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/AnimationClipBinding' {
- /**
- * AnimationClipBinding.ts
- *
- * */
- import Entity3D from 'XrFrame/kanata/lib/frontend/entity/Entity3D'
- import AnimationClipModel from 'XrFrame/kanata/lib/frontend/resource/AnimationClipModel'
- import { EUseDefaultAddedAction } from 'XrFrame/kanata/lib/backend'
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- import { INativeWorker } from 'XrFrame/kanata/lib/backend/native/worker'
- export default class AnimationClipBinding extends PureResource {
- __handle: INativeWorker.IAnimationClipBinding
- constructor(
- clipArray: AnimationClipModel[],
- clipArrayOffset: number,
- clipArrayLength: number,
- entityArray: Array<number | Entity3D | null>,
- entityArrayOffset: number,
- entityArrayLength: number,
- useDefaultAddedNodesAction: EUseDefaultAddedAction,
- rootEntity: Entity3D
- )
- rebind(
- clipArray: AnimationClipModel[],
- clipArrayOffset: number,
- clipArrayLength: number,
- entityArray: Array<number | Entity3D | null>,
- entityArrayOffset: number,
- entityArrayLength: number,
- removeAction: number,
- retainedAction: number,
- addedAction: number,
- rootEntity: Entity3D
- ): boolean
- update(
- clipArray: AnimationClipModel[],
- clipArrayOffset: number,
- clipArrayLength: number,
- entityArray: Array<number | Entity3D | null>,
- entityArrayOffset: number,
- entityArrayLength: number,
- removeAction: number,
- retainedAction: number,
- addedAction: number
- ): boolean
- writeDefaultValues(): void
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/AnimatorControllerModel' {
- /**
- * AnimatorControllerModel.ts
- *
- * */
- import AnimatorControllerStateModel from 'XrFrame/kanata/lib/frontend/resource/AnimatorControllerStateModel'
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- import AnimationClipBinding from 'XrFrame/kanata/lib/frontend/resource/AnimationClipBinding'
- export default class AnimatorControllerModel extends PureResource {
- layerCount: number
- static UPDATE_ANIMATOR_CONTROLLERS(
- animatorControllers: AnimatorControllerModel[],
- size: number
- ): void
- constructor(layerCount: number)
- setAnimationClipBinding(binding: null | AnimationClipBinding): void
- setLayerBlendType(layerIndex: number, blendType: number): void
- setLayerWeight(layerIndex: number, weight: number): void
- setLayerBlend(
- layerIndex: number,
- blend: null | AnimatorControllerStateModel
- ): void
- setLayerMask(
- layerIndex: number,
- mask: {
- buffer: null | ArrayBuffer
- offset: number
- length: number
- }
- ): void
- update(): void
- destroy(): void
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/AnimatorControllerStateModel' {
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- import AnimationClipModel from 'XrFrame/kanata/lib/frontend/resource/AnimationClipModel'
- export default class AnimatorControllerStateModel extends PureResource {
- readonly count: number
- get weight(): number
- set weight(weight: number)
- get useDefault(): number
- set useDefault(useDefault: number)
- constructor(count: number)
- resetBlendInfo(): void
- setNextState(state: AnimatorControllerStateModel | null): void
- setBlendInfo(
- clip: AnimationClipModel,
- frameIndex: number,
- blendWeight: number,
- additiveReferenceClip: null | AnimationClipModel,
- additiveFrameIndex: number
- ): boolean
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/DataBuffer' {
- /**
- * DataBuffer.ts
- *
- * * @Date : 9/4/2020, 1:21:59 PM
- */
- import { IHandle } from 'XrFrame/kanata/lib/backend'
- import NativeObject from 'XrFrame/kanata/lib/frontend/shared/NativeObject'
- export default class DataBuffer extends NativeObject {
- constructor(nativeObj: IHandle)
- get dataLength(): number
- get byteOffset(): number
- get arrayBuffer(): ArrayBuffer
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/DataModel' {
- /**
- * DataModel.ts
- *
- * * @Date : 9/4/2020, 1:18:13 PM
- */
- import { EDataModelType } from 'XrFrame/kanata/lib/backend'
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- export default class DataModel extends PureResource {
- protected _createNativeModel(
- type: EDataModelType,
- buffer: ArrayBuffer
- ): void
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/Effect' {
- /**
- * Effect.ts
- *
- * * @Date : 9/9/2020, 5:49:54 PM
- */
- import {
- EBlendFactor,
- EBlendEquation,
- ECullMode,
- ECompareFunc,
- EPrimitiveType,
- EStencilOp
- } from 'XrFrame/kanata/lib/backend'
- import NativeObject from 'XrFrame/kanata/lib/frontend/shared/NativeObject'
- export default class Effect extends NativeObject {
- static OFFSETS: {
- size: number
- useMaterialStates: number
- fstencil: number
- bstencil: number
- blendRGBA: number
- colorDepth: number
- state: number
- }
- get passCount(): number
- constructor(
- name: string,
- passCount: number,
- keyIndexMap: string[],
- passes: Array<{
- lightMode: string
- variants?: {
- [key: number]: number
- }
- macros?: {
- [key: string]: number
- }
- shaders?: number[]
- }>,
- shaders: string[],
- variants: number[][],
- useRuntimeMacros?: boolean
- )
- warmUp(): any
- getBlendOn(pass: number): boolean
- setBlendOn(pass: number, value: boolean): void
- getBlendSrc(pass: number): EBlendFactor
- setBlendSrc(pass: number, value: EBlendFactor): void
- getBlendDst(pass: number): EBlendFactor
- setBlendDst(pass: number, value: EBlendFactor): void
- getBlendSrcRGB(pass: number): EBlendFactor
- setBlendSrcRGB(pass: number, value: EBlendFactor): void
- getBlendSrcAlpha(pass: number): EBlendFactor
- setBlendSrcAlpha(pass: number, value: EBlendFactor): void
- getBlendDstRGB(pass: number): EBlendFactor
- setBlendDstRGB(pass: number, value: EBlendFactor): void
- getBlendDstAlpha(pass: number): EBlendFactor
- setBlendDstAlpha(pass: number, value: EBlendFactor): void
- getBlendFunc(pass: number): EBlendEquation
- setBlendFunc(pass: number, value: EBlendEquation): void
- getDepthTestOn(pass: number): boolean
- setDepthTestOn(pass: number, value: boolean): void
- getDepthTestComp(pass: number): ECompareFunc
- setDepthTestComp(pass: number, value: ECompareFunc): void
- getDepthWrite(pass: number): boolean
- setDepthWrite(pass: number, value: boolean): void
- getColorWrite(pass: number): number
- setColorWrite(pass: number, value: number): void
- getCullFace(pass: number): ECullMode
- setCullFace(pass: number, value: ECullMode): void
- getCullOn(pass: number): boolean
- setCullOn(pass: number, value: boolean): void
- getPrimitiveType(pass: number): EPrimitiveType
- setPrimitiveType(pass: number, value: EPrimitiveType): void
- getStencilTestOn(pass: number): boolean
- setStencilTestOn(pass: number, value: boolean): void
- getStencilComp(pass: number): ECompareFunc
- setStencilComp(pass: number, value: ECompareFunc): void
- getStencilPass(pass: number): EStencilOp
- setStencilPass(pass: number, value: EStencilOp): void
- getStencilFail(pass: number): EStencilOp
- setStencilFail(pass: number, value: EStencilOp): void
- getStencilZFail(pass: number): EStencilOp
- setStencilZFail(pass: number, value: EStencilOp): void
- getStencilWriteMask(pass: number): number
- setStencilWriteMask(pass: number, value: number): void
- getStencilReadMask(pass: number): number
- setStencilReadMask(pass: number, value: number): void
- getStencilRef(pass: number): number
- setStencilRef(pass: number, value: number): void
- getUseMaterialStates(pass: number): boolean
- setUseMaterialStates(pass: number, value: boolean): void
- getUseMaterialStateBlendOn(pass: number): boolean
- setUseMaterialStateBlendOn(pass: number, value: boolean): void
- getUseMaterialStateBlendSrcRGB(pass: number): boolean
- setUseMaterialStateBlendSrcRGB(pass: number, value: boolean): void
- getUseMaterialStateBlendSrcAlpha(pass: number): boolean
- setUseMaterialStateBlendSrcAlpha(pass: number, value: boolean): void
- getUseMaterialStateBlendDstRGB(pass: number): boolean
- setUseMaterialStateBlendDstRGB(pass: number, value: boolean): void
- getUseMaterialStateBlendDstAlpha(pass: number): boolean
- setUseMaterialStateBlendDstAlpha(pass: number, value: boolean): void
- getUseMaterialStateBlendFunc(pass: number): boolean
- setUseMaterialStateBlendFunc(pass: number, value: boolean): void
- getUseMaterialStateDepthTestOn(pass: number): boolean
- setUseMaterialStateDepthTestOn(pass: number, value: boolean): void
- getUseMaterialStateDepthTestComp(pass: number): boolean
- setUseMaterialStateDepthTestComp(pass: number, value: boolean): void
- getUseMaterialStateDepthWrite(pass: number): boolean
- setUseMaterialStateDepthWrite(pass: number, value: boolean): void
- getUseMaterialStateCullOn(pass: number): boolean
- setUseMaterialStateCullOn(pass: number, value: boolean): void
- getUseMaterialStateCullFace(pass: number): boolean
- setUseMaterialStateCullFace(pass: number, value: boolean): void
- getUseMaterialStatePrimitiveType(pass: number): boolean
- setUseMaterialStatePrimitiveType(pass: number, value: boolean): void
- getUseMaterialStateStencilTestOn(pass: number): boolean
- setUseMaterialStateStencilTestOn(pass: number, value: boolean): void
- getUseMaterialStateStencilTestComp(pass: number): boolean
- setUseMaterialStateStencilTestComp(pass: number, value: boolean): void
- getUseMaterialStateStencilTestPass(pass: number): boolean
- setUseMaterialStateStencilTestPass(pass: number, value: boolean): void
- getUseMaterialStateStencilTestFail(pass: number): boolean
- setUseMaterialStateStencilTestFail(pass: number, value: boolean): void
- getUseMaterialStateStencilTestZFail(pass: number): boolean
- setUseMaterialStateStencilTestZFail(pass: number, value: boolean): void
- getUseMaterialStateColorWrite(pass: number): boolean
- setUseMaterialStateColorWrite(pass: number, value: boolean): void
- showDebugInfo(): string
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/Material' {
- /**
- * Material.ts
- *
- * * @Date : 9/4/2020, 6:41:13 PM
- */
- import {
- EBlendFactor,
- EBlendEquation,
- ECompareFunc,
- ECullMode,
- EStencilOp,
- EPrimitiveType
- } from 'XrFrame/kanata/lib/backend'
- import UniformBlock from 'XrFrame/kanata/lib/frontend/resource/UniformBlock'
- import NativeObject from 'XrFrame/kanata/lib/frontend/shared/NativeObject'
- import Effect from 'XrFrame/kanata/lib/frontend/resource/Effect'
- export default class Material extends NativeObject {
- static OFFSETS: {
- size: number
- renderQueue: number
- effect: number
- uniformBlock: number
- fstencilMask: number
- bstencilMask: number
- blendRGBAMask: number
- colorDepthMask: number
- stateMask: number
- fstencil: number
- bstencil: number
- blendRGBA: number
- colorDepth: number
- state: number
- useInstance: number
- }
- protected _uniforms: UniformBlock
- protected _effect: Effect
- protected _macros: {
- [name: string]: string | number | boolean
- }
- get effect(): Effect
- set effect(value: Effect)
- get uniforms(): UniformBlock
- set uniforms(value: UniformBlock)
- get renderQueue(): number
- set renderQueue(value: number)
- get useInstance(): boolean
- set useInstance(value: boolean)
- get blendOn(): boolean
- set blendOn(value: boolean)
- get blendSrcRGB(): EBlendFactor
- set blendSrcRGB(value: EBlendFactor)
- get blendSrcRGBChanged(): boolean
- get blendSrcAlpha(): EBlendFactor
- set blendSrcAlpha(value: EBlendFactor)
- set blendSrc(value: EBlendFactor)
- get blendDstRGB(): EBlendFactor
- set blendDstRGB(value: EBlendFactor)
- get blendDstRGBChanged(): boolean
- get blendDstAlpha(): EBlendFactor
- set blendDstAlpha(value: EBlendFactor)
- set blendDst(value: EBlendFactor)
- get blendFunc(): EBlendEquation
- set blendFunc(value: EBlendEquation)
- get depthTestOn(): boolean
- set depthTestOn(value: boolean)
- get depthTestComp(): ECompareFunc
- set depthTestComp(value: ECompareFunc)
- get depthWrite(): boolean
- set depthWrite(value: boolean)
- get colorWrite(): number
- set colorWrite(value: number)
- get cullFace(): ECullMode
- set cullFace(value: ECullMode)
- get cullOn(): boolean
- set cullOn(value: boolean)
- get primitiveType(): EPrimitiveType
- set primitiveType(value: EPrimitiveType)
- get stencilTestOn(): boolean
- set stencilTestOn(value: boolean)
- get stencilComp(): ECompareFunc
- set stencilComp(value: ECompareFunc)
- get stencilPass(): EStencilOp
- set stencilPass(value: EStencilOp)
- get stencilFail(): EStencilOp
- set stencilFail(value: EStencilOp)
- get stencilZFail(): EStencilOp
- set stencilZFail(value: EStencilOp)
- get stencilWriteMask(): number
- set stencilWriteMask(value: number)
- get stencilReadMask(): number
- set stencilReadMask(value: number)
- get stencilRef(): number
- set stencilRef(value: number)
- get blendOnMask(): boolean
- set blendOnMask(value: boolean)
- get blendSrcRGBMask(): boolean
- set blendSrcRGBMask(value: boolean)
- get blendSrcAlphaMask(): boolean
- set blendSrcAlphaMask(value: boolean)
- set blendSrcMask(value: boolean)
- get blendDstRGBMask(): boolean
- set blendDstRGBMask(value: boolean)
- get blendDstAlphaMask(): boolean
- set blendDstAlphaMask(value: boolean)
- set blendDstMask(value: boolean)
- get blendFuncMask(): boolean
- set blendFuncMask(value: boolean)
- get depthTestOnMask(): boolean
- set depthTestOnMask(value: boolean)
- get depthTestCompMask(): boolean
- set depthTestCompMask(value: boolean)
- get depthWriteMask(): boolean
- set depthWriteMask(value: boolean)
- get colorWriteMask(): boolean
- set colorWriteMask(value: boolean)
- get cullFaceMask(): boolean
- set cullFaceMask(value: boolean)
- get cullOnMask(): boolean
- set cullOnMask(value: boolean)
- get primitiveTypeMask(): boolean
- set primitiveTypeMask(value: boolean)
- get stencilTestOnMask(): boolean
- set stencilTestOnMask(value: boolean)
- get stencilCompMask(): boolean
- set stencilCompMask(value: boolean)
- get stencilPassMask(): boolean
- set stencilPassMask(value: boolean)
- get stencilFailMask(): boolean
- set stencilFailMask(value: boolean)
- get stencilZFailMask(): boolean
- set stencilZFailMask(value: boolean)
- get stencilWriteMaskMask(): boolean
- set stencilWriteMaskMask(value: boolean)
- get stencilReadMaskMask(): boolean
- set stencilReadMaskMask(value: boolean)
- get stencilRefMask(): boolean
- set stencilRefMask(value: boolean)
- constructor(
- macros?: {
- [name: string]: string | number | boolean
- },
- effect?: Effect,
- uniformBlock?: UniformBlock
- )
- protected _createNativeMat(
- macros?: {
- [name: string]: string | number | boolean
- },
- effect?: Effect,
- uniformBlock?: UniformBlock
- ): void
- changeMacros(macros?: {
- [name: string]: string | number | boolean
- }): void
- getMacro(key: string): string | number | boolean
- clone(uniforms?: UniformBlock): Material
- showDebugInfo(): string
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/RenderPass' {
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- import Texture from 'XrFrame/kanata/lib/frontend/resource/Texture'
- export interface IRenderPassOptions {
- colors: Array<{
- texture: Texture
- slice?: number
- level?: number
- }>
- depth: {
- texture: Texture
- slice?: number
- level?: number
- }
- stencil?: {
- texture: Texture
- slice?: number
- level?: number
- }
- }
- export default class RenderPass extends PureResource {
- static SCREEN_RENDER_PASS: RenderPass
- constructor(options: IRenderPassOptions)
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/SkeletonBoneInverseModel' {
- import DataModel from 'XrFrame/kanata/lib/frontend/resource/DataModel'
- export default class SkeletonBoneInverseModel extends DataModel {
- boneNum: number
- setBoneInverseMatrix(matrices: Float32Array): void
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/Texture' {
- /**
- * Texture.ts
- *
- * * @Date : 9/4/2020, 2:35:42 PM
- */
- import {
- ETextureFormat,
- ETextureType,
- EWrapMode,
- EFilterMode,
- TTextureSource
- } from 'XrFrame/kanata/lib/backend'
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- /**
- * 纹理资源{@link Texture}的创建参数。
- */
- export interface ITextureOptions {
- /**
- * 纹理宽,如果`source`是`IImage`可以不传。
- */
- width?: number
- /**
- * 纹理高,如果`source`是`IImage`可以不传。
- */
- height?: number
- /**
- * @internal
- */
- isWriteOnly?: boolean
- /**
- * @internal
- */
- isRenderTarget?: boolean
- /**
- * @internal
- */
- canvas?: HTMLCanvasElement
- /**
- * 纹理数据源,如果是2D纹理,一般只能有一个元素。如果是`Buffer`类型数据,比如压缩纹理,则需要和`offsets`配合使用,一般用于`mipmaps`的场合。
- * 如果是立方体纹理,则有六个元素。
- */
- source?: TTextureSource[]
- /**
- * 当`source`为`Buffer`纹理并且拥有`mipmaps`之类的时,标记如何切割数据。
- * 规则是: off1, size1, off2, size2......
- */
- offsets?: Uint32Array
- /**
- * 纹理类型。
- */
- type?: ETextureType
- /**
- * 纹理有多少切片,比如立方体纹理就为`6`。
- */
- slices?: number
- /**
- * 纹理有多少级`mipmap`。
- */
- mips?: number
- /**
- * 纹理的像素格式。
- */
- pixelFormat?: ETextureFormat
- minFilter?: EFilterMode
- magFilter?: EFilterMode
- /**
- * 是否要自动生成`mipmaps`,仅对非压缩纹理有效。
- */
- generateMipmaps?: boolean
- wrapU?: EWrapMode
- wrapV?: EWrapMode
- wrapW?: EWrapMode
- /**
- * 各向异性等级。
- */
- anisoLevel?: number
- /**
- * @internal
- */
- sampleCount?: number
- }
- /**
- * 纹理资源。
- */
- export default class Texture extends PureResource {
- get type(): ETextureType
- get width(): number
- get height(): number
- get slice(): number
- get mips(): number
- get pixelFormat(): ETextureFormat
- get wrapU(): EWrapMode
- set wrapU(value: EWrapMode)
- get wrapV(): EWrapMode
- set wrapV(value: EWrapMode)
- get wrapW(): EWrapMode
- set wrapW(value: EWrapMode)
- get magFilter(): EFilterMode
- set magFilter(value: EFilterMode)
- get minFilter(): EFilterMode
- set minFilter(value: EFilterMode)
- get anisoLevel(): number
- set anisoLevel(value: number)
- get sampleCount(): number
- set sampleCount(value: number)
- get generateMipmaps(): boolean
- set generateMipmaps(value: boolean)
- get isRenderTarget(): boolean
- set isRenderTarget(value: boolean)
- constructor(options: ITextureOptions)
- /**
- * 在创建了纹理后,可以用此方法来更新。
- */
- update(options: {
- /**
- * `mipmap`等级。
- */
- level?: number
- /**
- * 切片。
- */
- slice?: number
- /**
- * x向偏移。
- */
- xoffset?: number
- /**
- * x向偏移。
- */
- yoffset?: number
- /**
- * @internal。
- */
- zoffset?: number
- /**
- * 宽,相对于x偏移。
- */
- width?: number
- /**
- * 高,相对于y偏移。
- */
- height?: number
- /**
- * 数据。
- */
- buffer: TTextureSource
- }): void
- showDebugInfo(): string
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/UniformBlock' {
- /**
- * UniformBlock.ts
- *
- * * @Date : 9/4/2020, 2:34:36 PM
- */
- import { IHandle } from 'XrFrame/kanata/lib/backend'
- import UniformDescriptor from 'XrFrame/kanata/lib/frontend/resource/UniformDescriptor'
- import Texture from 'XrFrame/kanata/lib/frontend/resource/Texture'
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- /**
- * 存储Uniform的一个区块。
- */
- export default class UniformBlock extends PureResource {
- /**
- * @internal
- */
- static CREATE_FAKE(descriptor: UniformDescriptor): FakeUniformBlock
- /**
- * @internal
- */
- /**
- * 描述符。
- */
- get descriptor(): UniformDescriptor
- /**
- * @internal
- */
- get textures(): {
- [name: string]: Texture
- }
- /**
- * @param descriptor 描述符。
- */
- constructor(descriptor: UniformDescriptor)
- protected _createNativeObj(descriptor: UniformDescriptor): IHandle
- /**
- * 是否包含某个成员uniform。
- */
- hasKey(key: string): boolean
- /**
- * 设置某个成员uniform。
- */
- setUniform(
- key: string,
- value: ArrayLike<number> | Texture | number
- ): boolean
- /**
- * 获取某个成员uniform。
- * 如果是返回`number`,则是纹理的id。
- */
- getUniform(key: string): Float32Array | number
- /**
- * 获取某个成员uniform的texture实例。
- */
- getTexture(key: string): Texture
- /**
- * @internal
- */
- /**
- * @internal
- */
- setAllData(data: Float32Array): void
- /**
- * 科隆某个uniform。
- */
- clone(): UniformBlock
- /**
- * 复制某个uniform。
- */
- copy(ub: UniformBlock): void
- showDebugInfo(): string
- }
- class FakeUniformBlock extends UniformBlock {
- protected _createNativeObj(descriptor: UniformDescriptor): {
- id: number
- data: ArrayBuffer
- }
- }
- export {}
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/UniformDescriptor' {
- /**
- * UniformDescriptor.ts
- *
- * * @Date : 9/4/2020, 2:34:50 PM
- */
- import {
- EUniformType,
- IUniformDescriptorOptions
- } from 'XrFrame/kanata/lib/backend'
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- /**
- * UniformBlock描述符。
- */
- export default class UniformDescriptor extends PureResource {
- /**
- * @internal
- */
- get layout(): {
- [key: string]: [
- EUniformType,
- number,
- number,
- number,
- EUniformType,
- boolean
- ]
- }
- /**
- * 以Float计的长度。
- */
- get size(): number
- constructor(options: IUniformDescriptorOptions)
- /**
- * @internal
- */
- hasKey(key: string): boolean
- /**
- * @internal
- */
- setUniform(
- key: string,
- value: ArrayLike<number> | number,
- f32: Float32Array,
- u32: Uint32Array
- ): void
- /**
- * @internal
- */
- getUniform(
- key: string,
- f32: Float32Array,
- u32: Uint32Array
- ): Float32Array | number
- /**
- * @internal
- */
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/IndexBuffer' {
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- export default class IndexBuffer extends PureResource {
- get byteSize(): number
- constructor(buffer: ArrayBuffer | ArrayBufferView, is32bits?: boolean)
- update(buffer: ArrayBuffer | ArrayBufferView, offset: number): void
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/IndexData' {
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- export default class IndexData extends PureResource {
- get data(): ArrayBuffer
- constructor(size: number)
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/VertexBuffer' {
- import VertexLayout from 'XrFrame/kanata/lib/frontend/resource/VertexLayout'
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- /**
- * 顶点数据。
- */
- export default class VertexBuffer extends PureResource {
- get byteSize(): number
- get layout(): VertexLayout
- constructor(buffer: ArrayBuffer | ArrayBufferView, layout: VertexLayout)
- update(buffer: ArrayBuffer | ArrayBufferView, offset: number): void
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/VertexData' {
- /**
- * VertexData.ts
- *
- * * @Date : 9/11/2020, 4:43:52 PM
- */
- import VertexDataDescriptor from 'XrFrame/kanata/lib/frontend/resource/VertexDataDescriptor'
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- import VertexLayout from 'XrFrame/kanata/lib/frontend/resource/VertexLayout'
- /**
- * 用于合批的顶点数据。
- */
- export default class VertexData extends PureResource {
- get layout(): VertexLayout
- get data(): ArrayBuffer
- constructor(
- layout: VertexLayout,
- size: number,
- batchDesc: VertexDataDescriptor
- )
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/VertexLayout' {
- /**
- * VertexLayout.ts
- *
- * * @Date : 9/4/2020, 5:01:51 PM
- */
- import {
- IVertexLayoutOptions,
- EVertexLayoutUsage
- } from 'XrFrame/kanata/lib/backend'
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- /**
- * 顶点布局描述。
- */
- export default class VertexLayout extends PureResource {
- /**
- * 顶点数据单位步长。
- */
- get stride(): number
- constructor(options: IVertexLayoutOptions)
- /**
- * 获取某个属性的配置。
- */
- getConfigByName(name: string): {
- name: string
- format: import('XrFrame/kanata/lib/backend').EVertexFormat
- offset: number
- usage: EVertexLayoutUsage
- }
- /**
- * 获取某个用途的属性的配置。
- */
- getConfigByUsage(usage: EVertexLayoutUsage): {
- name: string
- format: import('XrFrame/kanata/lib/backend').EVertexFormat
- offset: number
- usage: EVertexLayoutUsage
- }
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/VertexDataDescriptor' {
- /**
- * VertexDataDescriptor.ts
- *
- * * @Date : 4/28/2021, 4:38:37 PM
- */
- import { IVertexDataDescriptorOptions } from 'XrFrame/kanata/lib/backend'
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- /**
- * 用于合批的顶点数据的描述符。
- */
- export default class VertexDataDescriptor extends PureResource {
- constructor(options: IVertexDataDescriptorOptions)
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/View' {
- /**
- * View.ts
- *
- * * @Date : 9/4/2020, 6:43:18 PM
- */
- import { IRect, IViewAction } from 'XrFrame/kanata/lib/backend'
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- /**
- * 视图,用于控制清屏、视图区域等配置。
- */
- export default class View extends PureResource {
- constructor(options: {
- passAction: IViewAction
- viewport: IRect
- scissor: IRect
- })
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/resource/ScalableList' {
- import PureResource from 'XrFrame/kanata/lib/frontend/shared/PureResource'
- export const SL_MAP: Set<ScalableList>
- export function CHECK_SLS_RESIZE(): void
- export function CLEAR_SLS(): void
- /**
- * 可扩容列表,用于存储Mesh的剔除结果以及绘制数据的id。
- */
- export default class ScalableList extends PureResource {
- /**
- * 当前全部可用的大小。
- */
- get size(): number
- /**
- * 存储的id集合。
- */
- get dataView(): Uint32Array
- /**
- * 当前已用的大小,一般不需要自己设置。
- */
- get usedSize(): number
- set usedSize(value: number)
- constructor(initSize: number)
- /**
- * 扩容,将会扩大两倍,一般不需要自己调用。
- *
- * @param deprecatedSize will always be current size, don't use it!
- */
- enlarge(deprecatedSize?: number): void
- /**
- * 初始化到准备`add`的阶段。
- */
- begin(): void
- /**
- * 添加一个数据。
- *
- * @param deprecatedEnlargeSize will always be current size, don't use it!
- */
- add(id: number, deprecatedEnlargeSize?: number): void
- /**
- * 结束此次所有`add`的流程。
- */
- end(): void
- /**
- * 清空整个列表。
- */
- reset(): void
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/shared/crossContext' {
- /**
- * 跨域信息通道,用于主域和子域之间的通信。
- */
- class CrossContext {
- constructor()
- postMessage(data: any): void
- onMessage(callback: (data: any) => void): void
- flush(): void
- }
- let crossContext: CrossContext
- export default crossContext
- }
- declare module 'XrFrame/components/particle/gradient' {
- import Vector3 from 'XrFrame/math/vector3'
- import Vector4 from 'XrFrame/math/vector4'
- export class ColorGradient {
- gradient: number
- color: Vector4
- color2: Vector4
- constructor(gradient: any, color: any, color2: any)
- /**
- * 获取具体颜色属性值
- * @param {Vector4} 用于存储结果的临时变量
- */
- getColor(colorTemp: Vector4): void
- }
- export class Color3Gradient {
- gradient: number
- color: Vector3
- constructor(gradient: any, color: any)
- }
- export class FactorGradient {
- gradient: number
- factor: number
- factor2: number
- constructor(gradient: any, factor: any, factor2: any)
- /**
- * 获取具体属性值
- * @return {number} 插值后的属性大小
- */
- getFactor(): number
- }
- export class BasicGradientMethod {
- /**
- * 从获取具体时刻的属性大小
- * @param {number} ratio 粒子所处生命周期的阶段
- * @param {Array} gradients 存储不同时刻指定属性变化的数组
- * @param {Callback} updateFunc 回调函数
- */
- static GetCurrentGradient(
- ratio: any,
- gradients: any,
- updateFunc: any
- ): void
- }
- }
- declare module 'XrFrame/components/emitter/BoxShapeEmitter' {
- import Vector3 from 'XrFrame/math/vector3'
- import { BasicShapeEmitter } from 'XrFrame/components/emitter/BasicShapeEmitter'
- export default class BoxShapeEmitter extends BasicShapeEmitter {
- direction: Vector3
- direction2: Vector3
- minEmitBox: Vector3
- maxEmitBox: Vector3
- constructor()
- startDirection(worldMatrix: any, direction: any): void
- startPosition(worldMatrix: any, position: Vector3): void
- }
- }
- declare module 'XrFrame/components/emitter/PointShapeEmitter' {
- import Vector3 from 'XrFrame/math/vector3'
- import { BasicShapeEmitter } from 'XrFrame/components/emitter/BasicShapeEmitter'
- export default class PointShapeEmitter extends BasicShapeEmitter {
- /**
- * 粒子运动方向左区间。
- */
- direction: Vector3
- /**
- * 粒子运动方向右区间。
- */
- direction2: Vector3
- constructor()
- startDirection(worldMatrix: any, direction: any): void
- startPosition(worldMatrix: any, position: Vector3): void
- }
- }
- declare module 'XrFrame/components/emitter/DrawShapeEmitter' {
- import Vector3 from 'XrFrame/math/vector3'
- import ParticleInstance from 'XrFrame/components/particle/ParticleInstance'
- import { BasicShapeEmitter } from 'XrFrame/components/emitter/BasicShapeEmitter'
- export default class DrawShapeEmitter extends BasicShapeEmitter {
- direction: Vector3
- constructor()
- setContent(content: any, step?: number): void
- translateBase64ToArrayBuffer(base64: any): ArrayBufferLike
- startDirection(worldMatrix: any, direction: any): void
- startPosition(worldMatrix: any, position: Vector3): void
- processInstance(instance: ParticleInstance, deltaTime: number): void
- lerpNumberArrayToVector(
- vector: any,
- numberArray1: any,
- numberArray2: any,
- step: any,
- length?: number
- ): void
- }
- }
- declare module 'XrFrame/components/emitter/SphereShapeEmitter' {
- import Vector3 from 'XrFrame/math/vector3'
- import { BasicShapeEmitter } from 'XrFrame/components/emitter/BasicShapeEmitter'
- import Matrix4 from 'XrFrame/math/matrix4'
- export default class SphereShapeEmitter extends BasicShapeEmitter {
- /**
- * 球形半径
- */
- radius: number
- /**
- * 球形区域覆盖范围[0-1]
- */
- radiusRange: number
- /**
- * 粒子在球形内生成的角度区间[0-360]
- */
- arc: number
- /**
- * 粒子运动方向偏离程度[0-1]
- */
- randomizeDirection: number
- constructor()
- startDirection(
- worldMatrix: Matrix4,
- direction: Vector3,
- position: Vector3
- ): void
- startPosition(worldMatrix: Matrix4, position: Vector3): void
- }
- }
- declare module 'XrFrame/components/emitter/ConeShapeEmitter' {
- import Vector3 from 'XrFrame/math/vector3'
- import { BasicShapeEmitter } from 'XrFrame/components/emitter/BasicShapeEmitter'
- export default class ConeShapeEmitter extends BasicShapeEmitter {
- /**
- * [0-1]
- */
- radiusRange: number
- heightRange: number
- /**
- * [0-360]
- */
- arc: number
- /**
- * randomize the particle direction [0-1]
- */
- randomizeDirection: number
- get radius(): number
- set radius(value: number)
- get angle(): number
- set angle(value: number)
- updateHeight(): void
- constructor()
- startDirection(
- worldMatrix: any,
- direction: any,
- position: Vector3
- ): void
- startPosition(worldMatrix: any, position: Vector3): void
- }
- }
- declare module 'XrFrame/components/emitter/CircleShapeEmitter' {
- import Vector3 from 'XrFrame/math/vector3'
- import { BasicShapeEmitter } from 'XrFrame/components/emitter/BasicShapeEmitter'
- import Matrix4 from 'XrFrame/math/matrix4'
- export default class CircleShapeEmitter extends BasicShapeEmitter {
- radius: number
- radiusRange: number
- direction: Vector3
- direction2: Vector3
- arc: number
- angle: number
- constructor()
- startDirection(
- worldMatrix: Matrix4,
- direction: Vector3,
- position: Vector3
- ): void
- startPosition(worldMatrix: any, position: Vector3): void
- }
- }
- declare module 'XrFrame/render-graph/RGNode' {
- /**
- * RGNode.ts
- *
- * * @Date : 1/13/2021, 8:29:55 PM
- */
- import { Kanata } from 'XrFrame/ext'
- import Camera from 'XrFrame/components/Camera'
- import { IRenderTarget } from 'XrFrame/assets/RenderTexture'
- type RenderGraph = import('XrFrame/render-graph/RenderGraph').default
- type RenderSystem = import('XrFrame/systems/RenderSystem').default
- type Scene = import('XrFrame/core/Scene').default
- export type TRGNodeAny = RGNode<any, any, any>
- /**
- * RGNode支持传输的数据类型。
- * 可扩展。
- *
- * @category Render
- */
- export interface IRGData {
- /**
- * 空数据类型。
- */
- None: void
- /**
- * 相机类型。
- */
- Camera: Camera
- /**
- * 渲染目标类型。
- */
- RenderTarget: IRenderTarget
- /**
- * Mesh列表,一般作为剔除节点的输出,作为渲染节点的输入。
- */
- MeshList: Kanata.ScalableList
- }
- /**
- * RGNode支持的节点类型。
- */
- export enum ERGNodeType {
- Camera = 'Camera',
- Clear = 'Clear',
- Cull = 'Cull',
- Render = 'Render',
- Script = 'Script'
- }
- /**
- * 渲染节点基类。
- */
- export default abstract class RGNode<
- TInputs extends {
- [key: string]: keyof IRGData
- },
- TOutput extends keyof IRGData,
- IOptions
- > {
- protected _parent: RenderGraph
- protected _id: number
- protected _name: string
- protected _options: IOptions
- /**
- * 节点类型。
- *
- * @internal
- */
- type: ERGNodeType
- /**
- * 节点输入的数据类型。
- */
- abstract inputTypes: TInputs
- /**
- * 节点输出的数据类型。
- */
- abstract outputType: TOutput
- protected _output?: IRGData[TOutput]
- protected _inputs: {
- [key: string]: TRGNodeAny
- }
- protected _outputs: {
- [id: number]: string
- }
- /**
- * 节点的初始化配置参数。
- */
- get options(): IOptions
- /**
- * 节点名字。
- */
- get name(): string
- /**
- * 节点id。
- */
- get id(): number
- /**
- * 获取当前游戏实例。
- */
- get scene(): Scene
- /**
- * 获取当前节点输出。
- */
- get output(): IRGData[TOutput]
- /**
- * 不要直接调用,请使用`renderGraph.createNode`方法。
- */
- constructor(
- _parent: RenderGraph,
- _id: number,
- _name: string,
- _options: IOptions
- )
- /**
- * 节点初始化后的回调。
- */
- onInit(options: IOptions): void
- /**
- * 获取某个节点的输入。
- */
- getInput<TKey extends keyof TInputs>(key: TKey): IRGData[TInputs[TKey]]
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * @internal
- */
- /**
- * 重置节点状态,清空输入,一般用于可缓存的节点优化。
- */
- reset(): void
- /**
- * 节点在真正被第一次使用时的回调。
- */
- onActive(context: RenderSystem, options: IOptions): void
- /**
- * 节点在每帧执行时的回调。
- */
- onExecute(context: RenderSystem, options: IOptions): void
- /**
- * 节点在被图中移除时的回调。
- */
- onDisable(context: RenderSystem, options: IOptions): void
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/animations/GLTFAnimationNode' {
- import { Kanata } from 'XrFrame/ext'
- import { GLTFAccessorsLoaded } from 'XrFrame/loader/glTF/buffers/GLTFAccessorsNode'
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFNodesLoaded } from 'XrFrame/loader/glTF/scenes/GLTFNodesNode'
- import { GLTF } from 'XrFrame/loader/glTF/utils/types'
- import {
- GLTFChannelsLoaded,
- GLTFChannelsNodeRaw
- } from 'XrFrame/loader/glTF/animations/channels/GLTFChannelsNode'
- import { GLTFSamplersNodeRaw } from 'XrFrame/loader/glTF/animations/samplers/GLTFSamplersNode'
- /**
- * 二进制格式
- * | contentoffset | fps(float) | totalFrame | totalSampleGroup |
- * | Array<PuppetAnimationSampleGroup> |
- *
- * @see PuppetAnimationSampleGroup at GLTFChannelNode.ts
- */
- export type PuppetAnimationClipModel = ArrayBuffer | GLTF.BufferView
- export interface GLTFAnimationNodeRaw {
- channels: GLTFChannelsNodeRaw
- samplers: GLTFSamplersNodeRaw
- name?: string
- extras?: any
- }
- export interface GLTFAnimationLoaded {
- clip: Kanata.AnimationClipModel
- channels: GLTFChannelsLoaded
- frameCount: number
- name?: string
- extras?: any
- }
- export default class GLTFAnimationNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFAnimationNodeRaw
- resource: GLTFAnimationLoaded | null
- build(): void
- preload(
- prerequisites: [
- accessors: GLTFAccessorsLoaded,
- nodes: GLTFNodesLoaded
- ]
- ): Promise<GLTFAnimationLoaded>
- getLoadedResource(): GLTFAnimationLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/buffers/GLTFAccessorNode' {
- import { GLTF } from 'XrFrame/loader/glTF/utils/types'
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFBufferViewLoaded } from 'XrFrame/loader/glTF/buffers/GLTFBufferViewNode'
- import { GLTFBufferViewsLoaded } from 'XrFrame/loader/glTF/buffers/GLTFBufferViewsNode'
- export enum EnumGLTFAccessorComponentType {
- BYTE = 5120,
- UNSIGNED_BYTE = 5121,
- SHORT = 5122,
- UNSIGNED_SHORT = 5123,
- UNSIGNED_INT = 5125,
- FLOAT = 5126
- }
- export const GLTFAccessorComponentTypeToViewClass: {
- 5120: Int8ArrayConstructor
- 5121: Uint8ArrayConstructor
- 5122: Int16ArrayConstructor
- 5123: Uint16ArrayConstructor
- 5125: Uint32ArrayConstructor
- 5126: Float32ArrayConstructor
- }
- export const GLTFAccessorTypeToNumberOfElements: {
- SCALAR: number
- VEC2: number
- VEC3: number
- VEC4: number
- MAT2: number
- MAT3: number
- MAT4: number
- }
- export interface GLTFAccessorNodeRaw {
- bufferView?: number
- byteOffset?: number
- componentType: number
- count: number
- min?: number[]
- max?: number[]
- type: string
- normalized?: boolean
- sparse?: boolean
- name?: string
- extras?: any
- }
- /**
- * 以FloatVec3为例:
- * 一个component指一个float,
- * 一个element指三个float。
- */
- export interface GLTFAccessorLoaded {
- bufferView: GLTFBufferViewLoaded
- bufferViewIndex: number
- view: GLTF.BufferView
- elementLength: number
- bytesPerComponent: number
- count: number
- stride: number
- byteStride: number
- componentType: EnumGLTFAccessorComponentType
- max?: number[]
- min?: number[]
- compact: boolean
- extras?: any
- getCompAt(element: number, comp: number): any
- }
- export default class GLTFAccessorNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFAccessorNodeRaw
- build(): void
- preload(
- prerequisites: [GLTFBufferViewsLoaded]
- ): Promise<GLTFAccessorLoaded>
- getLoadedResource(): GLTFAccessorLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/buffers/GLTFBufferNode' {
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- export interface GLTFBufferNodeRaw {
- uri?: string
- byteLength: number
- name?: string
- extras?: any
- }
- export interface GLTFBufferLoaded {
- buffer: ArrayBuffer
- extras?: any
- }
- export default class GLTFBufferNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFBufferNodeRaw
- protected resource: GLTFBufferLoaded | null
- build(): void
- preload(): Promise<GLTFBufferLoaded>
- getLoadedResource(): GLTFBufferLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/buffers/GLTFBufferViewNode' {
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFBuffersLoaded } from 'XrFrame/loader/glTF/buffers/GLTFBuffersNode'
- export interface GLTFBufferViewNodeRaw {
- buffer: number
- byteLength: number
- byteOffset?: number
- byteStride?: number
- target?: EnumGLTFBufferViewTarget
- name?: string
- extras?: any
- }
- export interface GLTFBufferViewLoaded {
- data: ArrayBuffer
- byteOffset: number
- byteStride: number
- byteLength: number
- target: EnumGLTFBufferViewTarget
- extras?: any
- getSlicedData(): ArrayBuffer
- getUint8View(): Uint8Array
- _sliced: ArrayBuffer
- }
- export enum EnumGLTFBufferViewTarget {
- ARRAY_BUFFER = 34962,
- ELEMENT_ARRAY_BUFFER = 34963
- }
- export default class GLTFBufferViewNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFBufferViewNodeRaw
- build(): void
- preload(
- prerequisites: [GLTFBuffersLoaded]
- ): Promise<GLTFBufferViewLoaded>
- getLoadedResource(): GLTFBufferViewLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/geometry/GLTFMeshNode' {
- import { Kanata } from 'XrFrame/ext'
- import { GLTFAccessorsLoaded } from 'XrFrame/loader/glTF/buffers/GLTFAccessorsNode'
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFMaterialsLoaded } from 'XrFrame/loader/glTF/materials/GLTFMaterialsNode'
- import {
- GLTFPrimitivesLoaded,
- GLTFPrimitivesNodeRaw
- } from 'XrFrame/loader/glTF/geometry/primitives/GLTFPrimitivesNode'
- export interface GLTFMeshNodeRaw {
- primitives: GLTFPrimitivesNodeRaw
- weights?: number[]
- name?: string
- extras?: any
- }
- export interface GLTFMeshLoaded {
- subMeshes: GLTFPrimitivesLoaded
- weights: number[]
- name?: string
- extras?: any
- }
- export default class GLTFMeshNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFMeshNodeRaw
- build(): void
- preload(
- prerequisites: [
- materials: GLTFMaterialsLoaded,
- accessors: GLTFAccessorsLoaded,
- vbMap: Map<string, [ArrayBuffer, Kanata.VertexLayout, object]>
- ]
- ): Promise<GLTFMeshLoaded>
- getLoadedResource(): GLTFMeshLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/materials/GLTFMaterialNode' {
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import GLTFTextureInfoNode, {
- GLTFTextureInfoNodeRaw
- } from 'XrFrame/loader/glTF/materials/texture/GLTFTextureInfoNode'
- import GLTFPBRMetallicRoughnessNode, {
- GLTFPBRMetallicRoughnessNodeRaw
- } from 'XrFrame/loader/glTF/materials/pbr/GLTFPBRMetallicRoughnessNode'
- import GLTFNormalTextureInfoNode, {
- GLTFNormalTextureInfoNodeRaw
- } from 'XrFrame/loader/glTF/materials/texture/GLTFNormalTextureInfoNode'
- import GLTFOcclusionTextureInfoNode, {
- GLTFOcclusionTextureInfoNodeRaw
- } from 'XrFrame/loader/glTF/materials/texture/GLTFOcclusionTextureInfoNode'
- import Material from 'XrFrame/assets/Material'
- import { IRenderStates } from 'XrFrame/assets/Effect'
- import { GLTFTexturesLoaded } from 'XrFrame/loader/glTF/textures/GLTFTexturesNode'
- export interface GLTFMaterialExtArgs {
- uniform: object
- renderStates: IRenderStates
- macros: object
- }
- export enum EnumGLTFMaterialAlphaMode {
- OPAQUE = 0,
- MASK = 1,
- BLEND = 2
- }
- export interface GLTFMaterialNodeRaw {
- name?: string
- pbrMetallicRoughness?: GLTFPBRMetallicRoughnessNodeRaw
- normalTexture?: GLTFNormalTextureInfoNodeRaw
- occlusionTexture?: GLTFOcclusionTextureInfoNodeRaw
- emissiveTexture?: GLTFTextureInfoNodeRaw
- emissiveFactor?: [number, number, number]
- alphaMode?: string
- alphaCutoff?: number
- doubleSided?: boolean
- extras?: any
- }
- export type GLTFMaterialPrerequisites = [textrues: GLTFTexturesLoaded]
- export interface GLTFMaterialLoaded {
- material: Material
- extras?: any
- }
- export default class GLTFMaterialNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFMaterialNodeRaw
- resource: GLTFMaterialLoaded | null
- pbrMetallicRoughness: GLTFPBRMetallicRoughnessNode | undefined
- normalTexture: GLTFNormalTextureInfoNode | undefined
- occlusionTexture: GLTFOcclusionTextureInfoNode | undefined
- emissiveTexture: GLTFTextureInfoNode | undefined
- build(): void
- /**
- * @internal
- */
- preloadWithoutPBR(
- prerequisites: GLTFMaterialPrerequisites
- ): Promise<GLTFMaterialExtArgs>
- /**
- * 实际上不一定会走到这里,mesh没有material也是合法的,这时候会去取emptyMaterial。
- */
- preload(
- prerequisites: [textrues: GLTFTexturesLoaded]
- ): Promise<GLTFMaterialLoaded>
- getLoadedResource(): GLTFMaterialLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/skins/GLTFSkinNode' {
- import { Kanata } from 'XrFrame/ext'
- import { GLTFAccessorsLoaded } from 'XrFrame/loader/glTF/buffers/GLTFAccessorsNode'
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- export interface GLTFSkinNodeRaw {
- inverseBindMatrices?: number
- skeleton?: number
- joints: number[]
- extras?: any
- }
- export interface GLTFSkinLoaded {
- inverseBindMatrices: Kanata.SkeletonBoneInverseModel
- skeleton?: number
- joints: number[]
- extras?: any
- }
- export default class GLTFSkinNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFSkinNodeRaw
- resource: GLTFSkinLoaded | null
- build(): void
- preload(
- prerequisites: [accessors: GLTFAccessorsLoaded]
- ): Promise<GLTFSkinLoaded>
- getLoadedResource(): GLTFSkinLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/textures/GLTFImageNode' {
- import { Kanata } from 'XrFrame/ext'
- import { GLTFBufferViewsLoaded } from 'XrFrame/loader/glTF/buffers/GLTFBufferViewsNode'
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- export interface GLTFImageNodeRaw {
- uri?: string
- mimeType?: string
- bufferView?: number
- name?: string
- extras?: any
- }
- export interface GLTFImageLoaded {
- kanataImage?: Kanata.IImage
- type?: string
- extras?: any
- }
- export type GLTFImageNodePrerequisites = [
- bufferViews: GLTFBufferViewsLoaded
- ]
- export default class GLTFImageNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFImageNodeRaw
- protected resource: GLTFImageLoaded | null
- build(): void
- preload(
- prerequisites: GLTFImageNodePrerequisites
- ): Promise<GLTFImageLoaded>
- getLoadedResource(): GLTFImageLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/textures/GLTFSamplerNode' {
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- export enum EnumGLTFSamplerFilter {
- NEAREST = 9728,
- LINEAR = 9729,
- NEAREST_MIPMAP_NEAREST = 9984,
- LINEAR_MIPMAP_NEAREST = 9985,
- NEAREST_MIPMAP_LINEAR = 9986,
- LINEAR_MIPMAP_LINEAR = 9987
- }
- export function NeedMipmap(sampler: EnumGLTFSamplerFilter): boolean
- export enum EnumGLTFSamplerWrap {
- CLAMP_TO_EDGE = 33071,
- MIRRORED_REPEAT = 33648,
- REPEAT = 10497
- }
- export interface GLTFSamplerNodeRaw {
- magFilter?: number
- minFilter?: number
- wrapS?: number
- wrapT?: number
- name?: string
- extras?: any
- }
- export interface GLTFSamplerLoaded {
- magFilter: EnumGLTFSamplerFilter
- minFilter: EnumGLTFSamplerFilter
- wrapS: EnumGLTFSamplerWrap
- wrapT: EnumGLTFSamplerWrap
- extras?: any
- }
- export default class GLTFSamplerNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFSamplerNodeRaw
- build(): void
- preload(): Promise<GLTFSamplerLoaded>
- getLoadedResource(): GLTFSamplerLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/textures/GLTFTextureNode' {
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFImagesLoaded } from 'XrFrame/loader/glTF/textures/GLTFImagesNode'
- import { GLTFSamplersLoaded } from 'XrFrame/loader/glTF/textures/GLTFSamplersNode'
- import { Kanata } from 'XrFrame/ext'
- export interface GLTFTextureNodeRaw {
- sampler?: number
- source?: number
- name?: string
- extras?: any
- }
- export interface GLTFTextureLoaded {
- texture: Kanata.Texture
- extras?: any
- }
- export default class GLTFTextureNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFTextureNodeRaw
- build(): void
- preload(
- prerequisites: [
- images: GLTFImagesLoaded,
- samplers: GLTFSamplersLoaded
- ]
- ): Promise<GLTFTextureLoaded>
- getLoadedResource(): GLTFTextureLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/animations/channels/GLTFTargetNode' {
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import {
- GLTFNodesLoaded,
- GLTFTreeNode
- } from 'XrFrame/loader/glTF/scenes/GLTFNodesNode'
- export enum GLTFEnumAnimationTargetPath {
- TRANSLATION = 0,
- ROTATION = 1,
- SCALE = 2,
- WEIGHTS = 3
- }
- export interface GLTFTargetNodeRaw {
- node?: number
- path: 'translation' | 'rotation' | 'scale' | 'weights'
- extras?: any
- }
- export interface GLTFTargetLoaded {
- node: GLTFTreeNode | null
- path: GLTFEnumAnimationTargetPath
- extras?: any
- }
- export default class GLTFTargetNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFTargetNodeRaw
- build(): void
- preload(
- prerequisites: [nodes: GLTFNodesLoaded]
- ): Promise<GLTFTargetLoaded>
- getLoadedResource(): GLTFTargetLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/geometry/primitives/attributes/GLTFAttributesNode' {
- import { GLTFAccessorsLoaded } from 'XrFrame/loader/glTF/buffers/GLTFAccessorsNode'
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTF } from 'XrFrame/loader/glTF/utils/types'
- import { GLTFTargetsLoaded } from 'XrFrame/loader/glTF/geometry/primitives/targets/GLTFTargetsNode'
- /**
- * GLTF.Attributes.Name -> Kanata.Layout.Name
- */
- export function convertAttributeName(name: string): string
- /**
- * GLTF.Attributes.Name -> Kanata.Layout.Format
- * 在shader里不同用途的attribute的长度是固定的,无论他用的accessor实际元素的长度是多少
- */
- export function getComponentCountFromAttributeName(name: string): number
- /**
- * GLTF.Attributes.Name -> Shader Macros
- */
- export function genMacrosByAttrib(name: string, macros: object): void
- export interface GLTFAttributesExtArgs {
- trust?: boolean
- check?: boolean
- }
- export type GLTFAttributesNodeRaw = {
- [attribName: string]: number
- }
- export type GLTFAttributesLoaded = GLTF.VertexProperties
- export default class GLTFAttributesNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFAttributesNodeRaw
- build(): void
- preload(
- prerequisites: [
- targets: GLTFTargetsLoaded,
- materials: any,
- accessors: GLTFAccessorsLoaded,
- vbMap: Map<string, GLTF.VertexProperties>
- ]
- ): Promise<GLTFAttributesLoaded>
- getLoadedResource(): GLTFAttributesLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/geometry/primitives/GLTFPrimitiveNode' {
- import Geometry from 'XrFrame/assets/Geometry'
- import { GLTFAccessorsLoaded } from 'XrFrame/loader/glTF/buffers/GLTFAccessorsNode'
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFAttributesNodeRaw } from 'XrFrame/loader/glTF/geometry/primitives/attributes/GLTFAttributesNode'
- import { GLTFMaterialsLoaded } from 'XrFrame/loader/glTF/materials/GLTFMaterialsNode'
- import Material from 'XrFrame/assets/Material'
- import { GLTFAccessorLoaded } from 'XrFrame/loader/glTF/buffers/GLTFAccessorNode'
- import { GLTF } from 'XrFrame/loader/glTF/utils/types'
- import { GLTFTargetsNodeRaw } from 'XrFrame/loader/glTF/geometry/primitives/targets/GLTFTargetsNode'
- export enum EnumGLTFPrimitiveMode {
- POINTS = 0,
- LINES = 1,
- LINE_LOOP = 2,
- LINE_STRIP = 3,
- TRIANGLES = 4,
- TRIANGLE_STRIP = 5,
- TRIANGLE_FAN = 6
- }
- export interface GLTFPrimitiveNodeRaw {
- attributes: GLTFAttributesNodeRaw
- indices?: number
- material?: number
- mode?: number
- targets?: GLTFTargetsNodeRaw
- extras?: any
- }
- export interface GLTFPrimitiveLoaded {
- geometry: Geometry
- material: Material
- extras?: any
- }
- export type GLTFPrimitivePrerequisites = [
- materials: GLTFMaterialsLoaded,
- accessors: GLTFAccessorsLoaded,
- vbMap: Map<string, GLTF.VertexProperties>
- ]
- export interface GLTFPrimitiveVertexExtArgs {
- vbInfo: GLTF.VertexProperties
- }
- export interface GLTFPrimitiveIndexExtArgs {
- accessor: GLTFAccessorLoaded
- }
- export default class GLTFPrimitiveNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFPrimitiveNodeRaw
- build(): void
- preload(
- prerequisites: GLTFPrimitivePrerequisites
- ): Promise<GLTFPrimitiveLoaded>
- getLoadedResource(): GLTFPrimitiveLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/utils/types' {
- import { ITransformData } from 'XrFrame/components'
- import { Kanata } from 'XrFrame/ext'
- import Quaternion from 'XrFrame/math/quaternion'
- import Vector3, { Vector3ReadOnly } from 'XrFrame/math/vector3'
- export namespace GLTF {
- type BufferView =
- | Int8Array
- | Uint8Array
- | Uint16Array
- | Uint32Array
- | Float32Array
- type IndexBufferView = Uint16Array | Uint32Array | Uint8Array
- class BoundingBox {
- min: Vector3
- max: Vector3
- adoptMin: (newMin: Vector3) => void
- adoptMax: (newMax: Vector3) => void
- adopt: (newPoint: Vector3) => void
- }
- interface BoundingBoxReadOnly {
- min: Vector3ReadOnly
- max: Vector3ReadOnly
- }
- namespace BoundingBox {
- function createZero(): BoundingBox
- function createInfinite(): BoundingBox
- }
- interface VertexLayoutDesc extends Kanata.IVertexLayoutOptions {
- stride: number
- }
- interface VertexProperties {
- buffer: Float32Array
- layoutDesc: VertexLayoutDesc
- layout: Kanata.VertexLayout
- macros: object
- boundingBox: BoundingBox
- /**
- * 是否需要自行生成normal和tangent的顶点数据。
- */
- lackNormal: boolean
- lackTangent: boolean
- /**
- * 如果需要生成的话,生成在layoutDesc的哪个attribute里。
- */
- normalSlot: number
- tangentSlot: number
- }
- interface Transform extends ITransformData {
- /**
- * 同时有quat和rotation的情况下,quat优先;
- * 目前只会填写quat,不会填写rotation。
- */
- quat?: Quaternion
- }
- }
- }
- declare module 'XrFrame/kanata/lib/backend' {
- /**
- * index.ts
- *
- * * @Date : 9/3/2020, 8:45:18 PM
- */
- export * from 'XrFrame/kanata/lib/backend/interface'
- import { IImage } from 'XrFrame/kanata/lib/backend/interface'
- import { IWorker } from 'XrFrame/kanata/lib/backend/interface/IWorker'
- export interface IBackend {
- IS_VALID: () => boolean
- GET_MAIN_CANVAS(): HTMLCanvasElement
- worker: IWorker
- Image: {
- new (): IImage
- IS(obj: any): obj is IImage
- }
- Phys3D: any
- }
- const backend: IBackend
- export default backend
- }
- declare module 'XrFrame/kanata/lib/frontend/shared/NativeObject' {
- /**
- * NativeObject.ts
- *
- * * @Date : 9/3/2020, 9:17:03 PM
- */
- import { IHandle } from 'XrFrame/kanata/lib/backend'
- export default class NativeObject {
- _bufferName: string
- _byteOffset: number
- _bufferLength: number
- id: number
- _buffer: ArrayBuffer
- _f32view: Float32Array
- _u32view: Uint32Array
- protected _handle: IHandle
- protected _init(info: IHandle): void
- protected _fastInit(info: IHandle): void
- protected _initU32View(): void
- protected _initPropertyView(
- offset: number,
- length: number
- ): Float32Array
- setRawBuffer(data: Float32Array): void
- destroy(): void
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/pool/PoolObject' {
- import Pool from 'XrFrame/kanata/lib/frontend/pool/Pool'
- export interface INativePools {
- [poolId: number]: Pool
- }
- export default class PoolObject {
- protected _nativePool: Pool
- protected _nativeId: number
- protected _poolId: number
- protected _poolIndex: number
- protected _using: boolean
- entityOffset: number
- get float32View(): Float32Array
- get uint32View(): Uint32Array
- get id(): number
- get poolId(): number
- get poolIndex(): number
- get poll(): any
- get isUsing(): boolean
- set isUsing(value: boolean)
- protected _init(nativeObjId: number, nativePools: INativePools): void
- setRawBuffer(data: Float32Array): void
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/pool/PoolManager' {
- /**
- * PoolManager.ts
- *
- * * @Date : 9/3/2020, 9:19:34 PM
- */
- import { IHandle } from 'XrFrame/kanata/lib/backend'
- import PoolObject, {
- INativePools
- } from 'XrFrame/kanata/lib/frontend/pool/PoolObject'
- export default class PoolManager {
- pools: INativePools
- constructor(
- template: ArrayBuffer,
- templateView: Float32Array,
- allocateFunc: (size: number) => IHandle,
- extendedMemSize?: number
- )
- allocateOne(): number
- dispose(obj: PoolObject): void
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/shared/PureResource' {
- /**
- * PureResource.ts
- *
- * * @Date : 9/8/2020, 9:04:32 PM
- */
- import { IHandle } from 'XrFrame/kanata/lib/backend'
- export default class PureResource {
- id: number
- __handle: IHandle
- protected get _handle(): IHandle
- protected set _handle(value: IHandle)
- destroy(): void
- }
- }
- declare module 'XrFrame/kanata/lib/backend/native/worker' {
- import {
- IHandle,
- ETextureType,
- ETextureFormat,
- IRect,
- EMeshRenderType,
- INativeMap,
- ILongIntNativeMap,
- IGlyphInfo,
- IRenderEnv,
- EDracoDecodeType,
- DracoDecoded
- } from 'XrFrame/kanata/lib/backend/interface'
- export interface INativeWorker {
- createVertexLayout(options: string): IHandle
- createVertexDataDescriptor(options: string): IHandle
- createVertexBuffer(
- buffer: ArrayBuffer | ArrayBufferView,
- layout: number
- ): IHandle
- updateVertexBuffer(
- bufferId: number,
- buffer: ArrayBuffer | ArrayBufferView,
- offset: number
- ): void
- createIndexBuffer(
- buffer: ArrayBuffer | ArrayBufferView,
- is32bits?: boolean
- ): IHandle
- updateIndexBuffer(
- bufferId: number,
- buffer: ArrayBuffer | ArrayBufferView,
- offset: number
- ): void
- createVertexData(
- layout: number,
- size: number,
- batchDesc: number
- ): IHandle
- createIndexData(size: number): IHandle
- createTexture(
- type: ETextureType,
- width: number,
- height: number,
- slice: number,
- mips: number,
- format: ETextureFormat,
- flags: number,
- buffer: Array<ArrayBuffer | ArrayBufferView>,
- offsets: Uint32Array
- ): IHandle
- createTexture(canvas: HTMLCanvasElement): IHandle
- updateTexture(
- id: number,
- level: number,
- slice: number,
- xoffset: number,
- yoffset: number,
- zoffset: number,
- width: number,
- height: number,
- buffer: ArrayBuffer | ArrayBufferView
- ): void
- updateTextureFlags(textureId: number, flags: number): void
- createShader(vs: string, fs: string): IHandle
- createUniformBlockDescriptor(descriptor: string): IHandle
- createUniformBlock(descriptor: number): IHandle
- createEffect(
- name: string,
- passCount: number,
- keyIndexMap: string,
- passes: string,
- shaders: string[],
- variants: string,
- flags: number
- ): IHandle & {
- warmUp(): void
- }
- createMaterial(macros: string): IHandle
- changeMaterialMacros(
- material: number,
- macros: string,
- reset?: boolean
- ): void
- createScalableList(
- initSize: number,
- onBackendEnlarge: () => void
- ): IHandle & {
- enlarge(size: number): void
- }
- }
- export interface INativeWorker {
- createView(view: string): IHandle
- updateViewRect(view: number, rect: IRect): void
- updateViewScissor(view: number, rect: IRect): void
- }
- export interface INativeWorker {
- createRenderPass(descriptor: string): IHandle
- }
- export interface INativeWorker {
- createNodePool(count: number, is3d: boolean): IHandle
- createNodeTree(
- length: number,
- ids: ArrayBuffer,
- buffer: ArrayBuffer,
- calculateWordMatrix: boolean,
- is3d?: boolean
- ): boolean
- }
- export namespace INativeWorker {
- interface IAnimationClipBinding extends IHandle {
- id: number
- rebind(
- buffer: ArrayBuffer,
- offset: number,
- cLength: number,
- eLength: number,
- removeAction: number,
- retainedAction: number,
- addedAction: number,
- rootEntity: number
- ): boolean
- update(
- buffer: ArrayBuffer,
- offset: number,
- cLength: number,
- eLength: number,
- removeAction: number,
- retainedAction: number,
- addedAction: number
- ): boolean
- writeDefaultValues(): void
- }
- }
- export interface INativeWorker {
- createCullingComponentPool(count: number): IHandle
- createRenderComponent(
- meshCount: number,
- uniformBlock: number,
- attachedNode: number,
- cullingId: number,
- meshRenderType: EMeshRenderType,
- macros?: string
- ): IHandle & {
- setSharedDirty(): void
- }
- changeMeshMacros(mesh: number, macros: string): void
- createAnimator(clipCount: number, nodeCount: number): IHandle
- updateAnimators(data: Uint32Array): void
- createAnimationClipBinding(
- buffer: ArrayBuffer,
- offset: number,
- cLength: number,
- eLength: number,
- useDefaultAddedNodesAction: number,
- rootEntity: number
- ): INativeWorker.IAnimationClipBinding
- createAnimatorControllerModel(layerCount: number): {
- id: number
- buffer: ArrayBuffer
- setMaskAtIndex(
- index: number,
- mask: null | ArrayBuffer,
- offset: number,
- length: number
- ): void
- update(): void
- }
- createAnimatorControllerStateModel(clipCount: number): {
- id: number
- buffer: ArrayBuffer
- }
- updateAnimatorControllers(data: Uint32Array): void
- createSkinning(boneCount: number, flag: number): IHandle
- updateSkinnings(data: Uint32Array): void
- createDynamicBones(rootNodeId: number): IHandle & {
- preUpdate(): void
- update(
- dt: number,
- rootMotionX?: number,
- rootMotionY?: number,
- rootMotionZ?: number
- ): void
- rebuild(): void
- resetRoot(rootId: number): void
- }
- }
- export interface INativeWorker {
- createRenderCamera(
- attachedNode: number,
- isUI?: boolean
- ): IHandle & {
- setSharedDirty(): void
- updateMatrices(): void
- }
- createLightCamera(): IHandle
- }
- export interface INativeWorker {
- createAnimationClipModel(buffer: ArrayBuffer): IHandle
- createBoneInverseModel(buffer: ArrayBuffer): IHandle
- }
- export interface INativeWorker {
- eventBusSM: ArrayBuffer
- dirtyNodesSM: ArrayBuffer
- uiRenderList: ArrayBuffer
- enlargeUIRenderList(): void
- refreshNodesWorldTransform(): void
- }
- export interface INativeWorker {
- loadTTFFont(buffer: ArrayBuffer, filaPath: string): string
- getGlyphInfo(name: string, charCode: number): IGlyphInfo
- }
- export interface INativeWorker {
- decodeImage(
- buffer: ArrayBuffer,
- callback: (
- data: ArrayBuffer | undefined,
- width: number,
- height: number
- ) => void,
- premultiplyAlpha: boolean
- ): void
- getRenderEnv(): IRenderEnv
- clearView(view: number): void
- cullCamera(camera: number, cullResult: number, lightMode: string): void
- drawCamera(camera: number, renderList: number, lightMode: string): void
- drawLight(
- light: number,
- camera: number,
- renderList: number,
- lightMode: string
- ): void
- submit(): void
- destroy(): void
- createWeakRef<T>(wrapper: T): {
- deref: () => T
- }
- createWeakRefSentry(): any
- createNativeUUMap(): INativeMap<number>
- createNativeSUMap(): INativeMap<string>
- createNativeULUMap(): ILongIntNativeMap
- decodeBase64(base64: string): ArrayBuffer
- decodeDraco(
- buffer: ArrayBuffer | ArrayBufferView,
- decodeType: EDracoDecodeType
- ): DracoDecoded
- setNodeName(id: number, name: string): void
- setRenderComponentName(id: number, name: string): void
- debugPrint(msg: string): void
- }
- let Phys3D: any
- export const native: {
- worker: INativeWorker
- }
- export function destroy(): void
- export function GET_MAIN_CANVAS(): HTMLCanvasElement
- export function IS_VALID(): boolean
- export { Phys3D }
- }
- declare module 'XrFrame/loader/glTF/animations/channels/GLTFChannelsNode' {
- import { GLTFArrayNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFNodesLoaded } from 'XrFrame/loader/glTF/scenes/GLTFNodesNode'
- import { GLTFSamplersLoaded } from 'XrFrame/loader/glTF/animations/samplers/GLTFSamplersNode'
- import GLTFChannelNode, {
- GLTFChannelLoaded,
- GLTFChannelNodeRaw
- } from 'XrFrame/loader/glTF/animations/channels/GLTFChannelNode'
- type ChildNode = GLTFChannelNode
- export type GLTFChannelsNodeRaw = GLTFChannelsNodeRaw[]
- export type GLTFChannelsLoaded = GLTFChannelLoaded[]
- export default class GLTFChannelsNode extends GLTFArrayNode<ChildNode> {
- ChildCtor(childRaw: GLTFChannelNodeRaw): GLTFChannelNode
- readonly raw: GLTFChannelsNodeRaw
- get nodeName(): string
- preload: (
- prerequisites: [
- nodes: GLTFNodesLoaded,
- samplers: GLTFSamplersLoaded
- ]
- ) => Promise<GLTFChannelsLoaded>
- getLoadedResource(): GLTFChannelsLoaded
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/animations/samplers/GLTFSamplersNode' {
- import { GLTFAccessorsLoaded } from 'XrFrame/loader/glTF/buffers/GLTFAccessorsNode'
- import { GLTFArrayNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import GLTFSamplerNode, {
- GLTFSamplerLoaded,
- GLTFSamplerNodeRaw
- } from 'XrFrame/loader/glTF/animations/samplers/GLTFSamplerNode'
- type ChildNode = GLTFSamplerNode
- export type GLTFSamplersNodeRaw = GLTFSamplersNodeRaw[]
- export type GLTFSamplersLoaded = GLTFSamplerLoaded[]
- export default class GLTFSamplersNode extends GLTFArrayNode<ChildNode> {
- ChildCtor(childRaw: GLTFSamplerNodeRaw): GLTFSamplerNode
- readonly raw: GLTFSamplersNodeRaw
- get nodeName(): string
- preload: (
- prerequisites: [accessors: GLTFAccessorsLoaded]
- ) => Promise<GLTFSamplersLoaded>
- getLoadedResource(): GLTFSamplersLoaded
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/geometry/primitives/GLTFPrimitivesNode' {
- import { Kanata } from 'XrFrame/ext'
- import { GLTFAccessorsLoaded } from 'XrFrame/loader/glTF/buffers/GLTFAccessorsNode'
- import { GLTFArrayNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFMaterialsLoaded } from 'XrFrame/loader/glTF/materials/GLTFMaterialsNode'
- import GLTFPrimitiveNode, {
- GLTFPrimitiveLoaded,
- GLTFPrimitiveNodeRaw
- } from 'XrFrame/loader/glTF/geometry/primitives/GLTFPrimitiveNode'
- type ChildNode = GLTFPrimitiveNode
- export type GLTFPrimitivesNodeRaw = GLTFPrimitivesNodeRaw[]
- export type GLTFPrimitivesLoaded = GLTFPrimitiveLoaded[]
- export default class GLTFPrimitivesNode extends GLTFArrayNode<ChildNode> {
- ChildCtor(childRaw: GLTFPrimitiveNodeRaw): GLTFPrimitiveNode
- readonly raw: GLTFPrimitivesNodeRaw
- get nodeName(): string
- preload: (
- prerequisites: [
- materials: GLTFMaterialsLoaded,
- accessors: GLTFAccessorsLoaded,
- vbMap: Map<string, [ArrayBuffer, Kanata.VertexLayout, object]>
- ]
- ) => Promise<GLTFPrimitivesLoaded>
- getLoadedResource(): GLTFPrimitivesLoaded
- }
- export {}
- }
- declare module 'XrFrame/loader/glTF/materials/texture/GLTFTextureInfoNode' {
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import GLTFTextureTransformInfo from 'XrFrame/loader/glTF/materials/texture/GLTFTextureTransformInfo'
- export interface GLTFTextureInfoNodeRaw {
- index: number
- texCoord?: number
- extras?: any
- extensions?: any
- }
- export interface GLTFTextureInfoLoaded {
- index: number
- texCoord: number
- extras?: any
- transformInfo?: GLTFTextureTransformInfo
- }
- export default class GLTFTextureInfoNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFTextureInfoNodeRaw
- build(): void
- preload(): Promise<GLTFTextureInfoLoaded>
- getLoadedResource(): GLTFTextureInfoLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/materials/pbr/GLTFPBRMetallicRoughnessNode' {
- import { Kanata } from 'XrFrame/ext'
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFTexturesLoaded } from 'XrFrame/loader/glTF/textures/GLTFTexturesNode'
- import { GLTFTextureInfoNodeRaw } from 'XrFrame/loader/glTF/materials/texture/GLTFTextureInfoNode'
- export interface GLTFPBRMetallicRoughnessNodeRaw {
- baseColorFactor?: [number, number, number, number]
- baseColorTexture?: GLTFTextureInfoNodeRaw
- metallicFactor?: number
- roughnessFactor?: number
- metallicRoughnessTexture?: GLTFTextureInfoNodeRaw
- extras?: any
- }
- export interface GLTFPBRMetallicRoughnessLoaded {
- uniform: {
- [key: string]: ArrayLike<number> | number | Kanata.Texture
- }
- renderStates: object
- macros: {
- [key: string]: boolean | number
- }
- extras?: any
- }
- export default class GLTFPBRMetallicRoughnessNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFPBRMetallicRoughnessNodeRaw
- build(): void
- preload(
- prerequisites: [textrues: GLTFTexturesLoaded]
- ): Promise<GLTFPBRMetallicRoughnessLoaded>
- getLoadedResource(): GLTFPBRMetallicRoughnessLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/materials/texture/GLTFNormalTextureInfoNode' {
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import GLTFTextureTransformInfo from 'XrFrame/loader/glTF/materials/texture/GLTFTextureTransformInfo'
- export interface GLTFNormalTextureInfoNodeRaw {
- index: number
- texCoord?: number
- scale?: number
- extras?: any
- extensions?: any
- }
- export interface GLTFNormalTextureInfoLoaded {
- index: number
- texCoord: number
- scale: number
- extras?: any
- transformInfo?: GLTFTextureTransformInfo
- }
- export default class GLTFNormalTextureInfoNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFNormalTextureInfoNodeRaw
- build(): void
- preload(): Promise<GLTFNormalTextureInfoLoaded>
- getLoadedResource(): GLTFNormalTextureInfoLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/materials/texture/GLTFOcclusionTextureInfoNode' {
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import GLTFTextureTransformInfo from 'XrFrame/loader/glTF/materials/texture/GLTFTextureTransformInfo'
- export interface GLTFOcclusionTextureInfoNodeRaw {
- index: number
- texCoord?: number
- strength?: number
- extras?: any
- extensions?: any
- }
- export interface GLTFOcclusionTextureInfoLoaded {
- index: number
- texCoord: number
- strength: number
- extras?: any
- transformInfo?: GLTFTextureTransformInfo
- }
- export default class GLTFOcclusionTextureInfoNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFOcclusionTextureInfoNodeRaw
- build(): void
- preload(): Promise<GLTFOcclusionTextureInfoLoaded>
- getLoadedResource(): GLTFOcclusionTextureInfoLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/geometry/primitives/targets/GLTFTargetsNode' {
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- export type GLTFTargetsNodeRaw = Array<{
- [targetAttribName: string]: number
- }>
- export interface GLTFTargetsLoaded {
- attributes: {
- [targetAttribName: string]: number
- }
- }
- export const validMorphAttribs: string[]
- export default class GLTFTargetsNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFTargetsNodeRaw
- build(): void
- preload(): Promise<GLTFTargetsLoaded>
- getLoadedResource(): GLTFTargetsLoaded
- }
- }
- declare module 'XrFrame/kanata/lib/backend/interface/IWorker' {
- /**
- * IWorker.ts
- *
- * * @Date : 12/3/2020, 4:45:58 PM
- */
- import {
- IHandle,
- ETextureType,
- ETextureFormat,
- IRect,
- EMeshRenderType,
- INativeMap,
- ILongIntNativeMap,
- IGlyphInfo,
- IVertexLayoutOptions,
- IView,
- IRenderPassDescriptor,
- IEventBridge,
- IDownloader,
- IUniformDescriptorOptions,
- IFontSetting,
- TTextureSource,
- IImage,
- IVertexDataDescriptorOptions,
- IRenderEnv,
- IEngineSettings,
- EDracoDecodeType,
- DracoDecoded
- } from 'XrFrame/kanata/lib/backend/interface'
- global {
- const MAIN_CANVAS: HTMLCanvasElement
- const ENGINE_SETTINGS: IEngineSettings
- const ENGINE_MODE: 'Game' | 'Editor'
- const IS_SUB_CONTEXT: boolean
- const HOST: string
- }
- export interface IWorker {
- createVertexLayout(options: IVertexLayoutOptions): IHandle
- createVertexDataDescriptor(
- options: IVertexDataDescriptorOptions
- ): IHandle
- createVertexBuffer(
- buffer: ArrayBuffer | ArrayBufferView,
- layout: IHandle
- ): IHandle
- updateVertexBuffer(
- bufferHandle: IHandle,
- buffer: ArrayBuffer | ArrayBufferView,
- offset: number
- ): void
- createIndexBuffer(
- buffer: ArrayBuffer | ArrayBufferView,
- is32bits?: boolean
- ): IHandle
- updateIndexBuffer(
- bufferHandle: IHandle,
- buffer: ArrayBuffer | ArrayBufferView,
- offset: number
- ): void
- createVertexData(
- layout: IHandle,
- size: number,
- batchDesc: IHandle
- ): IHandle
- createIndexData(size: number): IHandle
- createTexture(
- type: ETextureType,
- width: number,
- height: number,
- slice: number,
- mips: number,
- format: ETextureFormat,
- flags: number,
- source: TTextureSource[],
- offsets: Uint32Array
- ): IHandle
- createAutoUpdateTextureFromCanvas(canvas: HTMLCanvasElement): IHandle
- updateTexture(
- handle: IHandle,
- level: number,
- slice: number,
- xoffset: number,
- yoffset: number,
- zoffset: number,
- width: number,
- height: number,
- buffer:
- | ArrayBuffer
- | ArrayBufferView
- | IImage
- | HTMLCanvasElement
- | ImageData
- ): void
- updateTextureFlags(texture: IHandle, flags: number): void
- createUniformBlockDescriptor(
- descriptor: IUniformDescriptorOptions
- ): IHandle
- createUniformBlock(descriptor: IHandle): IHandle
- createEffect(
- name: string,
- passCount: number,
- keyIndexMap: string[],
- passes: Array<{
- lightMode: string
- variants?: {
- [key: number]: number
- }
- macros?: {
- [key: string]: number
- }
- shaders?: number[]
- }>,
- shaders: string[],
- variants: number[][],
- useRuntimeMacros: boolean
- ): IHandle & {
- warmUp(): void
- }
- createMaterial(
- macros?: {
- [name: string]: string | number | boolean
- },
- uniformBlock?: IHandle
- ): IHandle
- changeMaterialMacros(
- material: IHandle,
- macros: {
- [name: string]: string | number | boolean
- },
- reset?: boolean
- ): void
- }
- export interface IWorker {
- createView(view: IView): IHandle
- updateViewRect(view: IHandle, rect: IRect): void
- updateViewScissor(view: IHandle, rect: IRect): void
- }
- export interface IWorker {
- createRenderPass(descriptor: IRenderPassDescriptor): IHandle
- }
- export interface IWorker {
- createNodePool(count: number, is3d: boolean): IHandle
- createNodeTree(
- length: number,
- ids: ArrayBuffer,
- buffer: ArrayBuffer,
- calculateWordMatrix: boolean,
- is3d: boolean
- ): boolean
- }
- export interface IWorker {
- createCullingComponentPool(count: number): IHandle
- createRenderComponent(
- meshCount: number,
- uniformBlock: IHandle,
- attachedNodeId: number,
- cullingCompId: number,
- meshRenderType: EMeshRenderType,
- macros?: {
- [name: string]: string | number | boolean
- }
- ): IHandle & {
- setSharedDirty(): void
- }
- changeMeshMacros(
- mesh: IHandle,
- macros: {
- [name: string]: string | number | boolean
- },
- reset?: boolean
- ): void
- createAnimator(clipCount: number, nodeCount: number): IHandle
- updateAnimators(
- feObjects: Array<{
- __handle: IHandle
- id: number
- }>,
- size: number
- ): void
- createAnimationClipBinding(
- clipArray: Array<{
- __handle: IHandle
- id: number
- }>,
- clipArrayOffset: number,
- clipArrayLength: number,
- entityArray: Array<
- | number
- | {
- id: number
- }
- | null
- >,
- entityArrayOffset: number,
- entityArrayLength: number,
- useDefaultAddedNodesAction: number,
- rootEntity: {
- id: number
- }
- ): IHandle
- rebindAnimationClipBinding(
- binding: IHandle,
- clipArray: Array<{
- __handle: IHandle
- id: number
- }>,
- clipArrayOffset: number,
- clipArrayLength: number,
- entityArray: Array<
- | number
- | {
- id: number
- }
- | null
- >,
- entityArrayOffset: number,
- entityArrayLength: number,
- removeAction: number,
- retainedAction: number,
- addedAction: number,
- rootEntity: {
- id: number
- }
- ): boolean
- updateAnimationClipBinding(
- binding: IHandle,
- clipArray: Array<{
- __handle: IHandle
- id: number
- }>,
- clipArrayOffset: number,
- clipArrayLength: number,
- entityArray: Array<
- | number
- | {
- id: number
- }
- | null
- >,
- entityArrayOffset: number,
- entityArrayLength: number,
- removeAction: number,
- retainedAction: number,
- addedAction: number
- ): boolean
- writeAnimationClipBindingDefaultValues(binding: IHandle): void
- createAnimatorControllerModel(layerCount: number): IHandle
- setAnimatorControllerModelMaskAtIndex(
- model: IHandle,
- index: number,
- mask: {
- buffer: null | ArrayBuffer
- offset: number
- length: number
- }
- ): void
- updateAnimatorControllerModel(model: IHandle): void
- createAnimatorControllerStateModel(clipCount: number): IHandle
- updateAnimatorControllers( // for performance
- feObjects: Array<{
- __handle: IHandle
- id: number
- }>,
- size: number
- ): void
- createSkinning(boneCount: number, flag: number): IHandle
- updateSkinnings(
- feObjects: Array<{
- __handle: IHandle
- id: number
- }>,
- size: number
- ): void
- createDynamicBones(rootNodeId: number): IHandle & {
- preUpdate(): void
- update(
- dt: number,
- rootMotionX?: number,
- rootMotionY?: number,
- rootMotionZ?: number
- ): void
- rebuild(): void
- resetRoot(rootId: number): void
- }
- }
- export interface IWorker {
- createRenderCamera(
- attachedNodeId: number,
- isUI?: boolean
- ): IHandle & {
- setSharedDirty(): void
- updateMatrices(): void
- }
- createLightCamera(): IHandle
- }
- export interface IWorker {
- createAnimationClipModel(buffer: ArrayBuffer): IHandle
- createBoneInverseModel(buffer: ArrayBuffer): IHandle
- createScalableList(
- initSize: number,
- onBackendEnlarge?: () => void
- ): IHandle & {
- enlarge(size: number): void
- }
- }
- export interface IWorker {
- eventBridge: IEventBridge
- }
- export interface IWorker {
- loadTTFFont(url: string, callback: (font: string) => void): void
- getGlyphInfo(fontSetting: IFontSetting, charCode: number): IGlyphInfo
- }
- export interface IWorker {
- setGlobalPhysicSystem(system: any): void
- bindRigidBodyToNode(rigidBody: any, nodeId: number): void
- unbindRigidBody(rigidBody: any): void
- bindCCTToNode(cc: any, nodeId: number): void
- unbindCCT(cc: any): void
- }
- export interface IWorker {
- downloader: IDownloader
- update(delta: number): void
- destroy(): void
- refreshNodesWorldTransform(): void
- getRenderEnv(): IRenderEnv
- clearView(view: IHandle): void
- cullCamera(
- camera: IHandle,
- cullResult: IHandle,
- lightMode: string
- ): void
- drawCamera(
- camera: IHandle,
- renderList: IHandle,
- lightMode: string
- ): void
- drawLight(
- light: IHandle,
- camera: IHandle,
- renderList: IHandle,
- lightMode: string
- ): void
- submit(): void
- createWeakRef<T>(wrapper: T): {
- deref: () => T
- }
- createWeakRefSentry(): any
- createNativeUUMap(): INativeMap<number>
- createNativeSUMap(): INativeMap<string>
- createNativeULUMap(): ILongIntNativeMap
- decodeBase64(base64: string): ArrayBuffer
- initDraco?(): Promise<void>
- decodeDraco(
- buffer: ArrayBuffer | ArrayBufferView,
- decodeType: EDracoDecodeType
- ): DracoDecoded
- setNodeName(id: number, name: string): void
- setRenderComponentName(handle: IHandle, name: string): void
- debugPrint(msg: string): void
- }
- }
- declare module 'XrFrame/kanata/lib/frontend/pool/Pool' {
- import { IHandle } from 'XrFrame/kanata/lib/backend'
- import NativeObject from 'XrFrame/kanata/lib/frontend/shared/NativeObject'
- export default class Pool extends NativeObject {
- u32viewExt: Uint32Array
- constructor(nativeObj: IHandle)
- supplyExtendedMemory(buffer: ArrayBuffer): void
- }
- }
- declare module 'XrFrame/loader/glTF/animations/channels/GLTFChannelNode' {
- import { StreamReader } from 'XrFrame/core/utils'
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- import { GLTFNodesLoaded } from 'XrFrame/loader/glTF/scenes/GLTFNodesNode'
- import { GLTF } from 'XrFrame/loader/glTF/utils/types'
- import { GLTFSamplerLoaded } from 'XrFrame/loader/glTF/animations/samplers/GLTFSamplerNode'
- import { GLTFSamplersLoaded } from 'XrFrame/loader/glTF/animations/samplers/GLTFSamplersNode'
- import {
- GLTFTargetLoaded,
- GLTFTargetNodeRaw
- } from 'XrFrame/loader/glTF/animations/channels/GLTFTargetNode'
- export enum EnumPuppetAnimationSampleGroupType {
- tx = 1,
- ty = 2,
- tz = 3,
- sx = 4,
- sy = 5,
- sz = 6,
- qx = 7,
- qy = 8,
- qz = 9,
- qw = 10,
- ex = 11,
- ey = 12,
- ez = 13
- }
- /**
- * 二进制格式, byteLength = 12 + 16 * samples.len
- * | Array<| nodeid | type | count |> |
- * | Array<PuppetAnimationClipSample> |
- */
- export type PuppetAnimationSampleGroup = ArrayBuffer | GLTF.BufferView
- /**
- * 二进制格式, byteLength = 16
- * uint32_t index;
- * float value;
- * float in_tangent;
- * float out_tangent;
- *
- * @remind out_tangent的值决定了插值的类型!很hack!
- * out_tangent = Infinity: STEP
- * out_tangent = NaN: Spherical Linear Interpolation (for quaternion)
- * out_tangent为正常值: Cubic Spline Interpolation (or Linear)
- */
- export type PuppetAnimationClipSample = ArrayBuffer | GLTF.BufferView
- export interface GLTFChannelNodeRaw {
- sampler: number
- target: GLTFTargetNodeRaw
- extras?: any
- }
- export interface GLTFChannelLoaded {
- sampler: GLTFSamplerLoaded
- target: GLTFTargetLoaded
- vectorGroups: number
- headerBytesNeeded: number
- bodyBytesNeeded: number
- serializeHeaderOnBuffer(
- stream: StreamReader,
- channelIndex: number
- ): void
- serializeBodyOnBuffer(stream: StreamReader): number
- extraMorphNodeCount: number
- extras?: any
- }
- export default class GLTFChannelNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFChannelNodeRaw
- build(): void
- preload(
- prerequisites: [
- nodes: GLTFNodesLoaded,
- samplers: GLTFSamplersLoaded
- ]
- ): Promise<GLTFChannelLoaded>
- getLoadedResource(): GLTFChannelLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/animations/samplers/GLTFSamplerNode' {
- import { GLTFAccessorLoaded } from 'XrFrame/loader/glTF/buffers/GLTFAccessorNode'
- import { GLTFAccessorsLoaded } from 'XrFrame/loader/glTF/buffers/GLTFAccessorsNode'
- import { GLTFBaseNode } from 'XrFrame/loader/glTF/GLTFBaseNode'
- export enum EnumGLTFSamplerInterpolation {
- STEP = 0,
- LINEAR = 1,
- CUBICSPLINE = 2
- }
- export interface GLTFSamplerNodeRaw {
- input: number
- output: number
- interpolation?: 'STEP' | 'LINEAR' | 'CUBICSPLINE'
- extras?: any
- }
- export interface GLTFSamplerLoaded {
- input: GLTFAccessorLoaded
- output: GLTFAccessorLoaded
- interpolation: EnumGLTFSamplerInterpolation
- sampleCount: number
- extras?: any
- }
- export default class GLTFSamplerNode extends GLTFBaseNode {
- get nodeName(): string
- readonly raw: GLTFSamplerNodeRaw
- build(): void
- preload(
- prerequisites: [accessors: GLTFAccessorsLoaded]
- ): Promise<GLTFSamplerLoaded>
- getLoadedResource(): GLTFSamplerLoaded
- }
- }
- declare module 'XrFrame/loader/glTF/materials/texture/GLTFTextureTransformInfo' {
- import Vector2 from 'XrFrame/math/vector2'
- export interface ITransformInfo {
- offset?: number[]
- rotation?: number
- scale?: number[]
- }
- export default class GLTFTextureTransformInfo {
- offset: Vector2
- rotation: number
- scale: Vector2
- get uvMatrixArray(): number[]
- constructor(textureTransform: ITransformInfo)
- /**
- * 设置UV变化矩阵,列主序
- *
- * @param {number} tx x轴偏移
- * @param {number} ty y轴偏移
- * @param {number} sx x轴缩放
- * @param {number} sy y轴缩放
- * @param {number} rotation 旋转
- */
- setUvTransform(
- tx: number,
- ty: number,
- sx: number,
- sy: number,
- rotation: number
- ): void
- /**
- * 更新UV矩阵
- *
- * @memberof GLTFTextureTransformInfo
- */
- updateUVMatrixArray(): void
- }
- }
- declare module 'XrFrame/core/utils' {
- export function assert(pred: boolean, msg: string): void
- export function decode(data: ArrayBuffer, format: 'utf-8' | 'gbk'): string
- export function wxPromiseWrapper<T = any>(
- executor: any,
- args: any
- ): Promise<T>
- export class StreamReader {
- constructor(buffer: ArrayBuffer, byteOffset?: number)
- get size(): number
- read<T>(type: StreamReader.Type): T
- write<T>(type: StreamReader.Type, value: T): void
- /**
- * 跳过一个位置,以后再填写。
- */
- reserve<T>(type: StreamReader.Type): {
- write(value: T): void
- }
- readChunk(length: number): ArrayBuffer
- align(alignment: number): void
- end(): boolean
- pos(): number
- }
- export namespace StreamReader {
- enum Type {
- Float = 0,
- UInt32 = 1,
- UInt16 = 2
- }
- const TypeAlignment: {
- 0: number
- 1: number
- 2: number
- }
- const TypeSize: {
- 0: number
- 1: number
- 2: number
- }
- }
- }
|